mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-10 09:51:02 +01:00
Claudify
This commit is contained in:
Alexandre
@@ -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)
|
||||
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[](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)
|
||||
[](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,
|
||||
|
||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||
|
||||
|
||||
|
||||
|
||||
## About
|
||||
|
||||
Web based files browser.
|
||||
This addon is based on the [docker image](https://github.com/imagegenius/docker-immich) from imagegenius.
|
||||
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 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
|
||||
|
||||
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
|
||||
"PGID": "int",
|
||||
"PUID": "int",
|
||||
"TZ": "str?",
|
||||
"cifsdomain": "str?",
|
||||
"cifspassword": "str?",
|
||||
"cifsusername": "str?",
|
||||
"data_location": "str",
|
||||
"localdisks": "str?",
|
||||
"networkdisks": "str?",
|
||||
"DB_HOSTNAME": "str?",
|
||||
"DB_USERNAME": "str?",
|
||||
"DB_PORT": "int?",
|
||||
"DB_PASSWORD": "str?",
|
||||
"DB_DATABASE_NAME": "str?",
|
||||
"JWT_SECRET": "str?"
|
||||
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: true
|
||||
MACHINE_LEARNING_WORKERS: 1
|
||||
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
|
||||
|
||||
The installation of this add-on is pretty straightforward and not different in
|
||||
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. Install this add-on.
|
||||
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. 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
|
||||
|
||||
@@ -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)
|
||||
|
||||
[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
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
Reference in New Issue
Block a user