The Webcoast
Back to Immich

Setting up Immich

A from-scratch setup using Immich's own official compose files, the fastest route to a working install.

  1. 1

    Download the official compose files

    Immich publishes a ready-to-go docker-compose.yml and .env with every release. Grab both into a new folder rather than writing one by hand, it already wires up the database and machine-learning containers correctly.

    mkdir immich && cd immich
    curl -o docker-compose.yml https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
    curl -o .env https://github.com/immich-app/immich/releases/latest/download/example.env
  2. 2

    Set the upload location and a database password

    Open .env and edit UPLOAD_LOCATION to point at wherever photos should actually live on disk, and change DB_PASSWORD to something other than the placeholder.

  3. 3

    Start it

    First run pulls a handful of images, including the machine-learning one used for face and object recognition, so it can take a few minutes. Once it's up, the web app is reachable at port 2283.

    docker compose up -d
  4. 4

    Create the admin account

    The first visit to the web app prompts for an admin account, this is local to this server only.

  5. 5

    Install the mobile app and back up

    The Immich app (iOS and Android) points at this server's address and can back up a camera roll automatically in the background, the same way Google Photos or iCloud would. Each person gets their own account rather than sharing one.

Further reading

  • Immich documentation

    Official docs covering the full setup, mobile app configuration, and every feature beyond this quick start.

  • Immich on GitHub

    Source, releases, and the issue tracker for anything not covered in the docs.