Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
bmachek committed Sep 2, 2024
1 parent 86cc333 commit 409574d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# lrc-immich-plugin

A Lightroom Classic plugin created with Lightroom SDK which uploads images to an Immich Server via the Immich API.
It supports exporting as well as publishing.

## Support my work

Expand All @@ -18,42 +19,45 @@ Windows

Alternatively extract it somewhere good an go to Lightroom Module Manager and add it via the GUI.

Either there should be a plugin called "Immich plugin" in the list, one you're finished.
Either there should be a plugin called "Immich" in the list, one you're finished.

## Features

* Setup connection to your Immich instance via URL and API key.
* Optionally choose or create an album to use on export to Immich.
* Export/Upload images to Immich.
* Reupload of an existing image lead to replacing the image in Immich.
* Setup connection to your Immich instance via URL and API key in the Lightroom module manager

## Usage
* Publish images:
* Create/rename/delete album according to published collection.
* Upload/update/delete images from the published collection.
* Download comments and likes from Immich to Lightroom. (If album is a shared album.)

* Export images:
* Optionally choose or create an album to use on export to Immich.
* Replace existing images.
* Duplicate detection via Lightroom catalog ID, and based on date and filename.

After you successfully installed the plugin, you can create an export preset in Lightroom.
* Upcoming features:
* Set Immich album title image from Lightroom in Published collection.
* Let user decide/configure if "unpublished" images should be deleted.
* (Maybe) Additional album options like sharing in the Published Collection settings dialog.
* (Maybe) [Your feature](https://github.com/bmachek/lrc-immich-plugin/discussions/16)

![Screenshot](screenshots/export-preset.png "Screenshot")
## Usage

Basically you have to set three parameters:
After you successfully installed the plugin, enter the server url and [API key](https://immich.app/docs/features/command-line-interface#obtain-the-api-key) in the Lightroom module manager.
Create Immich export preset (Choose Export to: Immich Exporter) or set up Immich publish service.

* Set Export To: Immich Server (in the dropdown at the top)
* Enter the immich http URL where the web frontend is reachable.
* Enter an API key for your Immich account. ([This has to be setup in Immich.](https://immich.app/docs/features/command-line-interface#obtain-the-api-key))
* Optionally choose to create an album, choose an exisiting album, choose on export, or do not use any albums on upload.
Configuration and usage should be pretty straight forward, if you know Lightroom. If not, let me know. ;-)

Once you're done entering the details, edit the usual Lightroom export parameters to your need, and save the preset.

## CREDITS

All contributors.

[Jeffrey Friedl for JSON.lua](http://regex.info/blog/lua/json)

[Enrique García Cota for inspect.lua](https://github.com/kikito/inspect.lua)

[Min Idzelis for giving me ideas with his Immich Plugin](https://github.com/midzelis/mi.Immich.Publisher)


## FINISHED

You should be able to export images directly to your Immich server.
If not open an issue, please.


Binary file removed screenshots/export-preset.png
Binary file not shown.

0 comments on commit 409574d

Please sign in to comment.