Repository navigation
Home
ant1fr edited this page Nov 18, 2026
·
2 revisions
Technical documentation for Smart Frame Engine: the self-hosted service that turns your Immich photos, movie posters and album covers into pictures a Fraimic / Spectra 6 e-ink frame can show beautifully.
New here? The project README gets you running in three minutes. This wiki is the reference for everything after that.
| Page | What is in it |
|---|---|
| Installation and Deployment | Docker Compose, Synology NAS, Portainer, reverse proxy and ROOT_PATH, host vs bridge networking, all environment variables |
| Configuration Reference | Every setting with its default, Smart Mix, Random Discovery, Family Mode, ambient context, Spectra 6 dithering and the quality gate |
| Immich and TMDB Setup | API keys, album and people pickers, Immich 3.x metadata search, the Locked Folder rule, TMDB posters |
| API Reference | Authentication (API key and session), every REST endpoint, /api/context examples |
| Home Assistant Integration | REST commands and automations, Zeroconf discovery, the dedicated integration (planned) |
Also: Roadmap · Issues · Discussions
The live, always up-to-date API reference is served by your own instance at
/docs.