🐋 Docker Setup [Docker Compose]

This guide shows how to start ImmichFrame using Docker Compose.

---

Configuration Files

Recommended

For most users, the Settings.yml setup is easier to read and modify.

Example configuration files:

• Settings.yml example — imported once on first start
• Settings.json example — imported once on first start
• .env example — admin password, config path and log level

Starting without a settings file is fine: open the admin UI at /admin, pick an admin password on the setup screen and configure everything there. Setting IMMICHFRAME_ADMIN_PASSWORD (as below) chooses that password up front instead.

---

Docker Compose Example

Important

If using yaml or json settings, replace PATH/TO/CONFIG with the actual path to your config folder containing the settings file!

name: immichframe
services:
  immichframe:
    container_name: immichframe
    image: ghcr.io/immichframe/immichframe:latest
    restart: on-failure
    volumes:
      - PATH/TO/CONFIG:/app/Config
    ports:
      - "8080:8080"
    environment:
      TZ: "Europe/Berlin"
      IMMICHFRAME_ADMIN_PASSWORD: "CHANGE_ME"