Burrow is an open source tool for burrowing through firewalls. https://burrow.net

Find a file

Kartikey S. Chauhan a97063f9b7 Initial website setup - Created project structure with necessary directories and files - Set up Next.js with Tailwind CSS and Font Awesome - Added base HTML structure and layout components - Configured routing and created the homepage - Styled the homepage with basic styling - Added FontAwesome icons - Configured font imports and styles - Integrated HackClub branding elements This commit establishes the foundation for our website, including the project structure, styling, and initial content.		2024-03-30 17:02:11 -07:00
.cargo	🔧 Add cargo release aliases	2023-06-10 22:01:17 +01:00
.github	Update release pipelines to upload release artifacts	2024-03-23 13:41:07 -07:00
.vscode	Simplified process startup on macOS and Linux	2024-01-27 07:53:30 -05:00
Apple	Update release pipelines to upload release artifacts	2024-03-23 13:41:07 -07:00
burrow	Add implementation for stop command	2024-02-25 04:14:32 +08:00
burrow-gtk	Implement launching a local daemon (#261 )	2024-03-09 17:52:59 -08:00
docs	Add ability to build GTK app AppImage (#240 )	2024-02-15 19:27:14 -08:00
package/rpm	Super Basic RPM Install Config	2023-10-07 23:37:44 -07:00
site	Initial website setup	2024-03-30 17:02:11 -07:00
systemd	Super Basic RPM Install Config	2023-10-07 23:37:44 -07:00
Tools	Update release pipelines to upload release artifacts	2024-03-23 13:41:07 -07:00
tun	Add Support for IPV6 and Arbitrary Server Address	2024-02-24 12:44:31 -05: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	Initialized burrow-gtk project	2023-11-18 12:42:52 -08:00
.gitlint	Ignore body is missing errors	2023-06-23 16:21:58 -04:00
.rustfmt.toml	Implement Wireguard	2023-12-23 11:26:05 -08:00
.swiftlint.yml	Introduce initial UI for connecting to networks	2024-03-10 18:59:31 -04:00
burrow-server-compose.yml	Add Support for IPV6 and Arbitrary Server Address	2024-02-24 12:44:31 -05:00
Cargo.lock	Add Support for IPV6 and Arbitrary Server Address	2024-02-24 12:44:31 -05:00
Cargo.toml	Implement Wireguard	2023-12-23 11:26:05 -08:00
Dockerfile	Add Support for IPV6 and Arbitrary Server Address	2024-02-24 12:44:31 -05:00
LICENSE.md	Create LICENSE.md	2023-04-18 21:56:01 -04:00
Makefile	Add implementation for stop command	2024-02-25 04:14:32 +08:00
README.md	Implement launching a local daemon (#261 )	2024-03-09 17:52:59 -08:00
server_patch.txt	Add Support for IPV6 and Arbitrary Server Address	2024-02-24 12:44:31 -05:00

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

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.

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