hassio-addons/immich/README.md

Home assistant add-on: immich

⚠️ The project is under very active development. Expect bugs and changes. Do not use it as the only way to store your photos and videos! (from the developer)

I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons

If this add-on saves you time or makes your setup easier, I would be very grateful for your support!

Addon informations

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

About

Web based files browser. This addon is based on the docker image from imagegenius.

Immich v3

This add-on tracks Immich v3 (built on the ghcr.io/imagegenius/immich:3 image line).

• Database: Immich v3 requires PostgreSQL (14–17) with the VectorChord (vchord) extension; upstream pgvecto.rs support has been removed. The Postgres 15 and Postgres 17 add-ons in this repository already provide a VectorChord-capable database and are the recommended choice (you can also use the official ghcr.io/immich-app/postgres:*-vectorchord* image).
• Upgrading from Immich v2: keep your existing VectorChord-capable database so Immich can migrate its data automatically. If your database still holds data in the old pgvecto.rs extension, leave that extension in place until Immich has finished migrating to VectorChord.
• CPU: on amd64, Immich v3 requires an x86-64-v2 (or newer) CPU.

See the official v3 migration guide for details.

Configuration

Webui can be found at <your-ip>:8080. PostgreSQL can be either internal or external.

Options

Option	Type	Default	Description
data_location	str	/share/immich	Path where Immich data is stored
library_location	str		Path to photo/video library
TZ	str		Timezone (e.g., Europe/London)
localdisks	str		Local drives to mount (e.g., sda1,sdb1,MYNAS)
networkdisks	str		SMB shares to mount (e.g., //SERVER/SHARE)
cifsusername	str		SMB username for network shares
cifspassword	str		SMB password for network shares
cifsdomain	str		SMB domain for network shares
DB_HOSTNAME	str	localhost	Database hostname
DB_USERNAME	str	immich	Database username
DB_PASSWORD	str		Database password
DB_DATABASE_NAME	str	immich	Database name
DB_PORT	int	5432	Database port
DB_ROOT_PASSWORD	str		Database root password
JWT_SECRET	str		JWT secret for authentication
DISABLE_MACHINE_LEARNING	bool	false	Disable ML features
MACHINE_LEARNING_WORKERS	int	1	Number of ML workers
MACHINE_LEARNING_WORKER_TIMEOUT	int	120	ML worker timeout (seconds)
VIPS_NOVECTOR	bool	false	Set to true to export VIPS_NOVECTOR=1 and work around aarch64 thumbnail generation issues
skip_permissions_check	bool	false	Skip file permissions checking

Example Configuration

data_location: "/share/immich"
library_location: "/media/photos"
TZ: "Europe/London"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/photos"
cifsusername: "photouser"
cifspassword: "password123"
DB_HOSTNAME: "core-mariadb"
DB_USERNAME: "immich"
DB_PASSWORD: "secure_password"
DB_DATABASE_NAME: "immich"
JWT_SECRET: "your-secret-key-here"

Mounting Drives

This addon supports mounting both local drives and remote SMB shares:

• Local drives: See Mounting Local Drives in Addons
• Remote shares: See Mounting Remote Shares in Addons

Using a Local Disk for Immich Storage

To save Immich data to a mounted local disk:

1. Set the localdisks option to your drive name (e.g., sda1). The drive will be mounted at /mnt/sda1.
2. Set the data_location option to a path on the mounted drive, for example /mnt/sda1/immich.

Example configuration:

localdisks: "sda1"
data_location: "/mnt/sda1/immich"

Custom Scripts and Environment Variables

This addon supports custom scripts and environment variables through the addon_config mapping:

• Custom scripts: See Running Custom Scripts in Addons
• env_vars option: Use the add-on env_vars option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
2. Install this add-on.
3. Click the Save button to store your configuration.
4. Start the add-on.
5. Check the logs of the add-on to see if everything went well.
6. Carefully configure the add-on to your preferences, see the official documentation for for that.

Beware that you need to install a separate postgres addon to be able to connect the database. You can install the postgres addon already in my repository. Beware to change the password BEFORE starting it ; it won't change afterwards

Support

Create an issue on github, or ask on the home assistant thread