avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-01-11 02:11:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Claudify

Browse Source
This commit is contained in:
Alexandre
2025-08-01 22:45:40 +02:00
parent 2e29601a2e
commit cc1035d5fe
3 changed files with 229 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
immich_cuda/README.md
View File

@@ -1,13 +1,13 @@
# Home assistant add-on: immich # Home assistant add-on: Immich CUDA
⚠️ 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) ⚠️ 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)
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA) [![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_cuda%2Fconfig.json)
![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_cuda%2Fconfig.json)
![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_cuda%2Fconfig.json)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml) [![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
@@ -20,40 +20,92 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers) [![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers)
![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/immich/stats.png) ![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/immich_cuda/stats.png)
## About ## About
Web based files browser. Self-hosted photo and video backup solution directly from your mobile phone with CUDA hardware acceleration support. This is the CUDA-enabled variant of Immich that provides hardware acceleration for machine learning tasks using NVIDIA GPUs.
This addon is based on the [docker image](https://github.com/imagegenius/docker-immich) from imagegenius.
This addon is based on the [docker image](https://github.com/imagegenius/docker-immich) from imagegenius with CUDA support enabled for enhanced performance.
## Hardware Requirements
- **NVIDIA GPU**: Compatible NVIDIA graphics card with CUDA support
- **CUDA Drivers**: NVIDIA drivers must be properly installed on the host system
- **Architecture**: AMD64 only (CUDA support not available on ARM architectures)
## Configuration ## Configuration
Postgresql can be either internal or external 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 CUDA variant) |
| `MACHINE_LEARNING_WORKERS` | int | `1` | Number of ML workers (can be increased with CUDA) |
| `MACHINE_LEARNING_WORKER_TIMEOUT` | int | `120` | ML worker timeout (seconds) |
### Example Configuration
```yaml ```yaml
"PGID": "int", data_location: "/share/immich"
"PUID": "int", library_location: "/media/photos"
"TZ": "str?", TZ: "Europe/London"
"cifsdomain": "str?", localdisks: "sda1,sdb1"
"cifspassword": "str?", networkdisks: "//192.168.1.100/photos"
"cifsusername": "str?", cifsusername: "photouser"
"data_location": "str", cifspassword: "password123"
"localdisks": "str?", DB_HOSTNAME: "core-mariadb"
"networkdisks": "str?", DB_USERNAME: "immich"
"DB_HOSTNAME": "str?", DB_PASSWORD: "secure_password"
"DB_USERNAME": "str?", DB_DATABASE_NAME: "immich"
"DB_PORT": "int?", JWT_SECRET: "your-secret-key-here"
"DB_PASSWORD": "str?", DISABLE_MACHINE_LEARNING: false
"DB_DATABASE_NAME": "str?", MACHINE_LEARNING_WORKERS: 2
"JWT_SECRET": "str?" 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](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/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](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
## Installation ## Installation
The installation of this add-on is pretty straightforward and not different in The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on. comparison to installing any other Hass.io add-on.
**Prerequisites:**
- NVIDIA GPU with CUDA support
- NVIDIA drivers installed on the host system
- AMD64 architecture (ARM not supported)
**Steps:**
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance. 1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
1. Install this add-on. 1. Install this add-on.
1. Click the `Save` button to store your configuration. 1. Click the `Save` button to store your configuration.
@@ -61,6 +113,7 @@ comparison to installing any other Hass.io add-on.
1. Check the logs of the add-on to see if everything went well. 1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for for that. 1. 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 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 Beware to change the password BEFORE starting it ; it won't change afterwards
@@ -69,6 +122,3 @@ Beware to change the password BEFORE starting it ; it won't change afterwards
Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-immich/282108/3) Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-immich/282108/3)
[repository]: https://github.com/alexbelgium/hassio-addons [repository]: https://github.com/alexbelgium/hassio-addons
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg

103
immich_noml/README.md
View File

@@ -1,13 +1,13 @@
# Home assistant add-on: immich # Home assistant add-on: Immich without Machine Learning
⚠️ 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) ⚠️ 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)
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA) [![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_noml%2Fconfig.json)
![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_noml%2Fconfig.json)
![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_noml%2Fconfig.json)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml) [![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
@@ -20,40 +20,91 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers) [![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers)
![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/immich/stats.png) ![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/immich_noml/stats.png)
## About ## About
Web based files browser. Self-hosted photo and video backup solution directly from your mobile phone. This is the NoML (No Machine Learning) variant of Immich designed for systems without machine learning capabilities or users who prefer to disable ML features for performance or resource management reasons.
This addon is based on the [docker image](https://github.com/imagegenius/docker-immich) from imagegenius.
This addon is based on the [docker image](https://github.com/imagegenius/docker-immich) from imagegenius with machine learning components excluded to reduce resource consumption and improve compatibility with resource-constrained systems.
## Use Cases
The NoML variant is ideal for:
- **Resource-constrained systems**: Lower CPU and memory usage without ML overhead
- **Privacy-focused deployments**: No facial recognition or object detection processing
- **Simple photo storage**: Basic photo and video backup without advanced AI features
- **Legacy hardware**: Systems that struggle with machine learning workloads
- **Minimalist setups**: Users who prefer basic photo management without AI enhancements
## Configuration ## Configuration
Postgresql can be either internal or external 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 (recommended for NoML variant) |
| `MACHINE_LEARNING_WORKERS` | int | `1` | Number of ML workers (keep at 1 for NoML) |
| `MACHINE_LEARNING_WORKER_TIMEOUT` | int | `120` | ML worker timeout (seconds) |
### Example Configuration
```yaml ```yaml
"PGID": "int", data_location: "/share/immich"
"PUID": "int", library_location: "/media/photos"
"TZ": "str?", TZ: "Europe/London"
"cifsdomain": "str?", localdisks: "sda1,sdb1"
"cifspassword": "str?", networkdisks: "//192.168.1.100/photos"
"cifsusername": "str?", cifsusername: "photouser"
"data_location": "str", cifspassword: "password123"
"localdisks": "str?", DB_HOSTNAME: "core-mariadb"
"networkdisks": "str?", DB_USERNAME: "immich"
"DB_HOSTNAME": "str?", DB_PASSWORD: "secure_password"
"DB_USERNAME": "str?", DB_DATABASE_NAME: "immich"
"DB_PORT": "int?", JWT_SECRET: "your-secret-key-here"
"DB_PASSWORD": "str?", DISABLE_MACHINE_LEARNING: true
"DB_DATABASE_NAME": "str?", MACHINE_LEARNING_WORKERS: 1
"JWT_SECRET": "str?" MACHINE_LEARNING_WORKER_TIMEOUT: 120
``` ```
### Mounting Drives
This addon supports mounting both local drives and remote SMB shares:
- **Local drives**: See [Mounting Local Drives in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/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](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
## Installation ## Installation
The installation of this add-on is pretty straightforward and not different in The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on. comparison to installing any other Hass.io add-on.
**Steps:**
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance. 1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
1. Install this add-on. 1. Install this add-on.
1. Click the `Save` button to store your configuration. 1. Click the `Save` button to store your configuration.
@@ -61,6 +112,7 @@ comparison to installing any other Hass.io add-on.
1. Check the logs of the add-on to see if everything went well. 1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for for that. 1. 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 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 Beware to change the password BEFORE starting it ; it won't change afterwards
@@ -68,7 +120,4 @@ Beware to change the password BEFORE starting it ; it won't change afterwards
Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-immich/282108/3) Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-immich/282108/3)
[repository]: https://github.com/alexbelgium/hassio-addons [repository]: https://github.com/alexbelgium/hassio-addons
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg

103
immich_openvino/README.md
View File

@@ -1,13 +1,13 @@
# Home assistant add-on: immich # 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) ⚠️ 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)
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) [![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA) [![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_openvino%2Fconfig.json)
![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_openvino%2Fconfig.json)
![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich%2Fconfig.json) ![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fimmich_openvino%2Fconfig.json)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml) [![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
@@ -20,40 +20,93 @@ _Thanks to everyone having starred my repo! To star it click on the image below,
[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers) [![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers)
![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/immich/stats.png) ![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/immich_openvino/stats.png)
## About ## About
Web based files browser. 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](https://github.com/imagegenius/docker-immich) from imagegenius.
This addon is based on the [docker image](https://github.com/imagegenius/docker-immich) 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 ## Configuration
Postgresql can be either internal or external 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) |
### Example Configuration
```yaml ```yaml
"PGID": "int", data_location: "/share/immich"
"PUID": "int", library_location: "/media/photos"
"TZ": "str?", TZ: "Europe/London"
"cifsdomain": "str?", localdisks: "sda1,sdb1"
"cifspassword": "str?", networkdisks: "//192.168.1.100/photos"
"cifsusername": "str?", cifsusername: "photouser"
"data_location": "str", cifspassword: "password123"
"localdisks": "str?", DB_HOSTNAME: "core-mariadb"
"networkdisks": "str?", DB_USERNAME: "immich"
"DB_HOSTNAME": "str?", DB_PASSWORD: "secure_password"
"DB_USERNAME": "str?", DB_DATABASE_NAME: "immich"
"DB_PORT": "int?", JWT_SECRET: "your-secret-key-here"
"DB_PASSWORD": "str?", DISABLE_MACHINE_LEARNING: false
"DB_DATABASE_NAME": "str?", MACHINE_LEARNING_WORKERS: 2
"JWT_SECRET": "str?" 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](https://github.com/alexbelgium/hassio-addons/wiki/Mounting-Local-Drives-in-Addons)
- **Remote shares**: See [Mounting Remote Shares in Addons](https://github.com/alexbelgium/hassio-addons/wiki/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](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
- **Environment variables**: See [Add Environment Variables to your Addon](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon)
## Installation ## Installation
The installation of this add-on is pretty straightforward and not different in The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on. 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:**
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance. 1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
1. Install this add-on. 1. Install this add-on.
1. Click the `Save` button to store your configuration. 1. Click the `Save` button to store your configuration.
@@ -61,6 +114,7 @@ comparison to installing any other Hass.io add-on.
1. Check the logs of the add-on to see if everything went well. 1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for for that. 1. 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 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 Beware to change the password BEFORE starting it ; it won't change afterwards
@@ -69,6 +123,3 @@ Beware to change the password BEFORE starting it ; it won't change afterwards
Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-immich/282108/3) Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-immich/282108/3)
[repository]: https://github.com/alexbelgium/hassio-addons [repository]: https://github.com/alexbelgium/hassio-addons
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg