diff --git a/docs/docs/features/locked-folder.md b/docs/docs/features/locked-folder.md new file mode 100644 index 000000000..7d11216c3 --- /dev/null +++ b/docs/docs/features/locked-folder.md @@ -0,0 +1,25 @@ +# Locked Folder + +The Locked Folder keeps selected photos and videos out of normal library views and protects access to them with a PIN. + +Assets can be moved to the Locked Folder from the asset actions menu. Access to the Locked Folder is protected by a PIN. + +## Unlocking the Locked Folder + +Unlocking the Locked Folder temporarily gives the current session access to locked assets. + +While the session is unlocked, locked assets may also appear elsewhere in Immich where they are relevant, such as search results or utilities such as Review large files. + +When the session is locked again, locked assets are hidden from those views. + +## Session duration + +Unlocking the Locked Folder initially grants elevated access to the current session for 15 minutes. + +If the session is still being used near the end of that period, the expiry can be extended to keep the session unlocked for a short time longer. + +Selecting **Lock** ends the elevated access immediately. Signing out also ends access because the session is destroyed. + +## Moving assets out of the Locked Folder + +Assets can be moved back out of the Locked Folder while the session is unlocked. Once moved out, they return to their normal visibility in Immich.