Skip to content

Commit 940d60a

Browse files
committed
README
Added Locked Folder considerations
1 parent 0e9cf1d commit 940d60a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -792,6 +792,20 @@ By combining `--find-archived-assets`/`FIND_ARCHIVED_ASSETS=true` with `--visibi
792792
>[!WARNING]
793793
>If the script is used to delete albums using `--mode=CLEANUP` or `--mode=DELETE_ALL` with the `--archive` option set, the script will not respect [album-fine properties](#setting-album-fine-properties) for visibility but only the global option passed when running it in that mode! That way you can decide what visibility to set for assets after their albums have been deleted.
794794

795+
### Locked Folder Considerations
796+
When setting `--visibility`/`VISIBILITY` to `locked`, the script will move all discovered assets to the Locked Folder, removing them from any albums they might already be part of. The affected assets are determined by the following options/environment variables:
797+
- `--find-archived-assets`/`FIND_ARCHIVED_ASSETS`
798+
- `--find-assets-in-albums`/`FIND_ASSETS_IN_ALBUMS`
799+
- `--ignore`/`IGNORE`
800+
- `--path-filter`/`PATH_FILTER`
801+
802+
> [!CAUTION]
803+
> When running with `--find-assets-in-albums`/`FIND_ASSETS_IN_ALBUMS` and `--visibility`/`VISIBILITY` set to `locked`, the script will move all assets for matching albums to the locked folder, leaving empty albums behind.
804+
When also running with `--sync-mode`/`SYNC_MODE` set to `1` or `2`, those empty albums will be deleted after that as well!
805+
806+
Removing assets from the locked folder and making it available to the script again must be done using the Immich User Interface.
807+
808+
795809
## Dealing with External Library Changes
796810

797811
Due to their nature, external libraries may be changed by the user without Immich having any say in it.

0 commit comments

Comments
 (0)