⚠️ 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)

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.

Configuration

Webui can be found at <your-ip>:8080. PostgreSQL/MySQL 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)
`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

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
Environment variables: See Add Environment Variables to your Addon

Installation

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

Add my Hass.io add-ons repository to your Hass.io instance.
Install this add-on.
Click the Save button to store your configuration.
Start the add-on.
Check the logs of the add-on to see if everything went well.
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