Portainer Templates logo

Portainer Templates

Immich Immich

Stack

PhotosAI

Immich is a high performance self-hosted photo and video backup solution.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

immich-server

Configuration

Image
altran1502/immich-server:release
Entrypoint
/bin/sh,./start-server.sh
Volumes
/usr/src/app/upload : /portainer/Files/AppData/Config/immich
Env vars
NODE_ENV=productionIMMICH_SERVER_URL=http://immich-server:3001DB_HOSTNAME=immich_postgresDB_USERNAME=postgresDB_PASSWORD=postgresDB_DATABASE_NAME=immich
Restart
always

Image details

Pulls: 32.5M
User: altran1502
Created: Feb 06, 2022
Updated: 15 days ago
Status: active

immich-microservices

Configuration

Image
altran1502/immich-server:release
Entrypoint
/bin/sh,./start-microservices.sh
Volumes
/usr/src/app/upload : /portainer/Files/AppData/Config/immich
Env vars
NODE_ENV=productionDB_HOSTNAME=immich_postgresDB_USERNAME=postgresDB_PASSWORD=postgresDB_DATABASE_NAME=immich
Restart
always

Image details

Pulls: 32.5M
User: altran1502
Created: Feb 06, 2022
Updated: 15 days ago
Status: active

immich-machine-learning

Configuration

Image
altran1502/immich-machine-learning:release
Entrypoint
/bin/sh,./entrypoint.sh
Volumes
/usr/src/app/upload : /portainer/Files/AppData/Config/immich
Env vars
NODE_ENV=production
Restart
always

Image details

Pulls: 30.6M
User: altran1502
Created: Jun 07, 2022
Updated: 15 days ago
Status: active

immich-web

Configuration

Image
altran1502/immich-web:release
Entrypoint
/bin/sh,./entrypoint.sh
Env vars
VITE_SERVER_ENDPOINT=http://immich-web:2283/api
Restart
always

Image details

Pulls: 1.7M
User: altran1502
Created: May 20, 2022
Updated: 2 years ago
Status: active

immich-redis

Configuration

Image
redis:6.2
Env vars
REDIS_HOSTNAME=immich_redis
Restart
always

Image details

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

immich-database

Configuration

Image
postgres:14
Volumes
/var/lib/postgresql/data : /portainer/Files/AppData/Config/immich/pgdata
Env vars
DB_HOSTNAME=immich_postgresDB_USERNAME=postgresDB_PASSWORD=postgresDB_DATABASE_NAME=immichPOSTGRES_PASSWORD=postgresPOSTGRES_USER=postgresPOSTGRES_DB=immich
Restart
always

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 hour ago
Status: active

immich-proxy

Configuration

Image
altran1502/immich-proxy:release
Ports
2283:8080
Env vars
IMMICH_SERVER_URL=http://immich-server:3001IMMICH_WEB_URL=http://immich-web:3000
Restart
always

Image details

Pulls: 1.6M
User: altran1502
Created: Jun 29, 2022
Updated: 2 years ago
Status: active

Standalone Install

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

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, 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:

services:
  immich-server:
    container_name: immich_server
    image: altran1502/immich-server:release
    entrypoint: ["/bin/sh", "./start-server.sh"]
    volumes:
      - /portainer/Files/AppData/Config/immich:/usr/src/app/upload
    environment:
      - NODE_ENV=production
      - IMMICH_SERVER_URL=http://immich-server:3001
      #- IMMICH_MACHINE_LEARNING_URL=http://immich-machine-learning:3303
      - DB_HOSTNAME=immich_postgres
      - DB_USERNAME=postgres
      - DB_PASSWORD=postgres
      - DB_DATABASE_NAME=immich
    depends_on:
      - immich-redis
      - immich-database
    restart: always

  immich-microservices:
    container_name: immich_microservices
    image: altran1502/immich-server:release
    entrypoint: ["/bin/sh", "./start-microservices.sh"]
    volumes:
      - /portainer/Files/AppData/Config/immich:/usr/src/app/upload
    environment:
      - NODE_ENV=production
      - DB_HOSTNAME=immich_postgres
      - DB_USERNAME=postgres
      - DB_PASSWORD=postgres
      - DB_DATABASE_NAME=immich
    depends_on:
      - immich-redis
      - immich-database
    restart: always

  immich-machine-learning:
    container_name: immich_machine_learning
    image: altran1502/immich-machine-learning:release
    entrypoint: ["/bin/sh", "./entrypoint.sh"]
    volumes:
      - /portainer/Files/AppData/Config/immich:/usr/src/app/upload
    environment:
      - NODE_ENV=production
      #- IMMICH_MACHINE_LEARNING_URL=http://immich-machine-learning:3303
    depends_on:
      - immich-database
    restart: always

  immich-web:
    container_name: immich_web
    image: altran1502/immich-web:release
    entrypoint: ["/bin/sh", "./entrypoint.sh"]
    environment:
      #- IMMICH_WEB_URL=http://immich-web:3300
      - VITE_SERVER_ENDPOINT=http://immich-web:2283/api
    restart: always

  immich-redis:
    container_name: immich_redis
    image: redis:6.2
    restart: always
    environment:
      - REDIS_HOSTNAME=immich_redis

  immich-database:
    container_name: immich_postgres
    image: postgres:14
    environment:
      - DB_HOSTNAME=immich_postgres
      - DB_USERNAME=postgres
      - DB_PASSWORD=postgres
      - DB_DATABASE_NAME=immich
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_USER=postgres
      - POSTGRES_DB=immich
    volumes:
      - /portainer/Files/AppData/Config/immich/pgdata:/var/lib/postgresql/data
    restart: always

  immich-proxy:
    container_name: immich_proxy
    image: altran1502/immich-proxy:release
    environment:
      - IMMICH_SERVER_URL=http://immich-server:3001
      - IMMICH_WEB_URL=http://immich-web:3000
    ports:
      - 2283:8080
    logging:
      driver: none
    depends_on:
      - immich-server
    restart: always

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/immich.yml up -d

More install options in our documentation.

Container Documentation

immich-redis Documentation

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

immich-database Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

Serve Immich on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying immich.example.com to http://immich-proxy:8080

Add this to your Caddyfile

immich.example.com {
	reverse_proxy http://immich-proxy:8080
}

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.

Port already in use

If deployment fails with "Bind for 0.0.0.0:2283 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :2283
  • Stop the other service, or pick a different host port. In 2283:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:2283. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, immich can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 2283

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 1000:1000 /portainer/Files/AppData/Config/immich (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull altran1502/immich-server: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 is a Compose stack, a set of containers (7 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 7 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • immich-server runs altran1502/immich-server:release, starts after immich-redis, immich-database
  • immich-microservices runs altran1502/immich-server:release, starts after immich-redis, immich-database
  • immich-machine-learning runs altran1502/immich-machine-learning:release, starts after immich-database
  • immich-web runs altran1502/immich-web:release
  • immich-redis runs redis:6.2
  • immich-database runs postgres:14
  • immich-proxy runs altran1502/immich-proxy:release, starts after immich-server

Ports

A port is the door the app answers on. A mapping like 2283:8080 means it's reachable on port 2283 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:2283 in a browser. It opens:

  • 2283:8080, likely the web interface

Volumes

A volume is where Immich 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 from /portainer/Files/AppData/Config/immich on the host
  • /var/lib/postgresql/data from /portainer/Files/AppData/Config/immich/pgdata on the host

Environment variables

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

  • NODE_ENV, defaults to production
  • IMMICH_SERVER_URL, defaults to http://immich-server:3001
  • DB_HOSTNAME, defaults to immich_postgres
  • DB_USERNAME, defaults to postgres
  • DB_PASSWORD, defaults to postgres
  • DB_DATABASE_NAME, defaults to immich
  • VITE_SERVER_ENDPOINT, defaults to http://immich-web:2283/api
  • REDIS_HOSTNAME, defaults to immich_redis
  • POSTGRES_PASSWORD, defaults to postgres
  • POSTGRES_USER, defaults to postgres
  • POSTGRES_DB, defaults to immich
  • IMMICH_WEB_URL, defaults to http://immich-web:3000

Restart policy

The restart policy here is always, so Docker brings Immich 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).

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 up. Add the template list to Portainer once, then deploying Immich is a click rather than a wall of config.