README
¶
Backyard documentation
Backyard turns a folder of HTML into an internal URL with a zero-config backend. Start with the getting started guide; the design specification is the normative reference for every URL, wire format and default.
Use Backyard
| Guide | What it covers |
|---|---|
| Getting started | Install, run a local server, build and deploy a first site |
| Client API | backyard.db, files, ai, warehouse, socket, id at a glance |
| Realtime | Live queries, change feeds, rooms and presence, the websocket protocol |
| Deploying sites | Site previews on the hub, deploy methods, .backyardignore, ownership, owners-only site listing, CI, the Lambda gateway |
| CLI reference | Every backyard command and flag |
| Agents | Claude skill, Claude Code plugin, MCP server, init templates, /llms.txt |
| Claude connector | Publish from Claude, ChatGPT or another MCP app with the company sign-in: turning on the remote MCP connector, adding it in Claude, ChatGPT and other MCP apps, proxies, limits, disconnecting |
Run Backyard
| Guide | What it covers |
|---|---|
| Configuration | Every backyard.yaml key with type, default and description |
| Authentication | OIDC (Okta, Entra ID, Google…), IAP, ALB, header, Cloudflare Access, tokens, CLI login |
| Storage and databases | fs / S3 / GCS / Azure, SQLite / Postgres / DynamoDB, pub/sub |
| AI providers | Anthropic, OpenAI-compatible, Ollama, Azure OpenAI, Bedrock, Gemini / Vertex, aliases |
| Warehouse | BigQuery, Postgres / Redshift, Athena, named queries, read-only roles |
| Security | Threat model and hardening |
| Operations | Metrics, health checks, logs and audit, backups, scaling, upgrades |
| Cloudflare edition | Backyard on Cloudflare's free tier |
| Architecture | Components, request flow, data layout |
Deployment kits live next to the code: AWS, Google Cloud, Azure, Kubernetes (Helm), Docker Compose, systemd and Cloudflare.
Documentation
¶
Overview ¶
Package docs holds Backyard's user and operator documentation (Markdown, including the normative design specification in spec/SPEC.md). It has no code; its tests keep the documentation honest (CLAUDE.md, invariant 9):
- relative links in docs/ and the repository's top-level guides resolve to files that exist, and their #anchors to headings that exist;
- every `make <target>` the guides mention is a target of the Makefile;
- every key in configuration.md exists in the configuration schema (internal/config), and every key of the schema has a row there;
- every "SPEC §n" reference names a section the specification has;
- statements tied to code match it (contract_test.go): the key derivation labels of both editions, the site URL examples of SPEC §2, the limits where a negative value means unlimited, the quoted oidc host-mode configuration errors, the AI request limits, and the MCP tools and their parameters;
- and so do the statements about hardened behaviour (contract_hardening_test.go): the passive upload types of both editions (SPEC §3), the warehouse result cap, the realtime payload limit, the flags of the direct-sync commands, the files no ignore configuration can deploy, the login state cookie, and the Cloudflare edition's query page budget and Access bypass paths.
Source Files
Click to show internal directories.
Click to hide internal directories.