| .cargo | ||
| .forgejo/workflows | ||
| .github | ||
| .vscode | ||
| Apple | ||
| burrow | ||
| burrow-gtk | ||
| docs | ||
| evolution | ||
| nixos | ||
| package/rpm | ||
| proto | ||
| Scripts | ||
| secrets | ||
| services/forgejo-nsc | ||
| site | ||
| systemd | ||
| Tools | ||
| tun | ||
| .devcontainer.json | ||
| .dockerignore | ||
| .gitignore | ||
| .gitlint | ||
| .rustfmt.toml | ||
| .swiftlint.yml | ||
| burrow-server-compose.yml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CONSTITUTION.md | ||
| Dockerfile | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE.md | ||
| Makefile | ||
| README.md | ||
| rust-toolchain.toml | ||
| secrets.nix | ||
| server_patch.txt | ||
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 now runs unprivileged with cargo test --workspace --all-features; only tunnel startup needs elevation.
The repository now carries its own design and deployment record:
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.
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