v0.15.0

Features

• Support file-based API key secrets
  The Immich API key may now be passed to the script in a secrets file instead of a command line argument.
  Add -t file to your command line and replace the API key with the absolute path to your secrets file containing the API key.
  For Docker, mount the secrets file into the container and set environment variable API_KEY_FILE to the absolute path to the secrets file within the container. Do not set the API_KEY environment variable.
  Thanks @johnspade!

New Contributors

• @johnspade made their first contribution in #74

Full Changelog: 0.14.0...0.15.0

v0.14.0

Important

If you just updated to Immich v1.118.0 and you are using the script within your Immich docker-compose stack, with ROOT_URL referencing the immich-server service directly, you must update the port in ROOT_URL from 3001 to 2283:

  immich-folder-album-creator:
    container_name: immich_folder_album_creator
    image: salvoxia/immich-folder-album-creator:latest
    restart: unless-stopped
    environment:
-      API_URL: http://immich_server:3001/api
+      API_URL: http://immich_server:2283/api

Fixes

• #71 fix broken api after upgrade to 1.118 in #72
  Restores compatibility with Immich v1.118.0
  Thanks @Felix-Franz
• Fix: Find Assets in Archive in #73
  Fixed Regression introduced with v0.13.0: Assets in archive were no longer found even if --find-assets-in-archive flag / FIND_ASSETS_IN_ARCHIVE env variable was set or --mode was anything but CREATE.

New Contributors

• @Felix-Franz made their first contribution in #72

Full Changelog: 0.13.0...0.14.0

v0.13.0

Important

Important changes to Offline Asset Removal revolving around Dealing with External Library Changes!

With Immich v1.116.0, the way offline assets are handled was changed. Previously, a job for removing offline assets from a specific external library could be started by an Administrator. Now, offline assets are merely displayed in the Trash instead of the main timeline. They are removed by emptying the Trash.
The script was updated to handle this new behavior, which comes with a simplification and more convenient Sync Mode behavior.

It is no longer necessary to use an Administrator's API Key to trigger Offline Asset Removal!
Nor is it necessary to run a second container to periodically trigger Offline Asset Removal. If you used a second container in your docker-compose stack or a separate cronjob, these can be deleted. This no longer works as it used to!
It is now possible to simply set Sync Mode to 2 in order to first remove all offline assets, then delete all empty albums.
For details, refer to the README section Dealing with External Library Changes.

What's Changed

• Fix/offline asset removal since Immich v1.116.0 in #66

Full Changelog: 0.12.0...0.13.0

v0.12.0

⚠️Potentially Breaking Changes⚠️

Only affects users of the bare Python script!

• The --ignore option no longer accepts a colon : separated string. If you want to specify multiple keywords to ignore, pass --ignore multiple times, once for each keyword or glob pattern!

Features

• Automatic Archiving
  In Immich, "archiving" assets is used to hide/remove them from the main timeline. A new option has been introduced to automatically "archive" assets that were added to an album during the run. Refer to Automatic Archiving in the README.
  Thanks to @plaubi

Enhancements

• Multiple Path Filters
  The script now supports multiple path filters. --path-filter can be passed multiple times to the script. On Docker, pass a colon ´:´ separated string in environment variable PATH_FILTER.
  The --ignore option now also supports glob-style patterns.
  Refer to the updated section about Filtering in the README.
• API Error Logging
  Added a common function for verifying API responses and logging errors and the payload (if any)

Fixes

• Preview in CLEANUP Mode with Filtering
  When the script was run with --mode set to CLEANUP while also specifying filters with --path-filter or --ignore, the preview of albums that would be deleted did not take the filters into account and listed all albums in Immich. However, the deletion routine honored the filters even before this version!

Full Changelog: 0.11.1...0.12.0

v0.11.1

Fixes

• Compose Version Doesnt Work//Multi-Path Handling Bug
  Fixed handling of multiple root paths after introduction of the Path Filtering Feature in v0.11.0.
  Thanks to @Renderer6060

What's Changed

• Multiple Root Path Handling by in #54

Full Changelog: 0.11.0...0.11.1

v0.11.0

Features

• Set Album Thumbnail
  Added option to set the thumbnail for albums to first, last or a random image
  Refer to Setting Album Thumbnails in README.
  Thanks @jdckr

Enhancements

• Server Version Check now can correctly distinguish between too old Immich versions and plain communication errors

New Contributors

• @jdckr made their first contribution in #48

Full Changelog: 0.10.0...0.11.0

v0.10.0

Features

• Find Assets in Album (#41)
  Added an option to make the script request all assets from Immich, even the ones that already are part of an album. That way, the script can be used with different settings in multiple runs.
  Refer to Assets in Multiple Albums in README.
  Thanks @carlosjfcasero
• Path Filter
  Added option to filter assets using a glob-style pattern and only create albums for the filtered assets.
  Refer to Filtering in README

Fixes

• Fix configuration typo by @kvalev

New Contributors

• @kvalev made their first contribution in #40

Full Changelog: 0.9.0...0.10.0

v0.9.0

⚠️Potentially Breaking Changes⚠️

• To keep maintenance and development effort in check, support for Immich versions earlier than 1.106.1 has been removed!
  Update your Immich Server or stick to script version 0.8.1 or earlier!

Enhancements

• #32 Added more user-friendly messages when running script in Docker without UNATTENDED or DELETE_CONFIRM flags set (thanks @pin147)

Features

• #33 Added triggering of Offline Assets Removal and deletion of empty albums to clean up after external library changes (thanks @wechsler42)
  Refer to new README section Dealing with External Library Changes.
• #34 Allow automatic sharing of newly created albums with a list of existing users (with share role definition by user) (thanks @janwdev)
  Refer to new README section Automatic Album Sharing.
• #36 Added option to specify sorting order in newly created albums (thanks @ferbar)

New Contributors

• @ferbar made their first contribution in #37

Full Changelog: 0.8.1...0.9.0

v0.8.1

Fixes

• #30 Root path with spaces in it are not recognized
  Docker only: Fixed an error that caused ROOT_PATH environment entries with blanks to be parsed not only at the comma but also at the blank, leading to incorrect root_path arguments being passed to the script. Thanks @kftb!

Full Changelog: 0.8.0...0.8.1

v0.8.0

Features

• #28 Add run modes for cleaning up or deleting all albums
  Allows specifying option -m or --mode (Docker: Env Variable MODE) to delete albums created by the script or to delete all albums in Immich.
  Refer to to the README for documentation on how to use.

Enhancements

• Running the script manually using the Docker image will no longer automatically create all albums, but only list the albums it would create. To actually create albums, the UNATTENDED environment variable must be set as well. This mimics the default behavior of the script when running it without Docker.

Full Changelog: 0.7.0...0.8.0