mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-03-24 06:51:31 +01:00
dcb1a08a8f
- Add Accounts list schema to config.yaml for multi-account support - Make ApiKey and ImmichServerUrl optional when using Accounts list - Generate Settings.yaml from addon options in 99-run.sh - Fix /app/Config symlink direction for proper config persistence - Set IMMICHFRAME_CONFIG_PATH for reliable config discovery - Update README with multi-account documentation and examples - Bump version to 1.0.32.0-2 Co-authored-by: alexbelgium <44178713+alexbelgium@users.noreply.github.com>
111 lines
6.3 KiB
Markdown
111 lines
6.3 KiB
Markdown
# Home assistant add-on: Immich Frame
|
|
|
|
|
|
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!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](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)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
[Immich Frame](https://immichframe.online/) displays your Immich gallery as a digital photo frame. Transform any screen into a beautiful, rotating display of your personal photos and memories stored in Immich.
|
|
|
|
This addon allows you to create a digital photo frame that connects to your Immich server and displays your photos in a slideshow format, perfect for repurposing old tablets or monitors as dedicated photo displays.
|
|
|
|
## Configuration
|
|
|
|
Webui can be found at `<your-ip>:8171`.
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `ImmichServerUrl` | str | | URL of your Immich server (e.g., `http://homeassistant:3001`). Used for single-account setup. |
|
|
| `ApiKey` | str | | Immich API key for authentication. Used for single-account setup. |
|
|
| `Accounts` | list | `[]` | List of Immich accounts for multi-account support. Each entry requires `ImmichServerUrl` and `ApiKey`. |
|
|
| `TZ` | str | | Timezone (e.g., `Europe/London`) |
|
|
|
|
### Single Account Example
|
|
|
|
```yaml
|
|
ImmichServerUrl: "http://homeassistant:3001"
|
|
ApiKey: "your-immich-api-key-here"
|
|
TZ: "Europe/London"
|
|
```
|
|
|
|
### Multi-Account Example
|
|
|
|
To display photos from multiple Immich accounts (e.g., you and your partner), use the `Accounts` list:
|
|
|
|
```yaml
|
|
Accounts:
|
|
- ImmichServerUrl: "http://homeassistant:3001"
|
|
ApiKey: "api-key-for-user-1"
|
|
- ImmichServerUrl: "http://homeassistant:3001"
|
|
ApiKey: "api-key-for-user-2"
|
|
TZ: "Europe/London"
|
|
```
|
|
|
|
When using the `Accounts` list, the `ApiKey` and `ImmichServerUrl` top-level options are not needed. Images will be drawn from each account proportionally based on the total number of images present in each account.
|
|
|
|
For more configuration options, see the [ImmichFrame documentation](https://immichframe.dev/docs/getting-started/configuration).
|
|
|
|
### Getting Your Immich API Key
|
|
|
|
1. Open your Immich web interface
|
|
2. Go to **Administration** > **API Keys**
|
|
3. Click **Create API Key**
|
|
4. Give it a descriptive name (e.g., "Photo Frame")
|
|
5. Copy the generated API key and paste it in the addon configuration
|
|
|
|
### 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)
|
|
- **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)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Configure your Immich server URL and API key.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Open the webUI to configure your photo frame settings.
|
|
|
|
## Support
|
|
|
|
Create an issue on github, or ask on the [home assistant community forum](https://community.home-assistant.io/)
|
|
|
|
For more information about Immich Frame, visit: https://immichframe.online/
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|