Immich Photos Album plugin - Photo frame from a local Immich Photos album

[Shadal18]

Here’s an InkyPi plugin that turns an album from your self-hosted Immich server into a configurable photo frame.

Repository

• GitHub repository:
  https://github.com/shadal18/inkypi-immich-photos-album

Install

You can install it using the InkyPi plugin installer:

inkypi plugin install immich_photos_album https://github.com/shadal18/inkypi-immich-photos-album

Features

• Displays photos from a selected Immich album
• Connects directly to a self-hosted Immich server
• Uses an Immich API key stored in InkyPi’s API Keys page
• Random photo selection
• Newest photo selection
• Oldest photo selection
• Ignores video assets and uses images only
• Fill-screen image mode with cropping when needed
• Full-image contain mode with letterboxing when needed
• White or black background option
• Optional caption bar
• Caption modes for album name, filename, date, or asset ID
• Optional border with configurable thickness
• Optional auto contrast for improved e-paper readability
• Supports horizontal and vertical display orientation
• Configurable network timeout

Details

The plugin connects to your Immich server, reads the selected album, finds its image assets, chooses a photo according to your configured selection mode, and downloads it for display on InkyPi.

It is designed as a self-hosted alternative to cloud photo-frame plugins, using your own Immich server and your own photo library. The API key is stored in InkyPi’s API Keys page instead of the plugin settings.

Settings

The settings page lets you configure:

• Immich server URL
• Immich album ID
• Photo selection mode
• Network timeout
• Image fit mode
• Background color
• Show or hide caption bar
• Caption content mode
• Show or hide border
• Border size
• Auto contrast on or off

Setup

1. Create an API key in Immich with access to albums and image assets.
2. In InkyPi, open the API Keys page using the key icon.
3. Add your Immich API key with the name:

   IMMICH_API_KEY
   

4. Open the Immich album you want to use and copy its UUID from the end of the browser URL.
5. Add the Immich Photos Album plugin in InkyPi.
6. Enter your Immich server URL and album ID in the plugin settings.
7. Save, then update the display or add the plugin to a playlist.

Notes

• Your InkyPi device must be able to reach the Immich server URL.
• Use your LAN URL or hostname, not localhost, unless Immich runs on the same Raspberry Pi.
• The plugin only displays image assets; videos are ignored.
• Very large albums may take longer to load.
• Random selection can occasionally repeat an image on later refreshes.
• The Immich API key belongs in InkyPi’s API Keys list as IMMICH_API_KEY, not in the plugin settings.

Screenshots

• Immich Photos Album Plugin
• Settings