Environment Variables

Every field in the service's Go config struct tagged with env:"..." is parsed at runtime by the envdecode loader. The table below is regenerated whenever the service's config struct changes.

Environment variables for the immichframe service

Name	Introduction Version	Type	Description	Default Value
OC_URL IMMICHFRAME_OPENCLOUD_URL		string	Base URL of the OpenCloud instance (used for Graph API and WebDAV calls).	``
IMMICHFRAME_OPENCLOUD_SPACE_ID		string	OpenCloud space id to serve photos from. Provide this or IMMICHFRAME_OPENCLOUD_SPACE_NAME.	``
IMMICHFRAME_OPENCLOUD_SPACE_NAME		string	OpenCloud space name; used to resolve the space id when IMMICHFRAME_OPENCLOUD_SPACE_ID is empty.	``
IMMICHFRAME_OPENCLOUD_USERNAME		string	Username for app-password authentication.	``
IMMICHFRAME_OPENCLOUD_APP_PASSWORD		string	App password for the given username.	``
IMMICHFRAME_OPENCLOUD_BEARER_TOKEN		string	Bearer token for authentication; takes precedence over username/app-password.	``
OC_INSECURE IMMICHFRAME_OPENCLOUD_INSECURE		bool	Skip TLS verification when talking to OpenCloud (self-signed certs in dev).	false
IMMICHFRAME_HTTP_ADDR		string	Bind address of the frame HTTP service.	:8080
IMMICHFRAME_AUTH_SECRET		string	Shared secret clients must send as 'Authorization: Bearer <secret>'. Empty runs the API open.	``
IMMICHFRAME_CATALOG_REFRESH		Duration	How often the photo catalog is refreshed (Go duration, e.g. 5m).	5m0s
IMMICHFRAME_WEB_ROOT		string	Directory with the built ImmichFrame web UI to serve at /. Empty serves the API only.	``
IMMICHFRAME_INTERVAL		int	Seconds each image is shown.	8
IMMICHFRAME_TRANSITION_DURATION		float64	Crossfade duration in seconds.	1
IMMICHFRAME_SHOW_CLOCK		bool	Show the clock overlay.	true
IMMICHFRAME_CLOCK_FORMAT		string	Clock time format (date-fns tokens).	HH:mm
IMMICHFRAME_CLOCK_DATE_FORMAT		string	Clock date format (date-fns tokens).	eee, MMM d
IMMICHFRAME_SHOW_PROGRESS_BAR		bool	Show the slideshow progress bar.	true
IMMICHFRAME_SHOW_PHOTO_DATE		bool	Show the photo date overlay.	true
IMMICHFRAME_PHOTO_DATE_FORMAT		string	Photo date format (Go layout; formatted server-side).	2006-01-02
IMMICHFRAME_SHOW_IMAGE_LOCATION		bool	Show the image location overlay (no EXIF/GPS in OpenCloud yet).	false
IMMICHFRAME_IMAGE_LOCATION_FORMAT		string	Image location format string.	City,State,Country
IMMICHFRAME_SHOW_IMAGE_DESC		bool	Show the image description overlay.	false
IMMICHFRAME_SHOW_ALBUM_NAME		bool	Show the album name overlay (album = the image's folder).	true
IMMICHFRAME_LANGUAGE		string	UI language code.	en