mirror of
https://github.com/immich-app/immich.git
synced 2026-03-16 14:39:20 -04:00
a244d94ac8
* docs: beginning of the year tune up and updates * darker dark * backup information * promote to table of content * Apply suggestions from code review Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com> Co-authored-by: Mees Frensel <33722705+meesfrensel@users.noreply.github.com> * restore and backup * edit * Apply suggestions from code review Co-authored-by: bo0tzz <git@bo0tzz.me> * feedback * more information on mobile Co-authored-by: https://github.com/aviv926 * more information on free up space > > Co-authored-by: jtagcat <git-12dbd862@jtag.cat> * Update docs/docs/features/mobile-app.mdx Co-authored-by: jtagcat <git-12dbd862@jtag.cat> * screenshot and minor tweaks --------- Co-authored-by: Mert <101130780+mertalev@users.noreply.github.com> Co-authored-by: Mees Frensel <33722705+meesfrensel@users.noreply.github.com> Co-authored-by: bo0tzz <git@bo0tzz.me> Co-authored-by: jtagcat <git-12dbd862@jtag.cat>
58 lines
2.5 KiB
Markdown
58 lines
2.5 KiB
Markdown
# External Library
|
|
|
|
This guide walks you through adding an [External Library](/features/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 one or more new mount points in the section `immich-server:` under `volumes:`.
|
|
If you want Immich to be able to delete the images in the external library or add metadata ([XMP sidecars](/features/xmp-sidecars)), remove `:ro` from the end of the mount point.
|
|
|
|
```diff
|
|
immich-server:
|
|
volumes:
|
|
- ${UPLOAD_LOCATION}:/data
|
|
+ - /home/user/photos1:/home/user/photos1:ro
|
|
+ - /mnt/photos2:/mnt/photos2:ro # you can delete this line if you only have one mount point, or you can add more lines if you have more than two
|
|
```
|
|
|
|
Restart Immich by running `docker compose up -d`.
|
|
|
|
# Create the library
|
|
|
|
:::info
|
|
External library management requires administrator access and the steps below assume you are using an admin account.
|
|
:::
|
|
|
|
In the Immich web UI:
|
|
|
|
- click the **Administration** link in the upper right corner.
|
|
<img src={require('./img/administration-link.webp').default} width="50%" title="Administration link" />
|
|
|
|
- Select the **External Libraries** tab and click the **Create Library** button
|
|
<img src={require('./img/create-external-library.webp').default} width="80%" title="Create Library button" />
|
|
|
|
- In the dialog, select which user should own the new library
|
|
<img src={require('./img/library-owner.webp').default} width="50%" title="Library owner dialog" />
|
|
|
|
- You are now entering the library management page.
|
|
<img src={require('./img/library-management-page.webp').default} width="80%" title="Library management page" />
|
|
|
|
- Click `Add` in the Folder section to specify a path for scanning and enter **/home/user/photos1** as the path and click Add
|
|
<img src={require('./img/edit-import-path.webp').default} width="50%" title="Add an import path" />
|
|
|
|
- Click the three-dots menu and select **Scan New Library Files**
|
|
<img src={require('./img/scan-new-library-files.webp').default} width="50%" title="Scan New Library Files menu option" />
|
|
|
|
# Confirm stuff is happening
|
|
|
|
- Click **Administration**
|
|
<img src={require('./img/administration-link.webp').default} width="50%" title="Administration link" />
|
|
|
|
- Select the **Jobs** tab
|
|
<img src={require('./img/jobs-tab.webp').default} width="50%" title="Jobs tab" />
|
|
|
|
- You should see non-zero Active jobs for
|
|
Library, Generate Thumbnails, and Extract Metadata.
|