- Rust 74.4%
- Swift 7.1%
- Python 6%
- Shell 5.9%
- Go 2.3%
- Other 4.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .cargo | ||
| .forgejo | ||
| .github | ||
| .vscode | ||
| Android | ||
| Apple | ||
| bazel | ||
| burrow | ||
| burrow-gtk | ||
| crates | ||
| deploy | ||
| design/brand | ||
| docs | ||
| evolution | ||
| infra | ||
| nixos | ||
| package | ||
| patches | ||
| proto | ||
| Scripts | ||
| secrets | ||
| services | ||
| site | ||
| store-metadata | ||
| systemd | ||
| third_party | ||
| Tools | ||
| tun | ||
| .bazelignore | ||
| .bazelversion | ||
| .devcontainer.json | ||
| .dockerignore | ||
| .gitignore | ||
| .gitlint | ||
| .rustfmt.toml | ||
| .swiftlint.yml | ||
| AGENTS.md | ||
| BUILD.bazel | ||
| burrow-server-compose.yml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CONSTITUTION.md | ||
| contributors.nix | ||
| design-qa.md | ||
| Dockerfile | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE.md | ||
| Makefile | ||
| MODULE.bazel | ||
| MODULE.bazel.lock | ||
| README.md | ||
| rust-toolchain.toml | ||
| secrets.nix | ||
| server_patch.txt | ||
| THIRD_PARTY_NOTICES.md | ||
Burrow
Burrow is an open source tool for burrowing through firewalls, built by teenagers at Hack Club.
burrow provides a simple command-line tool to open virtual interfaces and direct traffic through them.
Routine verification runs unprivileged with the product and evidence feature lanes in .forgejo/workflows/build-rust.yml; only tunnel startup needs elevation. The live-evidence and product-authority features are deliberately incompatible and must be tested separately.
Enable RUSTFLAGS="--cfg tokio_unstable" when testing the optional tokio-console instrumentation feature.
The canonical source forge is git.burrow.net/hackclub/burrow.
The repository now carries its own design and deployment record:
- Constitution
- Agent Instructions
- Burrow Evolution
- WireGuard Rust Lineage
- Protocol Roadmap
- Forward Email Runbook
Contributing
Burrow is fully open source, you can fork the repo and start contributing easily. For more information and in-depth discussions, visit the #burrow channel on the Hack Club Slack, here you can ask for help and talk with other people interested in burrow. Checkout GETTING_STARTED.md for build instructions and GTK_APP.md for the Linux app. Forge and deployment scaffolding live in flake.nix, nixos/, and .forgejo/workflows/. Hosted mail backup operations live in docs/FORWARDEMAIL.md and Tools/forwardemail-custom-s3.sh. Platform service and distribution rollout notes live in docs/PLATFORM_SERVICES.md and docs/DISTRIBUTION.md.
Agent and governance-sensitive work should start with AGENTS.md, CONSTITUTION.md, and the relevant BEPs under evolution/proposals/. Identity and bootstrap metadata now live in contributors.nix.
The project structure is divided in the following folders:
Apple/ # Xcode project for burrow on macOS and iOS
burrow/ # Higher-level API library for tun and tun-async
burrow-gtk/ # GTK project for burrow on Linux
tun/ # Low-level interface to OS networking
src/
tokio/ # Async/Tokio code
unix/ # macOS and Linux code
windows/ # Windows networking code
Installation
To start burrowing, download the latest release build in the release section.
Hack Club
Hack Club is a global community of high-school hackers from all around the world! Start your own Hack Club, attend an upcoming hackathon or join our online community at hackclub.com.
License
Burrow is open source and licensed under the GNU General Public License v3.0
Contributors
See the canonical forge history for current contributors.