selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

Inky Bird Frame logo

Self-host Inky Bird Frame

v0.9.8

Bird sightings become reviewed field-journal plates

BetaOpen SourceMIT
Updated10 hours ago
LanguagePython
Setup difficultyAdvanced
MobileResponsive
Stars
202
Port
8793 (controller HTTP server for browser journal, catalog, and display node API)
Docker
ghcr.io/veteranbv/inky-bird-frame
Install with Docker Compose
Finished portrait installation with Eastern Bluebird plate in 12x16 inch bronze frameBrowser journal Home view showing approved American Robin plate with Saved selection labelCompact Homepage service card showing catalog readiness, active birds, approved plates, controller versionHomepage featured-plate card with catalog stats and upright Eastern Bluebird platePushover notifications for recovered generation queue and approved American Goldfinch plate

What is Inky Bird Frame?

Inky Bird Frame helps birders keep birding present between outings by turning nearby observations, personal eBird history, acoustic detections, and smart-feeder postcards into reviewed, reusable field-journal plates. The system has two roles: a controller that discovers birds, generates plates using AI (Codex), and runs independent factual and visual reviews; and a lightweight display node that pulls approved plates and rotates them on a color e-paper frame. The controller also serves a browser-based journal at /app for managing favorites, trip collections, and source connections. It runs on Docker (AMD64/ARM64 images from GitHub Container Registry) or natively on macOS, Ubuntu, or Raspberry Pi OS with Python 3.11+. All observation history and credentials stay private on the controller; approved plates are location-neutral and reusable across installations. Integrations include iNaturalist, eBird (public and archive), BirdWeather, self-hosted BirdNET-Go, BirdNET Analyzer CSV imports, and Bird Buddy. Optional notifications via Apprise (Pushover, Discord, ntfy, Gotify, Slack, email, Home Assistant). Home Assistant and Homepage dashboard cards are supported. Authentication uses local username/password with optional HTTPS and Authentik OIDC. The project is pre-1.0 (development candidate) with MIT license.

Should you self-host Inky Bird Frame?

Inky Bird Frame scores 46/100 on selfhost.directory (how scoring works) and ranks #14 of 19 in Photo Galleries. It has 202 GitHub stars.

It shipped 10 stable releases in the past year. The latest, v0.9.8, came out on 22 October 2026. New versions land roughly every 2 days.

Setup is advanced: plan for several services and some ongoing maintenance. An official Docker image is available. It is MIT-licensed and written mostly in Python.

Its closest alternative on selfhost.directory is Immich (93/100, 117 490 stars). It scores higher overall, so compare the two before you pick. See Inky Bird Frame vs Immich side by side.

Features

  • AI generation with independent review
  • Authentik OIDC authentication
  • Browser journal
  • Docker and native installation
  • E-paper display node
  • Field-journal plates
  • Home Assistant Integration
  • Homepage dashboard cards
  • Multi-source bird discovery
  • Notifications
  • Private by design
  • Public plate catalog

Inky Bird Frame README

How to install Inky Bird Frame

Install Inky Bird Frame with Docker Compose

The normal Docker path pulls a published image from GitHub Container Registry. It does not build the project from source. Images are available for AMD64 and ARM64 hosts.

Compose starts four services from the same image:

Service Job Credentials
config-sync Validates the host config.toml, installs a private runtime copy, then exits Configuration file and referenced environment values
bootstrap Copies the included public bird catalog into persistent storage, then exits None
controller Serves the browser journal, paired screens, health and approved art on port 8793; runs explicit browser actions Private owner hashes, configured provider/destination credentials, optional identity-service client secret
scheduler Refreshes observations and runs generation, notifications, and optional catalog publication Codex and any configured service credentials

Display node runs natively on Raspberry Pi (needs direct hardware access)

Inky Bird Frame releases & version history

More in Photo Galleries

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…