Immich is a high performance self-hosted photo and video backup solution.

We use Docker manifest for cross-platform compatibility. More details can be found on Docker's website.

To obtain the appropriate image for your architecture, simply pull ghcr.io/imagegenius/immich:latest. Alternatively, you can also obtain specific architecture images by using tags.

This image supports the following architectures:

This image offers different versions via tags. Be cautious when using unstable or development tags, and read their descriptions carefully.

Access the WebUI at http://your-ip:8080. Follow the setup wizard to configure Immich.

• PostgreSQL: Version 14, 15, or 16 with pgvecto.rs setup externally.
• Redis: Setup externally or within the container using a docker mod.

• Set DOCKER_MODS=imagegenius/mods:universal-redis
• Configure REDIS_HOSTNAME to localhost

To use SSL, include a PostgreSQL URL in the DB_URL environment variable.

To enable Intel Quicksync:

1. Ensure container access to /dev/dri.

2. Add /dev/dri to your Docker run command:

   docker run --device=/dev/dri:/dev/dri ...

1. Install the Nvidia container runtime as per these instructions.

2. Create a new Docker container using the Nvidia runtime:

   • Use --runtime=nvidia and NVIDIA_VISIBLE_DEVICES=all in your Docker run command, or specify a particular GPU UUID instead of all.

   docker run --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all

   • Alternatively, use --gpus=all to enable all GPUs.

   docker run --gpus=all ...

3. To enable GPU acceleration for machine learning, add MACHINE_LEARNING_GPU_ACCELERATION=cuda

• Mount the existing library folder to /import.
• Set /import (or /import/<user> for multiple users) as the external path in the administration settings.
• In account settings, add a new library with the path set to /import or /import/<user>.

Example snippets to start creating a container:

---
services:
  immich:
    image: ghcr.io/imagegenius/immich:latest
    container_name: immich
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - DB_HOSTNAME=192.168.1.x
      - DB_USERNAME=postgres
      - DB_PASSWORD=postgres
      - DB_DATABASE_NAME=immich
      - REDIS_HOSTNAME=192.168.1.x
      - DB_PORT=5432 #optional
      - REDIS_PORT=6379 #optional
      - REDIS_PASSWORD= #optional
      - MACHINE_LEARNING_GPU_ACCELERATION= #optional
      - MACHINE_LEARNING_WORKERS=1 #optional
      - MACHINE_LEARNING_WORKER_TIMEOUT=120 #optional
    volumes:
      - path_to_appdata:/config
      - path_to_photos:/photos
      - path_to_imports:/import:ro #optional
    ports:
      - 8080:8080
    restart: unless-stopped

# This container requires an external application to be run separately.
# By default, ports for the databases are opened, be careful when deploying it
# Redis:
  redis:
    image: redis
    ports:
      - 6379:6379
    container_name: redis
# PostgreSQL 14:
  postgres14:
    image: tensorchord/pgvecto-rs:pg14-v0.2.0
    ports:
      - 5432:5432
    container_name: postgres14
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: immich
    volumes:
      - path_to_postgres:/var/lib/postgresql/data

docker run -d \
  --name=immich \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e DB_HOSTNAME=192.168.1.x \
  -e DB_USERNAME=postgres \
  -e DB_PASSWORD=postgres \
  -e DB_DATABASE_NAME=immich \
  -e REDIS_HOSTNAME=192.168.1.x \
  -e DB_PORT=5432 `#optional` \
  -e REDIS_PORT=6379 `#optional` \
  -e REDIS_PASSWORD= `#optional` \
  -e MACHINE_LEARNING_GPU_ACCELERATION= `#optional` \
  -e MACHINE_LEARNING_WORKERS=1 `#optional` \
  -e MACHINE_LEARNING_WORKER_TIMEOUT=120 `#optional` \
  -p 8080:8080 \
  -v path_to_appdata:/config \
  -v path_to_photos:/photos \
  -v path_to_imports:/import:ro `#optional` \
  --restart unless-stopped \
  ghcr.io/imagegenius/immich:latest

# This container requires an external application to be run separately.
# By default, ports for the databases are opened, be careful when deploying it
# Redis:
docker run -d \
  --name=redis \
  -p 6379:6379 \
  redis

# PostgreSQL 14:
docker run -d \
  --name=postgres14 \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_DB=immich \
  -v path_to_postgres:/var/lib/postgresql/data \
  -p 5432:5432 \
  tensorchord/pgvecto-rs:pg14-v0.2.0

To configure the container, pass variables at runtime using the format <external>:<internal>. For instance, -p 8080:80 exposes port 80 inside the container, making it accessible outside the container via the host's IP on port 8080.

All of our images allow overriding the default umask setting for services started within the containers using the optional -e UMASK=022 option. Note that umask works differently than chmod and subtracts permissions based on its value, not adding. For more information, please refer to the Wikipedia article on umask here.

To avoid permissions issues when using volumes (-v flags) between the host OS and the container, you can specify the user (PUID) and group (PGID). Make sure that the volume directories on the host are owned by the same user you specify, and the issues will disappear.

Example: PUID=1000 and PGID=1000. To find your PUID and PGID, run id user.

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Most of our images are static, versioned, and require an image update and container recreation to update the app. We do not recommend or support updating apps inside the container. Check the Application Setup section for recommendations for the specific image.

Instructions for updating containers:

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull immich
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d immich
• You can also remove the old dangling images: docker image prune

• Update the image: docker pull ghcr.io/imagegenius/immich:latest
• Stop the running container: docker stop immich
• Delete the container: docker rm immich
• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images: docker image prune

• 22.01.24: - support GPU acceleration with CUDA for machine-learning
• 23.12.23: - move to using seperate immich baseimage
• 07.12.23: - rebase to ubuntu mantic
• 07.12.23: - remove typesense (no longer needed)
• 24.09.23: - house cleaning
• 24.09.23: - add vars for ml workers/timeout
• 29.07.23: - remove cuda acceleration for machine-learning
• 23.05.23: - rebase to ubuntu lunar and support cuda acceleration for machine-learning
• 22.05.23: - deprecate postgresql docker mod
• 18.05.23: - add support for facial recognition
• 07.05.23: - remove unused JWT_SECRET env
• 13.04.23: - add variables to disable typesense and machine learning
• 10.04.23: - fix gunicorn
• 04.04.23: - use environment variables to set location of the photos folder
• 09.04.23: - Cache is downloaded to the host (/config/transformers)
• 01.04.23: - remove unused Immich environment variables
• 21.03.23: - Add service checks
• 05.03.23: - add typesense
• 27.02.23: - re-enable aarch64 with pre-release torch build
• 18.02.23: - use machine-learning with python
• 11.02.23: - use external app block
• 09.02.23: - Use Immich environment variables for immich services instead of hosts file
• 09.02.23: - execute CLI with the command immich
• 04.02.23: - shrink image
• 26.01.23: - add unraid migration to readme
• 26.01.23: - use find to apply chown to /app, excluding node_modules
• 26.01.23: - enable ci testing
• 24.01.23: - fix services starting prematurely, causing permission errors.
• 23.01.23: - add noml image to readme and add aarch64 image to readme, make github release stable
• 21.01.23: - BREAKING: Redis is removed. Update missing param_env_vars & opt_param_env_vars for redis & postgres
• 02.01.23: - Initial Release.