Quick start
This is the fastest path from nothing to a running Openbeehive instance you can open in a browser. Pick one of two routes:
Single binary
The simplest way to run Openbeehive on your own machine is the single binary. In the selfhost profile, Openbeehive serves the web app and the API from one process, stores its data in a local SQLite file, and keeps uploaded photos on the filesystem. No Docker, no Postgres, no object store - just one executable.
Docker & Compose
Docker is the quickest way to run Openbeehive on a server. You can run the
Configuration
Openbeehive is configured entirely through environment variables. This page is the complete reference, grouped exactly as they appear in .env.example.
Databases
Openbeehive stores all of its server-side data in a relational database. The backend is database-agnostic: it speaks to a pluggable storage layer and ships drivers for SQLite, PostgreSQL and MySQL. You choose which one to use with two environment variables.
Blob storage
Openbeehive stores your records in a database, but photos and other binary
Authentication
Openbeehive lets you choose exactly how much authentication you need. A solo beekeeper running the single binary at home can skip login entirely. A shared instance can require passkeys, sign-in through an identity provider, or both.
Reverse proxy & TLS
Openbeehive listens on plain HTTP by default (on BEEHIVE_ADDR, typically :8080). For
Backups & restore
A few minutes spent setting up backups now will save you a great deal of worry later. This page covers what to back up, how to do it safely, and how to restore when you need to.
Upgrading
Keeping your Openbeehive instance current means new features, fixes and security patches. Upgrades are deliberately simple: replace the binary or pull a new image, restart, and the server brings your database up to date on its own.
Demo mode
Demo mode installs a ready-made demo account and tenant so visitors can try