Repository navigation
burrow v1.1.0
A one-command installer, plus a hardening pass from a full security audit of the
code base. Upgrade by re-running the installer, or with git pull && ./burrow up, or by
re-running burrow deploy. Your secret is kept either way.
Added
install.sh: install on a server with one command, configured through
environment variables:
curl -fsSL https://raw.githubusercontent.com/deadboyccc/Burrow/main/install.sh | sudo BURROW_DOMAIN=notes.example.com bash
(orBURROW_COVER_DOMAIN=…for simple mode). It installs prerequisites, fetches the
pinned release, prepares the host, creates the secret, starts the proxy, runs the
smoke test and prints the links and QR code. Re-running it upgrades in place and keeps
the secret.BURROW_DRY_RUN=1previews every step.- Documented stealth mode without a domain: use your IP as a free wildcard-DNS name such as
203-0-113-7.sslip.io, and point links at the IP withLINK_HOST. You still get a real
certificate. Also documented the rules for custom decoy pages: CSS in files, because of
the strict Content-Security-Policy, and a404.html.
Security
install-host.shcould lock you out of SSH:sudodropsSSH_CONNECTION, so a
non-default SSH port was firewalled off. SSH now stays open on--ssh-portand on
every port sshd listens on. If none can be determined, the firewall is left off.burrow smoke --linktreats the server as hostile. Every probe has one overall time
budget (a server could stall it forever with drips or empty TLS records).
Server-supplied text is stripped of terminal escape sequences before printing.- Dotfiles in
site.local/(.git,.DS_Store, …) are no longer published or
uploaded, and Caddy hides dotfiles too. deployvalidates and quotes every value it sends to the server's root shell, and
requires non-interactive sudo up front.config showhides SOCKS credentials, link errors no longer echo the secret, and
Secretobjects keep the key out ofrepr().- Unattended upgrades now include Docker's packages (runc and containerd fixes).
Fixed
- Failures were reported as success. The command dispatcher switched off
set -efor
every command. For example,deployprinted "Deployed." after the server failed to
start. Errors now stop the command with a non-zero exit, anddeploystops at the
first failed step. - The running decoy kept serving a deleted copy of the site after a re-render (e.g. from
doctor, or a new year in the footer). The site is now synced in place, anddoctor
no longer re-renders under a running stack. config set DOMAIN …(or the mode) got stuck in a loop. The secret is now
regenerated.config setvalidates all pairs before writing, and refuses to create a
.env.uprefuses to adopt the containers of another burrow installation on the same host.install-host.shno longer aborts at the sysctl step on container VPSes (skipping the
firewall). It refreshes package lists before installing, writesdaemon.jsonbefore
Docker starts (solive-restoreapplies), and validates--dir.- The watchdog no longer restarts mtg when the probe tool itself failed, and is quiet on
servers without a.env. statusexits non-zero when the proxy is unhealthy. HTTP→HTTPS redirects keep a
non-443 proxy port, and the IPv6 overlay followsBIND_ADDR.- Validation covers every key in every mode. It also rejects
CONCURRENCYwith
leading zeros and malformed IPv6 addresses. - Probe verdicts are correct for resets after partial answers, partial TLS flights, HTTP
servers that keep the connection open, and non-ASCII status codes. Out-of-range
--port/--dcvalues are rejected, and the replay check reports "inconclusive"
instead of a false alarm. - A friendly error on bash < 4.4 (macOS's default bash). Host sysctl tuning no longer
lowersfs.file-max.
Changed
- Digby, the mascot, redrawn as a detailed dawn badge.