hackclub/burrow
1
0
Fork 0
Code Pull requests Releases Packages Activity Actions 4
Burrow is an open source tool for burrowing through firewalls. https://burrow.net
80 commits 40 branches 10 tags 3 MiB
Find a file
dav 60cfd95789 Add rust build caching to ci
2023-08-26 12:23:41 -07:00
.cargo 🔧 Add cargo release aliases 2023-06-10 22:01:17 +01:00
.github Add rust build caching to ci 2023-08-26 12:23:41 -07:00
.vscode Run tests on Github Actions 2023-08-08 08:03:15 -07:00
Apple Add C Swift Bindings 2023-08-16 13:28:20 -04:00
burrow Implement sending commands via Unix sockets 2023-08-26 11:51:56 -07:00
docs Update Getting Started document 2023-06-03 13:00:06 -04:00
systemd Implement sending commands via Unix sockets 2023-08-26 11:51:56 -07:00
tun Implement sending commands via Unix sockets 2023-08-26 11:51:56 -07:00
.devcontainer.json Initial commit 2023-04-10 16:49:23 -04:00
.dockerignore Create Dockerfile 2023-07-04 20:15:27 -04:00
.gitignore Initial commit 2023-04-10 16:49:23 -04:00
.gitlint Ignore body is missing errors 2023-06-23 16:21:58 -04:00
.swiftlint.yml Initial commit 2023-04-10 16:49:23 -04:00
Cargo.lock Implement sending commands via Unix sockets 2023-08-26 11:51:56 -07:00
Cargo.toml Add Read and Write for Async TunInterface 2023-07-03 09:30:52 -04:00
Dockerfile Create Dockerfile 2023-07-04 20:15:27 -04:00
LICENSE.md Create LICENSE.md 2023-04-18 21:56:01 -04:00
README.md Update project structure in readme 2023-08-16 13:41:21 -04:00

README.md

Burrow

License Apple Build Status Crate Build Status

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.

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! For more information on how to contribute, please see [CONTRIBUTING.md]

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
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