diff --git a/docs/docs/guides/external-library.md b/docs/docs/guides/external-library.md new file mode 100644 index 0000000000..30d272a428 --- /dev/null +++ b/docs/docs/guides/external-library.md @@ -0,0 +1,101 @@ +This guide walks you through adding an [External Library](../features/libraries#external-libraries). +This guide assumes you are running Immich in Docker and that the files you wish to access are stored +in a directory on the same machine. + +# Mount the directory into the containers. + +Edit `docker-compose.yml` to add two new mount points under `volumes:` + +``` + immich-server: + volumes: + - ${EXTERNAL_PATH}:/usr/src/app/external +``` + +Be sure to add exactly the same line to both `immich-server:` and `immich-microservices:`. + +[Question for the devs: Is editing docker-compose.yml really the desirable way to solve this problem? +I assumed user changes were supposed to be kept to .env?] + +Edit `.env` to define `EXTERNAL_PATH`, substituting in the correct path for your computer: + +``` +EXTERNAL_PATH= +``` + +On my computer, for example, I use this path: + +``` +EXTERNAL_PATH=/home/tenino/photos +``` + +Restart Immich. + +``` +docker compose down +docker compose up -d +``` + +# Set the External Path + +In the Immich web UI: + +- click the **Administration** link in the upper right corner. + + +- Select the **Users** tab + + +- Select the **pencil** next to your user ID + + +- Fill in the **External Path** field with `/usr/src/app/external` + + +Notice this matches the path _inside the container_ where we mounted your photos. +The purpose of the external path field is for administrators who have multiple users +on their Immich instance. It lets you prevent other authorized users from +navigating to your external library. + +# Import the library + +In the Immich web UI: + +- Click your user avatar in the upper-right corner (circle with your initials) + + +- Click **Account Settings** + + +- Click to expand **Libraries** + + +- Click the **Create External Library** button + + +- Click the three-dots menu and select **Edit Import Paths** + + +- Click \*_Add path_ + + +- Enter **.** as the path and click Add + + +- Save the new path + + +- Click the three-dots menu and select **Scan New Library Files** [I'm not sure whether this is necessary] + + +# Confirm stuff is happening + +- Click **Administration** + + +- Select the **Jobs** tab + + +- You should see non-zero Active jobs for + Library, Generate Thumbnails, and Extract Metadata. + diff --git a/docs/docs/guides/img/account-settings.png b/docs/docs/guides/img/account-settings.png new file mode 100644 index 0000000000..8cece6f467 Binary files /dev/null and b/docs/docs/guides/img/account-settings.png differ diff --git a/docs/docs/guides/img/add-path-button.png b/docs/docs/guides/img/add-path-button.png new file mode 100644 index 0000000000..ba4ef758fb Binary files /dev/null and b/docs/docs/guides/img/add-path-button.png differ diff --git a/docs/docs/guides/img/add-path-field.png b/docs/docs/guides/img/add-path-field.png new file mode 100644 index 0000000000..f78d039f7d Binary files /dev/null and b/docs/docs/guides/img/add-path-field.png differ diff --git a/docs/docs/guides/img/administration-link.png b/docs/docs/guides/img/administration-link.png new file mode 100644 index 0000000000..09cdea3429 Binary files /dev/null and b/docs/docs/guides/img/administration-link.png differ diff --git a/docs/docs/guides/img/create-external-library-button.png b/docs/docs/guides/img/create-external-library-button.png new file mode 100644 index 0000000000..66b19ef0d3 Binary files /dev/null and b/docs/docs/guides/img/create-external-library-button.png differ diff --git a/docs/docs/guides/img/edit-import-paths.png b/docs/docs/guides/img/edit-import-paths.png new file mode 100644 index 0000000000..c38419e927 Binary files /dev/null and b/docs/docs/guides/img/edit-import-paths.png differ diff --git a/docs/docs/guides/img/external-path.png b/docs/docs/guides/img/external-path.png new file mode 100644 index 0000000000..bc54f781fc Binary files /dev/null and b/docs/docs/guides/img/external-path.png differ diff --git a/docs/docs/guides/img/job-status.png b/docs/docs/guides/img/job-status.png new file mode 100644 index 0000000000..396feaef4f Binary files /dev/null and b/docs/docs/guides/img/job-status.png differ diff --git a/docs/docs/guides/img/jobs-tab.png b/docs/docs/guides/img/jobs-tab.png new file mode 100644 index 0000000000..70d2967983 Binary files /dev/null and b/docs/docs/guides/img/jobs-tab.png differ diff --git a/docs/docs/guides/img/libraries-dropdown.png b/docs/docs/guides/img/libraries-dropdown.png new file mode 100644 index 0000000000..5ccb66aa8d Binary files /dev/null and b/docs/docs/guides/img/libraries-dropdown.png differ diff --git a/docs/docs/guides/img/path-save.png b/docs/docs/guides/img/path-save.png new file mode 100644 index 0000000000..006192fd0e Binary files /dev/null and b/docs/docs/guides/img/path-save.png differ diff --git a/docs/docs/guides/img/pencil.png b/docs/docs/guides/img/pencil.png new file mode 100644 index 0000000000..d3b8f45055 Binary files /dev/null and b/docs/docs/guides/img/pencil.png differ diff --git a/docs/docs/guides/img/scan-new-library-files.png b/docs/docs/guides/img/scan-new-library-files.png new file mode 100644 index 0000000000..1ff2f75114 Binary files /dev/null and b/docs/docs/guides/img/scan-new-library-files.png differ diff --git a/docs/docs/guides/img/user-avatar.png b/docs/docs/guides/img/user-avatar.png new file mode 100644 index 0000000000..4fed1a7d2e Binary files /dev/null and b/docs/docs/guides/img/user-avatar.png differ diff --git a/docs/docs/guides/img/users-tab.png b/docs/docs/guides/img/users-tab.png new file mode 100644 index 0000000000..f634989abe Binary files /dev/null and b/docs/docs/guides/img/users-tab.png differ