Getting started

Use Docker Compose for a first installation.

Requirements

  • A running Immich server reachable from the immich-edit container
  • Docker Engine with the docker compose plugin
  • A desktop browser for the editor. With WebGPU it can draw previews itself; on a plain http:// LAN address that takes one extra step
  • 8 GB RAM recommended for RAW rendering and local AI models

Start the container

  1. Create compose.yaml:

    services:
      immich-edit:
        image: haavardnk/immich-edit:latest
        ports:
          - "3000:3000"
        volumes:
          - immich-edit-data:/data
        restart: unless-stopped
    
    volumes:
      immich-edit-data:
    
  2. Start the service:

    docker compose up -d
    
  3. Open http://<server-address>:3000.

Complete setup before exposing the service publicly. The first Immich administrator to finish the setup form claims an unconfigured instance.

Claim the instance

  1. Enter the Immich server URL.
  2. Sign in with an Immich administrator account, using the OAuth button, email and password, or an API key.

The OAuth button appears when Immich has OAuth enabled. It only works once immich-edit’s addresses are registered with your identity provider; see OAuth sign-in.

Other users sign in with their own Immich account; each sees only their own edits, presets, and jobs.

Next steps