Skip to main content

Build your setup

Choose your platform and tier, save the generated files, then follow their install commands. Basic, GPU and Full each lead to the same first-film walkthrough.

This page runs entirely in your browser. What you type here is never sent anywhere: no requests, no analytics, no tracking. The files are built on this page and stay on it until you copy or download them.

Setup files for docs build v1.0.0. The app image and release assets use this same version.

The builder does not ask for your Immich API key. The files hold the placeholder replace-with-your-immich-api-key: create a key with the ten required read permissions and paste it over the placeholder in your own editor. Add the five upload permissions only to send films back; asset.delete is optional. Avoid the All preset.

Choose a tier

Start with Basic if you are unsure. Every tier makes a complete film.

Platform coverage and tested installations

See the deployment matrix for exact release and platform coverage.

Not yet tested as an end-to-end generated installation on Linux Docker Compose. Files are checked with Compose and the form is checked in a browser. Those checks do not run this installation. Earlier NAS, Mac and GPU Kubernetes checks are recorded in the measured results. Tried it? Report your platform, release and preflight result.

Nothing here contacts an Immich or model server.

Save these files for a fresh install. For an existing install, change service URLs in Settings. Preflight checks whether the requested tier is ready. After it passes, make your first film.

docker-compose.yml
Preview docker-compose.yml
services:
immich-memories:
image: "ghcr.io/sam-dumont/immich-memories:${IMMICH_MEMORIES_VERSION:-1.0.0}"
container_name: immich-memories
ports:
- "${UI_BIND_ADDRESS:-127.0.0.1}:22830:8080"
volumes:
- "immich-memories-config:/home/immich/.immich-memories"
- "./output:/app/output"
environment:
IMMICH_URL: "${IMMICH_URL:-http://immich-server:2283}"
IMMICH_API_KEY: "${IMMICH_API_KEY:-}"
TZ: "${TZ:-Etc/UTC}"
IMMICH_MEMORIES_AUTH_USERNAME: "${IMMICH_MEMORIES_AUTH_USERNAME:-}"
IMMICH_MEMORIES_AUTH_PASSWORD: "${IMMICH_MEMORIES_AUTH_PASSWORD:-}"
IMMICH_MEMORIES_SERVER__TRIGGER_TOKEN: "${IMMICH_MEMORIES_SERVER__TRIGGER_TOKEN:-}"
IMMICH_MEMORIES_SECRET_KEY: "${IMMICH_MEMORIES_SECRET_KEY:-}"
IMMICH_MEMORIES_DEPLOYMENT_TIER: "${TIER:-basic}"
IMMICH_MEMORIES_DEPLOYMENT_GPU_BOX: "${GPU_BOX:-}"
IMMICH_MEMORIES_DEPLOYMENT_READER_URL: "${READER_URL:-}"
IMMICH_MEMORIES_DEPLOYMENT_READER_API_KEY: "${READER_API_KEY:-}"
IMMICH_MEMORIES_DEPLOYMENT_READER_MODEL: "${READER_MODEL:-}"
IMMICH_MEMORIES_DEPLOYMENT_READER_ENABLED: "${READER_ENABLED:-false}"
IMMICH_MEMORIES_EDITORIAL__PREPARATION__DETECTOR_CACHE_DIR: "/home/immich/.immich-memories/models/huggingface"
restart: unless-stopped
deploy:
resources:
limits:
memory: "4G"
volumes:
immich-memories-config: {}
.env

Browsers often save this as env or env.txt. Rename it to .env (with the leading dot) before you run docker compose.

Preview .env
IMMICH_MEMORIES_VERSION=1.0.0
TIER=basic
IMMICH_URL='http://192.168.1.10:2283'
IMMICH_API_KEY=replace-with-your-immich-api-key

Private UI access with an SSH tunnel
Private UI access
# From your computer, when the app runs on a headless host:
ssh -L 22830:localhost:22830 your-ssh-user@your-host
# Open http://localhost:22830 in your browser.

On a server or NAS, read how to open the app to your LAN before starting, or use the private SSH tunnel above.

The commands below use immich-memories/output for finished films. On Linux, run mkdir -p immich-memories/output && sudo chown 1000:1000 immich-memories/output before those commands. On Synology, give that folder write access for UID/GID 1000 using the folder permissions recipe.

Install and check
# On the app host:
mkdir -p immich-memories/output && cd immich-memories
# Save the two generated files here, then create your private settings key.
# Put your Immich API key in .env (replace "replace-with-your-immich-api-key"): https://sam-dumont.github.io/immich-memories/docs/run/docker#the-api-key
printf 'IMMICH_MEMORIES_SECRET_KEY=%s\n' "$(openssl rand -hex 32)" >> .env
docker compose up -d
docker compose exec -T immich-memories immich-memories models fetch
docker compose exec -T immich-memories immich-memories preflight
docker compose exec -T immich-memories immich-memories capabilities
# Open http://localhost:22830 in your browser.