https://github.com/hackclub/burrow
Burrow is a tool for burrowing through firewalls, built by teenagers at Hack Club.
https://github.com/hackclub/burrow
Last synced: 6 days ago
JSON representation
Burrow is a tool for burrowing through firewalls, built by teenagers at Hack Club.
- Host: GitHub
- URL: https://github.com/hackclub/burrow
- Owner: hackclub
- License: gpl-3.0
- Created: 2023-04-10T14:40:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T07:38:03.000Z (over 1 year ago)
- Last Synced: 2025-02-14T05:10:03.886Z (over 1 year ago)
- Language: Rust
- Homepage: https://burrow.rs
- Size: 1.55 MB
- Stars: 120
- Watchers: 95
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Burrow
  
Burrow is an open source tool for burrowing through firewalls, built by teenagers at [Hack Club](https://hackclub.com/).
`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:
- [Constitution](./CONSTITUTION.md)
- [Agent Instructions](./AGENTS.md)
- [Burrow Evolution](./evolution/README.md)
- [WireGuard Rust Lineage](./docs/WIREGUARD_LINEAGE.md)
- [Protocol Roadmap](./docs/PROTOCOL_ROADMAP.md)
- [Forward Email Runbook](./docs/FORWARDEMAIL.md)
## 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](https://hackclub.com/slack/), here you can ask for help and talk with other people interested in burrow. Checkout [GETTING_STARTED.md](./docs/GETTING_STARTED.md) for build instructions and [GTK_APP.md](./docs/GTK_APP.md) for the Linux app. Forge and deployment scaffolding live in [`flake.nix`](./flake.nix), [`nixos/`](./nixos), and [`.forgejo/workflows/`](./.forgejo/workflows/). Hosted mail backup operations live in [`docs/FORWARDEMAIL.md`](./docs/FORWARDEMAIL.md) and [`Tools/forwardemail-custom-s3.sh`](./Tools/forwardemail-custom-s3.sh).
Agent and governance-sensitive work should start with [AGENTS.md](./AGENTS.md), [CONSTITUTION.md](./CONSTITUTION.md), and the relevant BEPs under [`evolution/proposals/`](./evolution/proposals/). Identity and bootstrap metadata now live in [`contributors.nix`](./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](https://hackclub.com/).
## License
Burrow is open source and licensed under the [GNU General Public License v3.0](./LICENSE.md)
## Contributors
