{"id":19030657,"url":"https://github.com/hackclub/burrow","last_synced_at":"2026-08-04T01:31:38.719Z","repository":{"id":152447510,"uuid":"625981092","full_name":"hackclub/burrow","owner":"hackclub","description":"Burrow is a tool for burrowing through firewalls, built by teenagers at Hack Club.","archived":false,"fork":false,"pushed_at":"2024-11-22T07:38:03.000Z","size":1627,"stargazers_count":120,"open_issues_count":6,"forks_count":17,"subscribers_count":95,"default_branch":"main","last_synced_at":"2025-02-14T05:10:03.886Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://burrow.rs","language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hackclub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-10T14:40:39.000Z","updated_at":"2025-01-31T05:00:37.000Z","dependencies_parsed_at":"2024-02-07T07:32:07.649Z","dependency_job_id":"994b6147-3024-4545-a97f-58a3d6a8f080","html_url":"https://github.com/hackclub/burrow","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Fburrow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Fburrow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Fburrow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackclub%2Fburrow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackclub","download_url":"https://codeload.github.com/hackclub/burrow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240079642,"owners_count":19744727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T21:18:59.653Z","updated_at":"2026-08-04T01:31:38.702Z","avatar_url":"https://github.com/hackclub.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Burrow\n\n![License](https://img.shields.io/github/license/hackclub/burrow) ![Apple Build Status](https://img.shields.io/github/actions/workflow/status/hackclub/burrow/build-apple.yml?branch=main\u0026label=macos%2C%20ios\u0026logo=Apple) ![Crate Build Status](https://img.shields.io/github/actions/workflow/status/hackclub/burrow/build-rust.yml?branch=main\u0026label=crate\u0026logo=Rust)\n\nBurrow is an open source tool for burrowing through firewalls, built by teenagers at [Hack Club](https://hackclub.com/).\n\n`burrow` provides a simple command-line tool to open virtual interfaces and direct traffic through them.\nRoutine verification now runs unprivileged with `cargo test --workspace --all-features`; only tunnel startup needs elevation.\n\nThe repository now carries its own design and deployment record:\n\n- [Constitution](./CONSTITUTION.md)\n- [Agent Instructions](./AGENTS.md)\n- [Burrow Evolution](./evolution/README.md)\n- [WireGuard Rust Lineage](./docs/WIREGUARD_LINEAGE.md)\n- [Protocol Roadmap](./docs/PROTOCOL_ROADMAP.md)\n- [Forward Email Runbook](./docs/FORWARDEMAIL.md)\n\n## Contributing\n\nBurrow 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).\n\nAgent 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).\n\nThe project structure is divided in the following folders: \n\n```\nApple/ # Xcode project for burrow on macOS and iOS\nburrow/ # Higher-level API library for tun and tun-async\nburrow-gtk/ # GTK project for burrow on Linux\ntun/ # Low-level interface to OS networking\n    src/\n        tokio/ # Async/Tokio code\n        unix/ # macOS and Linux code\n        windows/ # Windows networking code\n```\n\n## Installation \n\nTo start burrowing, download the latest release build in the release section. \n\n## Hack Club\n\nHack 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/).\n\n## License \n\nBurrow is open source and licensed under the [GNU General Public License v3.0](./LICENSE.md)\n\n## Contributors\n\n\u003ca href=\"https://github.com/hackclub/burrow/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=hackclub/burrow\" /\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackclub%2Fburrow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackclub%2Fburrow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackclub%2Fburrow/lists"}