# Inky Bird Frame

> Inky Bird Frame is a self-hosted, open-source project that turns bird observations into illustrated plates for color e-paper displays and a browser journal.

- **Category:** Photo Galleries
- **Licence:** MIT
- **Latest version:** v0.9.8
- **Open source:** oss
- **Languages:** Python
- **Platforms:** Docker Compose, Debian
- **Tags:** Raspberry Pi, Home Assistant, Self Hosted, E ink, Birdnet, E Paper, Birding, Field Journal, Inaturalist, Ebird, Birdbuddy, AI Generation, Inky Impression

## Description

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.

## Links

- [Homepage](https://github.com/veteranbv/inky-bird-frame)
- [Website](https://henrysowell.com/birds)
- [Docker](ghcr.io/veteranbv/inky-bird-frame)
- [GitHub Repository](https://github.com/veteranbv/inky-bird-frame)
- [Documentation: Hardware Guide](https://github.com/veteranbv/inky-bird-frame/blob/main/docs/hardware.md)
- [Documentation: Native Installation](https://github.com/veteranbv/inky-bird-frame/blob/main/docs/installation.md)
- [Documentation: Docker Controller](https://github.com/veteranbv/inky-bird-frame/blob/main/docs/docker.md)
- [Documentation: Discovery Sources](https://github.com/veteranbv/inky-bird-frame/blob/main/docs/discovery.md)
- [Documentation: Browser Journal](https://github.com/veteranbv/inky-bird-frame/blob/main/docs/journal.md)
- [Documentation: Notifications](https://github.com/veteranbv/inky-bird-frame/blob/main/docs/notifications.md)
- [Documentation: Architecture](https://github.com/veteranbv/inky-bird-frame/blob/main/docs/architecture.md)

---
Source: https://selfhost.directory/project/inky-bird-frame