avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-03-17 02:08:19 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
54c7a2ba1085a787d4d1e944a9967c39b26f3d30
hassio-addons/immich_frame
History

README.md

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 Donate via PayPal

Addon informations

Version Ingress Arch

Codacy Badge GitHub Super-Linter Builder

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

Stargazers repo roster for @alexbelgium/hassio-addons

downloads evolution

About

Immich Frame 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

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:

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.

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:

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) Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.
  2. Install this add-on.
  3. Configure your Immich server URL and API key.
  4. Click the Save button to store your configuration.
  5. Start the add-on.
  6. Check the logs of the add-on to see if everything went well.
  7. Open the webUI to configure your photo frame settings.

Support

Create an issue on github, or ask on the home assistant community forum

For more information about Immich Frame, visit: https://immichframe.online/