Immich: Difference between revisions
m Make headers consistent |
Add updating instructions |
||
| Line 1: | Line 1: | ||
<span id="administration"></span> |
|||
== Administration == |
== Administration == |
||
* Admin credentials are stored in [TODO]. |
* Admin credentials are stored in [TODO]. |
||
* Take care not to touch the external libraries unless you know what you're doing; those are used to link users' Nextcloud data to their Immich accounts. |
* Take care not to touch the external libraries unless you know what you're doing; those are used to link users' Nextcloud data to their Immich accounts. |
||
<span id="container-setup"></span> |
|||
== Container setup == |
== Container setup == |
||
Immich runs in <code>docker compose</code>. All relevant files can be found in <code>/root/immich</code> on guayusa. |
Immich runs in <code>docker compose</code>. All relevant files can be found in <code>/root/immich</code> on guayusa. |
||
<span id="access"></span> |
|||
== Access == |
== Access == |
||
In <code>/root/immich</code> on guayusa: |
In <code>/root/immich</code> on guayusa: |
||
* <code>docker compose exec -it database psql -U postgres immich</code> will get you a psql shell in the Immich Postgres database. |
* <code>docker compose exec -it database psql -U postgres immich</code> will get you a psql shell in the Immich Postgres database. |
||
* <code>curl https://photos.csclub.uwaterloo.ca/api/*</code> or <code>curl https://localhost:2283/api/*</code> lets you access the [https://api.immich.app/introduction Immich API]. You'll need to create an API key through the web UI -> Administration, then pass it in as the `x-api-key` header. |
* <code>curl https://photos.csclub.uwaterloo.ca/api/*</code> or <code>curl https://localhost:2283/api/*</code> lets you access the [https://api.immich.app/introduction Immich API]. You'll need to create an API key through the web UI -> Administration, then pass it in as the `x-api-key` header. |
||
<span id="updating-immich"></span> |
|||
== Updating Immich == |
|||
As root: |
|||
* <code>cd /root/immich</code> |
|||
* <code>docker compose pull</code> |
|||
* <code>docker compose up -d</code> |
|||
<span id="nginx"></span> |
<span id="nginx"></span> |
||
Revision as of 17:50, 1 October 2025
Administration
- Admin credentials are stored in [TODO].
- Take care not to touch the external libraries unless you know what you're doing; those are used to link users' Nextcloud data to their Immich accounts.
Container setup
Immich runs in docker compose. All relevant files can be found in /root/immich on guayusa.
Access
In /root/immich on guayusa:
docker compose exec -it database psql -U postgres immichwill get you a psql shell in the Immich Postgres database.curl https://photos.csclub.uwaterloo.ca/api/*orcurl https://localhost:2283/api/*lets you access the Immich API. You'll need to create an API key through the web UI -> Administration, then pass it in as the `x-api-key` header.
Updating Immich
As root:
cd /root/immichdocker compose pulldocker compose up -d
Nginx
The Immich setup piggybacks off the nginx instance running in the Nextcloud container. Once you've gained access to the container via sudo machinectl shell nextcloud, the nginx config can be found at /etc/nginx/sites-available/immich.
Linking Nextcloud
Every user who has logged into both Immich and Nextcloud will have an external library created in Immich, following the naming convention [watiam]'s Library. This allows Immich to access the user's images stored in Nextcloud, located at /var/lib/machines/nextcloud/data/nextcloud-data/[watiam]/files.
The libraries are created by the script /root/immich/sync-libraries.sh. It's in the root user's crontab, set to run every hour.
OIDC setup
OAuth can be configured in the web UI -> Administration from the admin account. Documentation.