Home assistant add-on: Immich OpenVINO
⚠️ 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
Self-hosted photo and video backup solution directly from your mobile phone with OpenVINO hardware acceleration support. This is the OpenVINO-enabled variant of Immich that provides hardware acceleration for machine learning tasks using Intel GPUs and CPUs.
This addon is based on the docker image from imagegenius with OpenVINO support enabled for enhanced performance on Intel hardware.
Hardware Requirements
- Intel Hardware: Compatible Intel CPU or Intel integrated/discrete GPU
- OpenVINO Support: Intel hardware with OpenVINO toolkit compatibility
- Architecture: AMD64 only (OpenVINO support optimized for Intel x86-64 architectures)
- Intel GPU Drivers: Intel GPU drivers properly installed on the host system (for Intel GPU acceleration)
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 | homeassistant.local |
Database hostname |
DB_USERNAME |
str | postgres |
Database username |
DB_PASSWORD |
str | homeassistant |
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 (not recommended for OpenVINO variant) |
MACHINE_LEARNING_WORKERS |
int | 1 |
Number of ML workers (can be increased with OpenVINO) |
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"
DISABLE_MACHINE_LEARNING: false
MACHINE_LEARNING_WORKERS: 2
MACHINE_LEARNING_WORKER_TIMEOUT: 180
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
- env_vars option: Use the add-on
env_varsoption 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.
Prerequisites:
- Intel CPU or Intel GPU for OpenVINO acceleration
- AMD64 architecture (ARM not supported)
- Intel GPU drivers installed (if using Intel GPU acceleration)
Steps:
- Add my Hass.io add-ons repository to your Hass.io instance.
- Install this add-on.
- Click the
Savebutton 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.
Database Setup: 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
