v0.18.2

What's Changed

• Enhance regex album name post processing
  • Support equal signs in --album-name-post-regex
  • Use python regex module which allows more features like e.g. infinite width lookbehind patterns
    Thanks @DSchmidtDev

Upgrade Notice

If you are using the bare python script, make sure to reinstall requirements.txt, as a new dependency was introduced:
regex==2024.11.6

New Contributors

• @DSchmidtDev made their first contribution in #121

Full Changelog: 0.18.1...0.18.2

v0.18.1

Hotfix Release

Fixes

• TypeError occurred of new option --album-name-post-regex was not set

Full Changelog: 0.18.0...0.18.1

v0.18.0

Features

• Docker: Added new env RUN_IMMEDIATELY
  New Docker environment variable to immediately perform a first run after container startup instead of waiting for the cronjob to fire.
  Thanks @copart
• Album Name Regex
  Post-process album names with chained search/replace operations using regular expressions.
  Refer to README section Album Name Regex for details.
  Thanks @Bierchermuesli

New Contributors

• @copart made their first contribution in #111
• @Bierchermuesli made their first contribution in #110

Full Changelog: 0.17.2...0.18.0

v0.17.2

Fixes

• Fix: Regression: Fixed --share-with name=role syntax
  The possibility to assign user-specific share roles in --share-with / SHARE_WITH broke with v0.16.0. It has now been restored.

Documentation

• Fix typos
  Thanks @david-askari

New Contributors

• @david-askari made their first contribution in #107

Full Changelog: 0.17.1...0.17.2

v0.17.1

Hotfix Release

• Fix: Restored --comments-and-likes-disabled that got accidentally removed in 0.17.0

Full Changelog: 0.17.0...0.17.1

v0.17.0

Enhancements

• Prevent automatic removal of unknown shared users
  With v0.16.0 the default behavior for updating album properties and shared state was changed so that they were updated any time new assets were added to albums, leading to manually shared albums getting unshared by the script.
  The old behavior has been restored, so that album sharing and any other album properties are only set when a new album is created.
  To still get the benefit of mass updating album properties and shared state after the fact, a new option --update-album-props-mode / env variable UPDATE_ALBUM_PROPS_MODE has been introduced. Read about it in README section Mass Updating Album Properties.
  Thanks @Toastie
• Update README.md - Docker compose: volume mount correction and additional info in #92
  Thanks at @archont00

New Contributors

• @archont00 made their first contribution in #92
• @Toastie made their first contribution in #98

Full Changelog: 0.16.0...0.17.0

v0.16.0

Features

• Abum-Fine Properties
  It is now possible to place an .albumprops file in external library folders to define album properties specific to the album created from that folder. Refer to README section Setting Album-Fine Properties.

Enhancements

• chore: Add pylint
  Added linting the code to ensure code quality
• New Argument: API Timeout
  Introduced new argument --api-timeout / Docker env variable API_TIMEOUT to override the Immich API request timeout
• New Arguments: Enable/Disbale Comments and Likes
  Introduced new arguments --comments-and-likes-disabled and --comments-and-likes-enabled / Docker env variable COMMENTS_AND_LIKES (with values 0 or 1) to enable or disable album comments and likes functionality

Fixes

• Bug Fix: Verify album levels range check incorrect
  Thanks @rock-meister !

New Contributors

• @rock-meister made their first contribution in #81

Full Changelog: 0.15.0...0.16.0

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