Portainer Templates logo

Portainer Templates

Immich {shmolf} Immich {shmolf}

Stack

PhotosBackup

Self-hosted backup solution for photos and videos on mobile device.

Configuration

Type
Compose
Platform
linux
Env vars
PUID=1000PGID=1000IMMICH_VERSION=releaseDB_USERNAME=postgresDB_PASSWORD=please-change-this-to-a-random-secretDB_DATABASE_NAME=immichDB_HOSTNAME=immich_postgresUPLOAD_LOCATION=/portainer/Files/AppData/Immich/uploadREDIS_HOSTNAME=immich_redisPORT=2283
Source
Repo

Template by shmolfΒ·Source

Notes

Application documentation πŸ——

Services

immich-server

Configuration

Image
ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
Command
start.sh,immich
Ports
${PORT}:3001
Volumes
/usr/src/app/upload : ${UPLOAD_LOCATION}/etc/localtime : /etc/localtime
Env vars
PUID=${PUID}PGID=${PGID}DB_PASSWORD=${DB_PASSWORD}DB_HOSTNAME=${DB_HOSTNAME}DB_USERNAME=${DB_USERNAME}DB_DATABASE_NAME=${DB_DATABASE_NAME}REDIS_HOSTNAME=${REDIS_HOSTNAME}
Restart
always

immich-microservices

Configuration

Image
ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
Command
start.sh,microservices
Volumes
/usr/src/app/upload : ${UPLOAD_LOCATION}/etc/localtime : /etc/localtime
Env vars
PUID=${PUID}PGID=${PGID}DB_PASSWORD=${DB_PASSWORD}DB_HOSTNAME=${DB_HOSTNAME}DB_USERNAME=${DB_USERNAME}DB_DATABASE_NAME=${DB_DATABASE_NAME}REDIS_HOSTNAME=${REDIS_HOSTNAME}
Restart
always

immich-machine-learning

Configuration

Image
ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}
Volumes
/cache : model-cache
Restart
always

redis

Configuration

Image
redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
Restart
always

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

database

Configuration

Image
tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
Volumes
/var/lib/postgresql/data : pgdata
Env vars
POSTGRES_PASSWORD=${DB_PASSWORD}POSTGRES_USER=${DB_USERNAME}POSTGRES_DB=${DB_DATABASE_NAME}
Restart
always

Image details

Pulls: 22.2M
User: tensorchord
Created: Aug 19, 2023
Updated: 1 years ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Immich {shmolf}

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings β†’ App Templates, paste the below URL
  4. Head to Home β†’ App Templates, and the list of apps will show up
  5. Select Immich {shmolf}, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

---
version: "3.8"

#
# WARNING: Make sure to use the docker-compose.yml of the current release:
#
# https://github.com/immich-app/immich/releases/latest/download/docker-compose.yml
#
# The compose file on main may not be compatible with the latest release.
#

services:
  immich-server:
    container_name: immich_server
    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
    command: [ "start.sh", "immich" ]
    volumes:
      - ${UPLOAD_LOCATION}:/usr/src/app/upload
      - /etc/localtime:/etc/localtime:ro
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - DB_PASSWORD=${DB_PASSWORD}
      - DB_HOSTNAME=${DB_HOSTNAME}
      - DB_USERNAME=${DB_USERNAME}
      - DB_DATABASE_NAME=${DB_DATABASE_NAME}
      - REDIS_HOSTNAME=${REDIS_HOSTNAME}
    ports:
      - ${PORT}:3001
    depends_on:
      - redis
      - database
    restart: always

  immich-microservices:
    container_name: immich_microservices
    image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
    # extends:
    #   file: hwaccel.yml
    #   service: hwaccel
    command: [ "start.sh", "microservices" ]
    volumes:
      - ${UPLOAD_LOCATION}:/usr/src/app/upload
      - /etc/localtime:/etc/localtime:ro
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - DB_PASSWORD=${DB_PASSWORD}
      - DB_HOSTNAME=${DB_HOSTNAME}
      - DB_USERNAME=${DB_USERNAME}
      - DB_DATABASE_NAME=${DB_DATABASE_NAME}
      - REDIS_HOSTNAME=${REDIS_HOSTNAME}
    depends_on:
      - redis
      - database
    restart: always

  immich-machine-learning:
    container_name: immich_machine_learning
    image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}
    volumes:
      - model-cache:/cache
    restart: always

  redis:
    container_name: immich_redis
    image: redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
    restart: always

  database:
    container_name: immich_postgres
    image: tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee
    environment:
      POSTGRES_PASSWORD: ${DB_PASSWORD}
      POSTGRES_USER: ${DB_USERNAME}
      POSTGRES_DB: ${DB_DATABASE_NAME}
    volumes:
      - pgdata:/var/lib/postgresql/data
    restart: always

volumes:
  pgdata:
  model-cache:

Or deploy it directly from the source:

git clone https://github.com/shmolf/portainer-templates
cd portainer-templates
docker compose -f stacks/immich/docker-compose.yml up -d

More install options in our documentation.

Container Documentation

redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

database Documentation

Scalable Vector Search in Postgres. Revolutionize Vector Search, not Database. pgvector alternative.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R ${PUID}:${PGID} /etc/localtime
  • Or set the PUID and PGID variables (defaults ${PUID}:${PGID}) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Immich {shmolf} is a Compose stack, a set of containers (5 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 5 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • immich-server runs ghcr.io/immich-app/immich-server:release, starts after redis, database
  • immich-microservices runs ghcr.io/immich-app/immich-server:release, starts after redis, database
  • immich-machine-learning runs ghcr.io/immich-app/immich-machine-learning:release
  • redis runs redis:6.2-alpine@sha256:b6124ab2e45cc332e16398022a411d7e37181f21ff7874835e0180f56a09e82a
  • database runs tensorchord/pgvecto-rs:pg14-v0.1.11@sha256:0335a1a22f8c5dd1b697f14f079934f5152eaaa216c09b61e293be285491f8ee

Volumes

A volume is where Immich {shmolf} keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /usr/src/app/upload kept in the ${UPLOAD_LOCATION} volume Docker manages
  • /etc/localtime from /etc/localtime on the host
  • /cache kept in the model-cache volume Docker manages
  • /var/lib/postgresql/data kept in the pgdata volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Immich {shmolf} takes 10 of them, all with defaults you can leave alone or tweak:

  • PUID, pulled from your own environment
  • PGID, pulled from your own environment
  • DB_PASSWORD, pulled from your own environment
  • DB_HOSTNAME, pulled from your own environment
  • DB_USERNAME, pulled from your own environment
  • DB_DATABASE_NAME, pulled from your own environment
  • REDIS_HOSTNAME, pulled from your own environment
  • POSTGRES_PASSWORD, pulled from your own environment
  • POSTGRES_USER, pulled from your own environment
  • POSTGRES_DB, pulled from your own environment

Restart policy

The restart policy here is always, so Docker brings Immich {shmolf} back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like immich-server) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Immich {shmolf} up. Add the template list to Portainer once, then deploying Immich {shmolf} is a click rather than a wall of config.