Home assistant add-on: Immich Frame

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

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	Required	URL of your Immich server (e.g., `http://homeassistant:3001`)
`ApiKey`	str	Required	Immich API key for authentication
`TZ`	str		Timezone (e.g., `Europe/London`)

Example Configuration

ImmichServerUrl: "http://homeassistant:3001"
ApiKey: "your-immich-api-key-here"
TZ: "Europe/London"

Getting Your Immich API Key

Open your Immich web interface
Go to Administration > API Keys
Click Create API Key
Give it a descriptive name (e.g., "Photo Frame")
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
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.

Add my Hass.io add-ons repository to your Hass.io instance.
Install this add-on.
Configure your Immich server URL and API key.
Click the Save button to store your configuration.
Start the add-on.
Check the logs of the add-on to see if everything went well.
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/

4.6 KiB Raw Blame History