Bield documentation
Start with the README for what Bield is and a two-minute quickstart. These pages go deeper. The website has a demo you can click through without installing anything.
Set up
Section titled “Set up”| Page | What’s in it |
|---|---|
| Installing Bield | The install script, release archives, and the options for each |
| Bield in Docker | Compose files, data, the Docker socket, measuring the host |
| Bield and Tailscale | Embedded and host mode, HTTPS, the tailnet policy, signing in, admins and viewers |
| Bield and Headscale | Running Bield against a Headscale server |
| Demo mode | A made-up tailnet to try Bield without one |
Use it
Section titled “Use it”| Page | What’s in it |
|---|---|
| A tour of Bield | What each page does |
| The agent | Per-machine metrics: what it sends, how to install, update, revoke and remove it |
| SSH access, terminals and files | Setting up Bield’s key or Tailscale SSH, the terminal, the file manager |
| Notifications | ntfy, Telegram, email, Discord, Slack and webhooks, and when they fire |
| Settings | Every setting on the Settings page, with defaults and limits |
Run it
Section titled “Run it”| Page | What’s in it |
|---|---|
| Configuration reference | Every flag and environment variable, the data directory |
| Upgrading, backups and rolling back | Upgrading, bield backup, restoring, going back a version |
| Uninstalling | Removing Bield, its node, its key and the agents |
| FAQ | Common questions and what to check when something doesn’t work |
| Benchmarks | What Bield costs with 200 devices and 90 days of history |
The threat model and how to report a vulnerability are in SECURITY.md. To work on Bield, see CONTRIBUTING.md.