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 composeplugin - 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
-
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: -
Start the service:
docker compose up -d -
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
- Enter the Immich server URL.
- 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
- Put it behind HTTPS, or pick another way to get browser previews on a local network.
- Pass a GPU through for faster exports and AI masks.
- Install models if you want AI masks or AI Denoise.
- Start editing.