ApiaryLensOpen Source Apiary Intelligence

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.

Start with ApiaryLens

Understand the product, the first release, and what you can do today.

Explore →
Use and operate

Install, secure, back up, update, restore, and troubleshoot your deployment.

Explore →
Architecture

Explore the portable API, data model, synchronization, identity, media, and deployment decisions.

Explore →
Contribute

Set up the project, follow accepted decisions, and help improve ApiaryLens.

Explore →

Browse all documentation

testingAccessibility Audit: ApiaryLens MVP Release Candidate

Standard: WCAG 2.1 AA Date: 2026 07 15 Build: 0.1.0 rc.1 Automated axe core scans found zero WCAG 2.1 A/AA violations on the .org home and documentation hub, .app entry, isolated PWA demo, .dev home, and API reference. T

adrADR 0001: Core Monorepo with Separate Properties and Operations

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 Strategy

Accepted 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 First

Accepted 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 Standard

Accepted 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 Portfolio

Accepted 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 Frontends

Accepted 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 hosted PWA, demo, and possible fut

adrADR 0007: Deployment Profile Priority

Accepted 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 Platform

Accepted 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 Synchronization

Accepted 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 Authorization

Accepted 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 Execution

Accepted 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 Convention

Accepted — 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

architectureAPI Contract

ApiaryLens 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

projectApiaryLens

ApiaryLens 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-rc.1

This is a release candidate for MVP acceptance, not a stable release. It is intended for controlled UAT while deployment, recovery, accessibility, supply chain, and diagram gates are completed. Installable offline capabl

brandApiaryLens Brand and Asset System

Initial architecture direction. The visual identity, trademark treatment, asset license, final formats, and publishing automation still require design and review. Approved ApiaryLens brand assets, usage guidance, licensi

diagramsApiaryLens Diagrams

Lucidchart 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 Plan

Active portfolio delivery sequence. The remains authoritative for product architecture; this document controls the order in which the portfolio moves from foundation through release. Documentation reconciliation: complet

architectureApiaryLens Feature Inventory

This 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 Overview

Status: Pre release messaging draft Last reviewed: 2026 07 15 Working tagline: Know every hive. Empower every beekeeper. ApiaryLens is a planned apiary intelligence and hive management application for people who keep bee

architectureApiaryLens Master Architecture and Design Plan

Status: Living master plan Last updated: 2026 07 15 This is the authoritative entry point for ApiaryLens product architecture and design. It records the current system shape, accepted decisions, active direction, open qu

productApiaryLens MVP Definition and UAT Contract

Status: 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

testingApiaryLens MVP UAT Record

This is the executable acceptance record for the critical journey in . A checked item requires recorded evidence from the named release and profile; implementation or unit tests alone do not satisfy it. Product: ApiaryLe

operatorApiaryLens Operations Guide

The 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 optional: every operation below also has a d

productApiaryLens Product Brief

ApiaryLens 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 Overview

Status: 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 Whitepaper

Status: Pre release product narrative. For the concise audience facing version, see the . ApiaryLens is a planned open source apiary intelligence platform for beekeepers. It is being designed to track hives, queens, insp

roadmapApiaryLens Roadmap

The initial go to market user is a family or hobbyist beekeeper. The default journey must be easy to start, update, back up, restore, and understand without requiring container, database, DNS, TLS, identity provider, or

userApiaryLens User Guide

ApiaryLens 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

researchApplication Platform and Storage Research Spike

Decision evidence complete on 2026 07 15. Runtime measurements are updated in this document as the implementation passes its Cloudflare and Compose acceptance tests. Which small, open source application and storage desig

researchArchitecture Research

Use this folder for time boxed research spikes that reduce uncertainty before an architecture or design decision. A spike should record: The question and why it matters Constraints and success criteria Options investigat

securityAuthentication, Authorization, and Sharing

Current 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

releasesChangelog

Initial ApiaryLens MVP release candidate. See the , the , and the . Stable release notes will list only capabilities that pass the binding UAT contract.

researchCloud Free-Tier Deployment Spike

Initial research completed 2026 07 15. Revalidate before selecting or publishing a provider specific deployment because offers and limits change. Can the Cloudflare first family profile support the near free synchronized

architectureCommunity Galleries and Registries

Future 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 ApiaryLens

Thanks for your interest in ApiaryLens. The project is in its earliest scaffold stage — there is no application code yet, so most contributions right now will be about direction , not feature code. This repo currently co

projectContributor Covenant Code of Conduct

We 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

deploymentDeployment Strategy

ApiaryLens 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

testingDeployment, PWA, and Cost Test Strategy

Prove that ApiaryLens is easy, reliable, portable, and affordable for a family while remaining suitable for self hosted and larger deployments. Account names, credentials, private resource names, and maintainer specific

README.mddocs/

Project documentation, handoff material, architecture notes, and Architecture Decision Records (ADRs) for ApiaryLens. Start with the . It is the authoritative assembled view of the current architecture, accepted decision

strategyDomain Strategy

ApiaryLens owns: apiarylens.org apiarylens.com apiarylens.app apiarylens.dev The authoritative domain assignment is . The assembled product and repository context is maintained in the . Domain Durable purpose apiarylens.

researchIdentity, Offline, and Deployment Research Spike

Architecture decision evidence complete on 2026 07 15. Abuse, performance, and recovery measurements remain release gates and are recorded by automated tests and the MVP evidence report. Can a family use secure accounts

architectureInstallation and Deployment Experience

Current 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

architectureMedia and AI Review

Photos 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 Guide

Every 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 Model

This 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

testingMVP Release Gate Checklist

Release: 0.1.0 rc.1 Date: 2026 07 15 Status: Not yet releasable [x] Workspace format, type checks, unit tests, Go tests, builds, and local backup/restore verification pass. [x] Cloudflare Worker and all three public prop

securityMVP Threat Model and ASVS Verification Map

Release scope: ApiaryLens 0.1.0 rc.1 Review date: 2026 07 15 Standard: OWASP Application Security Verification Standard 5.0.0 Status: Engineering verification complete; independent/manual release review pending This docu

architectureOffline Synchronization Protocol

The 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 Journeys

The editable source for this seven page set is Lucidchart document 72787958 9344 4a71 af56 98a216b35aa1 . The descriptions below are the accessible text alternative and define the intended reading order. Family devices i

architectureRepository Strategy

GitHub organization folder: text D:\git\apiarylens Repository portfolio: text D:\git\apiarylens\apiarylens D:\git\apiarylens\apiarylens ops D:\git\apiarylens\apiarylens.org D:\git\apiarylens\apiarylens.app D:\git\apiaryl

deploymentScout Bee Deployment Design

Scout Bee is ApiaryLens's guided deployment and update application. Its default language is for beekeepers; its exported plan and logs are precise enough for an operator or CI system. Component Responsibility React UI Qu

securitySecurity Architecture

Current 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 Policy

Please 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.mdTroubleshooting

Confirm 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

architectureVersioning, Release, and Update Lifecycle

Proposed MVP architecture direction. The required user outcomes and release gates are part of the proposed . Exact release automation, migration tooling, artifact signing, and Scout Bee implementation require research an

architectureWeather and Bloom Intelligence

ApiaryLens 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