Architecture¶

Service Topology¶

%%{init: {"flowchart": {"defaultRenderer": "elk", "nodeSpacing": 40, "rankSpacing": 50}}}%% flowchart TD classDef exposed fill:#2d3748,stroke:#4299e1,stroke-width:2px,color:#fff,rx:5px,ry:5px; classDef internal fill:#1a202c,stroke:#718096,stroke-width:1px,color:#e2e8f0,rx:5px,ry:5px; classDef datastore fill:#2b6cb0,stroke:#63b3ed,stroke-width:2px,color:#fff,rx:8px,ry:8px; immich_server["immich-server
immich-server:${IMMICH_VERSION:-release}"]:::internal immich_machine_learning["immich-machine-learning
immich-machine-learning:${IMMICH_VERSION:-release}-cuda"]:::internal valkey["valkey
valkey:9@sha256:3b55fbaa0cd93cf0d9d961f405e4dfcc70efe325e2d84da207a0a8e6d8fde4f9"]:::internal immich_postgres[("immich-postgres
postgres:14-vectorchord0.4.3-pgvectors0.2.0@sha256:bcf63357191b76a916ae5eb93464d65c07511da41e3bf7a8416db519b40b1c23
💾 Datastore")]:::datastore immich_server --> immich_postgres immich_server --> valkey

Startup Sequence¶

sequenceDiagram autonumber participant immich_server as immich-server participant immich_machine_learning as immich-machine-learning participant valkey as valkey participant immich_postgres as immich-postgres immich_server->>valkey: Connection / Init immich_server->>immich_postgres: Connection / Init

Services¶

immich-server¶

Image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}

Property	Value
Networks	traefik-public
Depends on	valkey, immich-postgres

Environment:

DB_HOSTNAME=immich-postgres
DB_USERNAME=${IMMICH_DB_USERNAME:-postgres}
DB_PASSWORD=${IMMICH_DB_PASSWORD}
DB_DATABASE_NAME=${IMMICH_DB_DATABASE_NAME:-immich}
REDIS_HOSTNAME=valkey
TZ=${TZ:-UTC}
UPLOAD_LOCATION=/usr/src/app/upload
OAUTH_ENABLED=true
OAUTH_ISSUER_URL=https://auth.${BASE_DOMAIN}/application/o/immich/
OAUTH_CLIENT_ID=${IMMICH_OAUTH_CLIENT_ID}
OAUTH_CLIENT_SECRET=${IMMICH_OAUTH_CLIENT_SECRET}
OAUTH_AUTO_REGISTER=true
OAUTH_BUTTON_TEXT=Login with Authentik
OAUTH_SCOPE=openid email profile

Volumes:

immich_upload:/usr/src/app/upload
all_data:/mnt/media/photos:ro
/etc/localtime:/etc/localtime:ro

immich-machine-learning¶

Image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}-cuda

Property	Value
Networks	traefik-public
Depends on	—

Environment:

NVIDIA_VISIBLE_DEVICES=all

Volumes:

immich_model_cache:/cache

valkey¶

Image: docker.io/valkey/valkey:9@sha256:3b55fbaa0cd93cf0d9d961f405e4dfcc70efe325e2d84da207a0a8e6d8fde4f9

Command: valkey-server --stop-writes-on-bgsave-error no

Property	Value
Networks	traefik-public
Depends on	—

Volumes:

immich_redis_data:/data

immich-postgres¶

Image: ghcr.io/immich-app/postgres:14-vectorchord0.4.3-pgvectors0.2.0@sha256:bcf63357191b76a916ae5eb93464d65c07511da41e3bf7a8416db519b40b1c23

Property	Value
Networks	traefik-public
Depends on	—

Environment:

POSTGRES_PASSWORD=${IMMICH_DB_PASSWORD}
POSTGRES_USER=${IMMICH_DB_USERNAME:-postgres}
POSTGRES_DB=${IMMICH_DB_DATABASE_NAME:-immich}
POSTGRES_INITDB_ARGS=--data-checksums

Volumes:

immich_pgdata:/var/lib/postgresql/data

Network Flow¶

sankey-beta Net: traefik-public, immich_machine_learning, 1 Net: traefik-public, immich_postgres, 1 Net: traefik-public, immich_server, 1 Net: traefik-public, valkey, 1