immich-folio/docs/deployment.md

Deployment

Operational detail for running Immich Folio: what the setup wizard writes, the Docker options beyond the basic Compose recipe, and what happens when Immich goes away.

For the quick path — clone, npm run dev, open /install — see the README.

Contents:

• What the Setup Wizard Writes
• Environment Variables Always Win
• Docker Compose
• Standalone Docker
• Health Check
• Behaviour when Immich is Unreachable
• Reverse Proxy

What the Setup Wizard Writes

The wizard at /install writes three files into content/:

File	Contents
content/gallery.yaml	The albums you picked
content/settings.yaml	Site title, subtitle, theme — only if it does not exist yet
content/install.json	Immich URL and API key, a generated site secret, admin password hash

Important

content/install.json holds credentials. It is written with mode 0600, and it is the reason a backup of your content/ directory is also a backup of your Immich API key — treat it accordingly. The admin password is stored as an scrypt hash, not as you typed it; the API key and site secret have to stay readable to be usable.

Nothing is written until your credentials have been verified against your Immich server, so a typo cannot leave you with an "installed" site that loads no photos.

Environment Variables Always Win

IMMICH_API_URL, IMMICH_API_KEY, AUTH_SECRET and ADMIN_PASSWORD override anything in install.json, so any of them can be rotated by setting the variable — no need to touch the file.

Set all of them up front and the wizard never appears, which is the usual choice for an infrastructure-as-code deployment.

Docker Compose

services:
  lightbox:
    build: .
    container_name: immich-folio
    restart: unless-stopped
    ports:
      - '7211:7211'
    env_file:
      - .env.local
    volumes:
      - ./content:/app/content

docker compose up -d

The gallery will be available at http://localhost:7211.

Standalone Docker

# Build
docker build -t immich-folio .

# Run
docker run -d \
  --name immich-folio \
  --restart unless-stopped \
  -p 7211:7211 \
  --env-file .env.local \
  -v ./content:/app/content \
  immich-folio

Important

The content/ volume mount lets you update gallery.yaml and about.md without rebuilding the image. It must be read-write: the setup wizard, the admin panel, the journal, the favicon upload and the backup rotation all write into it. A :ro mount leaves the wizard unable to complete and the admin panel unable to save.

Health Check

The container includes a built-in health check at /api/health:

curl http://localhost:7211/api/health

Behaviour when Immich is Unreachable

Immich Folio buffers your gallery rather than merely proxying it:

• Album and asset pages keep serving the last known good data for up to STALE_MAX_AGE, so a restarting or briefly unreachable Immich does not take the public site down with it.
• Once nothing cached is left, they return 503, never 404 — a 404 would tell search engines to drop a URL for content that still exists.
• Outages are never cached, so the gallery recovers as soon as Immich does.

The cache lives in the process, so it is empty right after a container restart.

Reverse Proxy

Put Immich Folio behind nginx / Caddy / Traefik with TLS. Example Caddy config:

photos.example.com {
    reverse_proxy localhost:7211
}

Important

Set TRUSTED_PROXY_HOPS to the number of proxies in front of the app, and make sure they forward X-Forwarded-For correctly — otherwise the client IP comes from a header the client itself can set, which defeats the brute-force limits on the password endpoints. See Trusted Proxies for the setting and a matching nginx config.