immichFrame

immichFrame

Official

Docker app from janmer's Repository

Overview

immichFrame is a digital photo frame application that interfaces with your immich server. This project is not affiliated with immich!

Requirements

This container requires an configuration to access your instance of immich. See here: https://github.com/immichFrame/ImmichFrame#settingsjson

Runtime arguments

Web UI
http://[IP]:[PORT:8080]
Network
bridge
Shell
sh
Privileged
false

Template configuration

WebUIPorttcp

WebUI Port

Target
8080
Value
8080
immichFrame ConfigPathrw

LEAVE EMPTY IF YOU ARE USING THE OTHER VARIABLES - immichFrame Config-Folder, should contain a Settings.json, more informations here: https://github.com/immichFrame/ImmichFrame#settingsjson

Target
/app/Config
ImmichServerUrlVariable

The URL of your Immich server e.g. https://photos.yourdomain.com or http://192.168.0.100:2283

ApiKeyVariable

Your immich API-Key (https://immich.app/docs/features/command-line-interface/#obtain-the-api-key)

AlbumsVariable

immich album UUIDs, comma ',' separated

ExcludedAlbumsVariable

UUID of excluded album(s)

PeopleVariable

UUID of person(s)

ShowMemoriesVariable

If this is set, memories are displayed.

Default
true|false
Value
false
ImagesFromDaysVariable

Show images from the last X days. e.g 365 -> show images from the last year.

ImagesFromDateVariable

Show images after date. Overwrites the ImagesFromDays-Setting

ImagesUntilDateVariable

Show images before date.

ImageZoomVariable

Zooms into or out of an image and gives it a touch of life.

Default
true|false
Value
false
Interval (seconds)Variable

Image interval in seconds. How long a image is displayed in the frame.

Target
Interval
Value
40
TransitionDuration (seconds)Variable

Duration in seconds.

Target
TransitionDuration
Value
2
WeatherApiKeyVariable

Get api-key: OpenWeatherMap (https://openweathermap.org/).

UnitSystemVariable

Imperial or metric system. (Fahrenheit or degrees)

Default
imperial|metric
Value
metric
LanguageVariable

2 digit ISO code, sets the language of the weather description.

Value
en
ShowWeatherDescriptionVariable

Displays the description of the current weather.

Default
true|false
Value
true
WeatherLatLongVariable

Set the weather location with lat/lon.

ShowClockVariable

Displays the current time.

Default
true|false
Value
true
ClockFormatVariable

Time format.

Value
HH:mm
WebcalendarsVariable

A list of webcalendar URIs in the .ics format. e.g. https://calendar.google.com/calendar/ical/XXXXXX/public/basic.ics

ShowImageDescVariable

Displays the description of the current image.

Default
true|false
Value
true
ShowPeopleDescVariable

Displays a comma separated list of names of all the people that are assigned in immich.

Default
true|false
Value
true
ShowImageLocationVariable

Displays the location of the current image.

Default
true|false
Value
true
ImageLocationFormatVariable
Value
City,State,Country
ShowPhotoDateVariable

Displays the date of the current image.

Default
true|false
Value
true
PhotoDateFormatVariable

Date format. See https://date-fns.org/v4.1.0/docs/format for more information.

Default
dd.MM.yyyy
PrimaryColorVariable

Lets you choose a primary color for your UI. Use hex with alpha value to edit opacity.

SecondaryColorVariable

Lets you choose a secondary color for your UI. (Only used with style=solid or transition) Use hex with alpha value to edit opacity.

StyleVariable

Background-style of the clock and metadata.

Default
none|solid|transition|blur
Value
solid
LayoutVariable

Allow two portrait images to be displayed next to each other

Default
single|splitview
Value
splitview
BaseFontSizeVariable

Sets the base font size, uses standard CSS formats (https://developer.mozilla.org/en-US/docs/Web/CSS/font-size).

Details

Repository
ghcr.io/immichframe/immichframe:latest
Last Updated2026-05-31
First Seen2024-10-06

Run immichFrame on Unraid.

immichFrame is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.