¶ What is Immich?
Easily back up, organize, and manage your photos on your own server. Immich helps you browse, search and organize your photos and videos with ease, without sacrificing your privacy.
¶ Installation
- Set a database and redis password
- If you have an nVidia GPU, select the Cuda Machine Learning Image for the Machine Learning Image Type
- Set Host Path Storage for Data and Postgres Storage options
Since Immich runs as
rootGeneric permissions are fine for all of these datasets
The Postgres Data Storage needs the ☑ Automatic Permissions checkbox checked!
- If you can, increase limits on the Resources Configuration
Check out the new docs from TrueNAS
services:
immich-server:
container_name: immich_server
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
volumes:
- /mnt/tank/configs/immich/uploads:/usr/src/app/upload
- /etc/localtime:/etc/localtime:ro
ports:
- '2283:2283'
depends_on:
- redis
- database
restart: unless-stopped
healthcheck:
disable: false
immich-machine-learning:
container_name: immich_machine_learning
image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}
volumes:
- ./model-cache:/cache
restart: unless-stopped
healthcheck:
disable: false
redis:
container_name: immich_redis
image: docker.io/valkey/valkey:8-bookworm@sha256:42cba146593a5ea9a622002c1b7cba5da7be248650cbb64ecb9c6c33d29794b1
healthcheck:
test: redis-cli ping || exit 1
restart: unless-stopped
database:
container_name: immich_postgres
image: docker.io/tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:739cdd626151ff1f796dc95a6591b55a714f341c737e27f045019ceabf8e8c52
environment:
POSTGRES_PASSWORD: ${DB_PASSWORD}
POSTGRES_USER: ${DB_USERNAME}
POSTGRES_DB: ${DB_DATABASE_NAME}
POSTGRES_INITDB_ARGS: '--data-checksums'
volumes:
- /mnt/tank/configs/immich/db:/var/lib/postgresql/data
healthcheck:
test: >-
pg_isready --dbname="$${POSTGRES_DB}" --username="$${POSTGRES_USER}" || exit 1; Chksum="$$(psql --dbname="$${POSTGRES_DB}" --username="$${POSTGRES_USER}" --tuples-only --no-align --command='SELECT COALESCE(SUM(checksum_failures), 0) FROM pg_stat_database')"; echo "checksum failure count is $$Chksum"; [ "$$Chksum" = '0' ] || exit 1
interval: 5m
start_interval: 30s
start_period: 5m
command: >-
postgres -c shared_preload_libraries=vectors.so -c 'search_path="$$user", public, vectors' -c logging_collector=on -c max_wal_size=2GB -c shared_buffers=512MB -c wal_compression=on
restart: unless-stopped
¶ env Variables
IMMICH_VERSION=release
DB_PASSWORD=postgres
DB_USERNAME=postgres
DB_DATABASE_NAME=immich
Set the IMMICH_VERSION based on the releases here.
¶ Folder Structure
tank
└── configs
└── immich
├── uploads
└── db
- The
uploadsdirectory will be where all photos are stored in individual folders per user
Since Immich runs as
rootGeneric permissions are fine for all of these datasets
services:
immich-server:
container_name: immich_server
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
volumes:
- /mnt/tank/configs/immich/uploads:/usr/src/app/upload
- /etc/localtime:/etc/localtime:ro
ports:
- 2283:2283
depends_on:
- redis
- database
restart: unless-stopped
healthcheck:
disable: false
immich-machine-learning:
container_name: immich_machine_learning
image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}-cuda
volumes:
- /mnt/tank/configs/immich/ml:/cache
restart: unless-stopped
healthcheck:
disable: false
environment:
- MACHINE_LEARNING__FACE_RECOGNITION_MODEL=mobile_face
- MACHINE_LEARNING__FACE_DETECTION_MODEL=yunet
- MACHINE_LEARNING__CLIP_MODEL=ViT-B-16__laion2b_s34b_b88k
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: 1
capabilities:
- gpu
redis:
container_name: immich_redis
image: docker.io/valkey/valkey:8-bookworm@sha256:42cba146593a5ea9a622002c1b7cba5da7be248650cbb64ecb9c6c33d29794b1
healthcheck:
test: redis-cli ping || exit 1
restart: unless-stopped
database:
container_name: immich_postgres
image: docker.io/tensorchord/pgvecto-rs:pg14-v0.2.0@sha256:739cdd626151ff1f796dc95a6591b55a714f341c737e27f045019ceabf8e8c52
environment:
POSTGRES_PASSWORD: ${DB_PASSWORD}
POSTGRES_USER: ${DB_USERNAME}
POSTGRES_DB: ${DB_DATABASE_NAME}
POSTGRES_INITDB_ARGS: --data-checksums
volumes:
- /mnt/tank/configs/immich/db:/var/lib/postgresql/data
healthcheck:
test: pg_isready --dbname="$${POSTGRES_DB}" --username="$${POSTGRES_USER}" ||
exit 1; Chksum="$$(psql --dbname="$${POSTGRES_DB}"
--username="$${POSTGRES_USER}" --tuples-only --no-align
--command='SELECT COALESCE(SUM(checksum_failures), 0) FROM
pg_stat_database')"; echo "checksum failure count is $$Chksum"; [
"$$Chksum" = '0' ] || exit 1
interval: 5m
start_interval: 30s
start_period: 5m
command: postgres -c shared_preload_libraries=vectors.so -c
'search_path="$$user", public, vectors' -c logging_collector=on -c
max_wal_size=2GB -c shared_buffers=512MB -c wal_compression=on
restart: unless-stopped
¶ env Variables
IMMICH_VERSION=release
DB_PASSWORD=postgres
DB_USERNAME=postgres
DB_DATABASE_NAME=immich
Set the IMMICH_VERSION based on the releases here.
¶ Folder Structure
tank
└── configs
└── immich
├── uploads
├── ml
└── db
¶ Adding External Libraries
- If installing from the TrueNAS apps catalog, under Storage Configuration → Additional Storage, add a host path pointed to where your photos are stored
- If installing via docker compose, add an additional line in the
immich_serversection pointed to where your photos are stored - Click the circle with the letter in the top right and select Administration
- Select External Libraries in the left panel
- Select an external library owner
- Click the 3 dots at the end of the row which was just created
- Select Edit Import Paths
- Select Add Path
- Add the path you mounted earlier and click Add
- Click Save