Repository navigation
burrow v1.1.3
A documentation release. The 500-line README is now a compact front page plus focused
guides. There are no behaviour changes; upgrading is optional.
Changed
- README is now a one-screen front page: what burrow is, the one-command install, a
diagram, everyday commands, features, and a map of the documentation. - New focused guides in
docs/, one per reader:USAGE.md: commands, sharing, revoking access, self-tests.CONFIGURATION.md: installer variables,.envsettings, your own decoy website.OPERATIONS.md: day-to-day tasks, reliability, measured performance and capacity,
troubleshooting.THREAT-MODEL.md: what burrow protects against, what it doesn't, privacy, host
hardening.DESIGN.md: how a connection is handled, and why these technologies.DEVELOPMENT.md: tests, CI, the release checklist, project layout.
- Capacity figures now come from a real benchmark of a 1 vCPU / 1 GB VPS: about 300
simultaneous users with normal use. - Cross-references now point at the new pages: the generated
.env,SECURITY.md,
CONTRIBUTING.mdand the deployment guide. The website gains a "Docs" link. burrow deploynow uploadsdocs/andCONTRIBUTING.mdtoo.