ApiaryLens documentation
Find the answer.
Get back to your bees.
Guides for beekeepers, family operators, self-hosters, developers, and contributors—all generated from the public source of truth.
Understand the product, the first release, and what you can do today.
Explore →Use and operateInstall, secure, back up, update, restore, and troubleshoot your deployment.
Explore →ArchitectureExplore the portable API, data model, synchronization, identity, media, and deployment decisions.
Explore →ContributeSet up the project, follow accepted decisions, and help improve ApiaryLens.
Explore →Browse all documentation
Accepted ApiaryLens needs one coherent open source product codebase, separately deployed public websites, a hosted demo and possible future SaaS application, developer resources, and private internal operations. Only the
adrADR 0002: Domain StrategyAccepted ApiaryLens owns: apiarylens.org apiarylens.com apiarylens.app apiarylens.dev The project is open source and self hosted first, but it should preserve room for public documentation, developer resources, a future
adrADR 0003: Open Source and Self-Hosted FirstAccepted 2026 07 15 2026 07 15 Kristopher Turner, project owner ApiaryLens is intended for beekeepers ranging from one person or a family with a few hives through clubs, research teams, and commercial operations. A beeke
adrADR 0004: Lucidchart Diagram StandardAccepted ApiaryLens needs consistent, editable architecture diagrams and flowcharts across the open source product, public properties, private operations, and future hosted environments. The diagrams must be centrally or
adrADR 0005: Activate the Initial Repository PortfolioAccepted 2026 07 15 ADR 0001 defines separate repositories for the open source product, private operations, public project website, hosted application property, developer portal, and organization wide GitHub configuratio
adrADR 0006: Cloudflare Hosting for Public FrontendsAccepted 2026 07 15 ApiaryLens has three public frontend properties and one redirecting domain: apiarylens.org for the public project and documentation experience apiarylens.app for the public synthetic demo and a possib
adrADR 0007: Deployment Profile PriorityAccepted 2026 07 15 Approved by Kristopher Turner, project owner, on 2026 07 15. ApiaryLens must give a family or hobbyist beekeeper an always available, synchronized application at zero or predictably near zero cost whi
adrADR 0008: MVP Application PlatformAccepted 2026 07 15 Accepted under the project owner's authorization to complete remaining design and implementation after accepting ADR 0003 and the MVP contract. ApiaryLens needs one small, understandable codebase that
adrADR 0009: Data, Media, and Offline SynchronizationAccepted 2026 07 15 Accepted under the project owner's delegated MVP implementation authority. The PWA must accept complete field work with no network, preserve it across a page reload or device restart, and later synchr
adrADR 0010: Built-in Identity, Sessions, and AuthorizationAccepted 2026 07 15 Accepted under the project owner's delegated MVP implementation authority. A family must be able to secure an internet reachable deployment without buying or operating an identity provider, email serv
adrADR 0011: Scout Bee and Deployment ExecutionAccepted 2026 07 15 Accepted under the project owner's delegated MVP implementation authority. Scout Bee must make deployment understandable to a beekeeper while remaining useful to an advanced operator. Its MVP must dep
adrADR 0012: Public Frontend Implementation ConventionAccepted — 2026 07 15 ADR 0006 requires the official .org , .app , and .dev properties to deploy independently through Cloudflare Workers Static Assets while preserving the portable application and backend. Task 009 requ
adrADR 0013: Keyless Release SigningAccepted 2026 07 15 Accepted under the project owner's delegated MVP implementation authority. The MVP requires signed deployment bundles, Scout Bee executables, supply chain evidence, and provenance. A long lived mainta
deploymentAir-gap bundle: offline install and transported updatesApiaryLens supports Compose deployments on hosts with zero outbound network . Each release publishes an offline deployment bundle, apiarylens <version airgap <sha12 .tar , containing the prebuilt product images, the comp
operatorAir-gap install and transported updateTested against apiarylens 0.1.0 preview.6 airgap b07141c0b494.tar from the published v0.1.0 preview.6 release on 2026 07 19, end to end on a pristine reference host: Ubuntu 24.04.4 LTS x86 64, Docker Engine 29.6.2 with t
architectureAPI ContractApiaryLens exposes a same origin REST API under /api/v1 and publishes an OpenAPI 3.1 document generated from the shared runtime schemas. Every response includes the product build identity and compatible API, synchronizat
projectApiaryLensApiaryLens is an open source, self hosted apiary intelligence and hive management platform for beekeepers — from a single backyard hive to a commercial apiary operation. This repository is the public product monorepo. Th
releasesApiaryLens 0.1.0 Preview 1ApiaryLens Preview 1 is the current Public Preview . It is intended for families, hobbyists, mentors, and operators who want to evaluate the product and help shape what comes next. It is not GA or a stable release. Featu
brandApiaryLens Brand and Asset SystemThe MVP brand system is implemented and approved for the current Public Preview properties. The public source of truth includes the logo mark, browser/PWA icon sizes, family to professional hero, product graphics, Lucidc
diagramsApiaryLens DiagramsLucidchart is the authoritative diagram and flowchart system for ApiaryLens. See . All editable diagrams live in the dedicated Lucid folder named ApiaryLens , created on 2026 07 15. The connected Lucid MCP is used for do
roadmapApiaryLens Execution PlanActive Public Preview 1 delivery sequence. Preview 1 is not GA or a stable release: features and workflows may change, updates may arrive frequently (sometimes multiple times per day), and preview users must keep backups
architectureApiaryLens Feature InventoryThis file captures the product requirements discussed in the chat. This is a full roadmap inventory, not the MVP scope. The accepted authoritative MVP boundary is . Items listed here do not become MVP requirements unless
productApiaryLens Marketing OverviewStatus: Public Preview 1 product messaging Last reviewed: 2026 07 17 Tagline: Know every hive. Empower every beekeeper. ApiaryLens is an open source apiary intelligence and hive management application for people who keep
productApiaryLens MVP Definition and UAT ContractStatus: Accepted Date: 2026 07 15 Decider: Kristopher Turner, project owner Accepted: 2026 07 15 This document is the authoritative ApiaryLens MVP scope. The remains the broader roadmap inventory and must not be interpre
operatorApiaryLens Operations GuideThe MVP supports the Cloudflare family profile and Docker Compose on personally controlled Linux hardware. The same Compose bundle is the supported cloud VM path. Scout Bee is coming soon. Every operation below has a dir
releasesApiaryLens Preview 1 (build 0.1.0-preview.5)Release date: 2026 07 18 Superseded by build , which ships as ApiaryLens Preview 1 under the same public name. This build's air gap bundle cannot be installed on hosts whose Docker Engine uses the containerd image store
releasesApiaryLens Preview 1 (build 0.1.0-preview.6)Release date: 2026 07 18 Preview 1 is the first public preview of the rebooted ApiaryLens product: the platform core plus the web client/PWA as the primary product surface. This build, 0.1.0 preview.6 , is a corrective r
releasesApiaryLens Preview 2 (build 0.1.0-preview.4)Release date: 2026 07 18 Superseded by build , published as ApiaryLens Preview 1 of the rebooted platform+web product. This build's GitHub release has been retitled "Superseded internal build — do not use", and it does n
productApiaryLens Product BriefApiaryLens is an open source, self hosted, offline first apiary intelligence and hive management platform. It begins with a family or hobbyist managing a small number of hives and is designed to grow into mentor, bee clu
productApiaryLens Product Capability OverviewStatus: Living product overview Last reviewed: 2026 07 15 ApiaryLens is an open source, self hosted, offline first apiary intelligence and hive management platform. It is intended to help beekeepers understand and act on
productApiaryLens Product Overview and Capability WhitepaperStatus: Public Preview 1 product narrative. For the concise audience facing version, see the . ApiaryLens is an open source apiary intelligence platform for beekeepers. Public Preview 1 tracks apiaries, hives, queens, eq
roadmapApiaryLens RoadmapApiaryLens is in Public Preview 1, not GA. The PWA and supported Cloudflare and Docker Compose deployment paths are available for real world evaluation. Preview features and workflows may change, with updates sometimes a
userApiaryLens User GuideApiaryLens keeps family apiary records available across phones, tablets, and computers while remaining usable when the yard has no signal. Your deployment operator gives you the HTTPS address and, for the first owner onl
securityAuthentication, Authorization, and SharingCurrent MVP architecture. ADR 0010 accepts the built in account, session, organization authorization, and recovery design. Optional OIDC, passkeys, public links, and native client authorization remain later decisions. Au
userBeekeeping glossaryApiaryLens uses ordinary beekeeping language and keeps regional variation visible. This glossary explains the words used in records and forms; it is not a substitute for local training, an experienced mentor, or veterina
releasesChangelogContinued separately versioned Scout Bee deployment bootloader work. It is not currently an end user release. Corrective build that ships as ApiaryLens Preview 1 under the same public name, superseding build 0.1.0 previe
deploymentCloud VM Docker ComposeApiaryLens uses one provider neutral Docker Compose release on Azure, Amazon Web Services (AWS), Google Cloud Platform (GCP), a local VM, or personally controlled hardware. The provider supplies only the Linux VM, networ
architectureCommunity Galleries and RegistriesFuture architectural consideration. This document does not approve a specific gallery, registry, marketplace, feature, or repository. ApiaryLens may eventually let people publish, discover, install, import, or share reus
projectContributing to ApiaryLensThanks for helping build ApiaryLens. The public monorepo contains the PWA, Node and Cloudflare backends, shared contracts and database code, Docker Compose deployment, tests, product release tooling, and authoritative do
projectContributor Covenant Code of ConductWe as members, contributors, and leaders pledge to make participation in the ApiaryLens community a harassment free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex c
operatorDeployment guide matrix — with and without Scout BeeEvery supported way to run ApiaryLens is documented twice : once for Scout Bee, the guided lifecycle companion, and once as a fully manual procedure that never requires Scout. Both columns are first class — Scout automat
deploymentDeployment StrategyApiaryLens must be easy for a family or hobbyist to start while remaining portable, self hosted, and scalable. Deployment tiers use the same core product and data formats; they are not separate editions. The primary fami
README.mddocs/Project documentation, handoff material, architecture notes, and Architecture Decision Records (ADRs) for ApiaryLens. Start with the Master Architecture and Design Plan in the ApiaryLens design record (private; see ). It
strategyDomain StrategyApiaryLens owns: apiarylens.org apiarylens.com apiarylens.app apiarylens.dev The authoritative domain assignment is . The assembled product and repository context is maintained in the Master Architecture and Design Plan,
architectureInstallation and Deployment ExperienceCurrent MVP architecture. ADRs 0008 through 0011 select the application, storage, identity, synchronization, and Scout Bee design. Profile measurements, packaging, network/TLS proof, and deployment UAT remain release gat
productIntelligent field auditApiaryLens uses controlled choices when the domain is finite and a suggestion plus custom value escape hatch when beekeeping practices, products, regulations, units, or local terminology vary. Required status, role, sync
operatorManual Compose install — no Scout BeeTested against apiarylens 0.1.0 preview.5 compose 97e5ce858208.tar.gz from the published v0.1.0 preview.5 release on 2026 07 19. The published artifact's byte count and SHA 256 were verified against the release manifest
architectureMedia and AI ReviewPhotos and videos are core ApiaryLens data. Brood frame photos Queen photos Queen cell photos Mite board photos Hive entrance photos Pest/disease photos Honey frame photos Harvest photos Weather damage photos Inspection
deploymentMigration and Compatibility GuideEvery migration is evaluated against the product version, API contract, synchronization contract, database migration head, local store version, deployment plan schema, and export/backup format in the release manifest. Mi
architectureMVP Data ModelThis document defines the current logical model implemented by both D1 and Compose. The migration SQL and generated schema documentation become authoritative at build time; this narrative explains ownership, lifecycle, a
architectureOffline Synchronization ProtocolThe HTTP API uses /api/v1 . Sync messages include syncContractVersion , currently 1 . Client local schema, server migration, export, deployment plan, and product versions are independently visible in the release manifest
diagramsOperational Architecture and JourneysThe editable sources for this seven page set are the cataloged Lucidchart documents in the dedicated ApiaryLens folder. Four pages remain in document 72787958 9344 4a71 af56 98a216b35aa1 ; the final polish component and
architectureRepository StrategyGitHub organization folder: text D:\git\apiarylens Repository portfolio: text D:\git\apiarylens\apiarylens D:\git\apiarylens\scout bee D:\git\apiarylens\apiarylens ops D:\git\apiarylens\apiarylens.org D:\git\apiarylens\a
userScout Bee installation and operations guideScout Bee is the separately versioned ApiaryLens deployment bootloader. It is designed to deploy and manage the backend and optional web frontend in Cloudflare or on a Linux computer over SSH. Windows users will be able
deploymentScout Bee Installer and Lifecycle DesignThis is the accepted design baseline for Scout Bee. The repository split is accepted by ADR 0014, part of the ApiaryLens design record (private, see ). The executor security boundary in still applies. The repository tran
securitySecurity ArchitectureCurrent security architecture and mandatory outcomes. ADR 0010 selects the MVP identity/session boundary. Threat modeling, the ASVS verification matrix, runtime measurements, and supply chain evidence remain release gate
projectSecurity PolicyPlease do not open a public GitHub issue for security vulnerabilities. Instead, use GitHub's private vulnerability reporting for this repository: 1. Go to the Security tab of this repository. 2. Click Report a vulnerabil
troubleshooting.mdTroubleshootingConfirm the device itself has connectivity. Continue recording work if needed; the pending count should increase. When connectivity returns, choose Sync now . Do not clear site data. If work remains pending, save diagnos
releasesVerify an ApiaryLens ReleaseDownload an artifact from the matching release page, verify its SHA 256 against the release manifest, and then verify the repository attestation: powershell Get FileHash .\apiarylens 0.1.0 preview.1 compose a21796d1cb07.
architectureVersioning, Release, and Update LifecycleAccepted and implemented MVP architecture. The required user outcomes and release gates are part of the accepted . Release manifests, content addressed bundles, contract and migration identity, keyless attestations, back
architectureWeather and Bloom IntelligenceApiaryLens should connect hive behavior to local environment. Track historical: Temperature high/low Rainfall Humidity Wind Frost dates Heat waves Cold snaps Storms Drought Correlate weather with: Inspection timing Honey
diagramsWindows Client and Scout Bee ArchitectureThis page is the accessible companion to the seven page authoritative Lucidchart document ApiaryLens Windows and Scout Architecture . The diagrams describe the approved planning and research baseline. Implementation is i