{"id":27549033,"url":"https://github.com/fosrl/newt","last_synced_at":"2026-05-08T03:16:51.065Z","repository":{"id":271049805,"uuid":"863835490","full_name":"fosrl/newt","owner":"fosrl","description":"Pangolin tunneled site \u0026 network connector","archived":false,"fork":false,"pushed_at":"2026-01-16T06:00:05.000Z","size":14192,"stargazers_count":666,"open_issues_count":29,"forks_count":60,"subscribers_count":6,"default_branch":"main","last_synced_at":"2026-01-16T21:21:29.363Z","etag":null,"topics":["hacktoberfest","overlay-network","tunnel-client","userspace-networking","vpn","wireguard"],"latest_commit_sha":null,"homepage":"https://docs.pangolin.net","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fosrl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-09-27T02:17:01.000Z","updated_at":"2026-01-16T18:56:31.000Z","dependencies_parsed_at":"2025-01-28T03:23:37.873Z","dependency_job_id":null,"html_url":"https://github.com/fosrl/newt","commit_stats":null,"previous_names":["fosrl/newt"],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/fosrl/newt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fosrl%2Fnewt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fosrl%2Fnewt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fosrl%2Fnewt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fosrl%2Fnewt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fosrl","download_url":"https://codeload.github.com/fosrl/newt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fosrl%2Fnewt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28699372,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T17:25:48.045Z","status":"ssl_error","status_checked_at":"2026-01-23T17:25:47.153Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["hacktoberfest","overlay-network","tunnel-client","userspace-networking","vpn","wireguard"],"created_at":"2025-04-19T04:32:37.221Z","updated_at":"2026-01-23T20:07:27.237Z","avatar_url":"https://github.com/fosrl.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Newt\n[![PkgGoDev](https://pkg.go.dev/badge/github.com/fosrl/newt)](https://pkg.go.dev/github.com/fosrl/newt)\n[![GitHub License](https://img.shields.io/github/license/fosrl/newt)](https://github.com/fosrl/newt/blob/main/LICENSE)\n[![Go Report Card](https://goreportcard.com/badge/github.com/fosrl/newt)](https://goreportcard.com/report/github.com/fosrl/newt)\n\nNewt is a fully user space [WireGuard](https://www.wireguard.com/) tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing.\n\n### Installation and Documentation\n\nNewt is used with Pangolin and Gerbil as part of the larger system. See documentation below:\n\n-   [Full Documentation](https://docs.pangolin.net/manage/sites/understanding-sites)\n\n## Key Functions\n\n### Registers with Pangolin\n\nUsing the Newt ID and a secret, the client will make HTTP requests to Pangolin to receive a session token. Using that token, it will connect to a websocket and maintain that connection. Control messages will be sent over the websocket.\n\n### Receives WireGuard Control Messages\n\nWhen Newt receives WireGuard control messages, it will use the information encoded (endpoint, public key) to bring up a WireGuard tunnel using [netstack](https://github.com/WireGuard/wireguard-go/blob/master/tun/netstack/examples/http_server.go) fully in user space. It will ping over the tunnel to ensure the peer on the Gerbil side is brought up.\n\n### Receives Proxy Control Messages\n\nWhen Newt receives WireGuard control messages, it will use the information encoded to create a local low level TCP and UDP proxies attached to the virtual tunnel in order to relay traffic to programmed targets.\n\n## Build\n\n### Binary\n\nMake sure to have Go 1.25 installed.\n\n```bash\nmake\n```\n\n### Nix Flake\n\n```bash\nnix build\n```\n\nBinary will be at `./result/bin/newt`\n\nDevelopment shell available with `nix develop`\n\n## Licensing\n\nNewt is dual licensed under the AGPLv3 and the Fossorial Commercial license. For inquiries about commercial licensing, please contact us.\n\n## Contributions\n\nPlease see [CONTRIBUTIONS](./CONTRIBUTING.md) in the repository for guidelines and best practices.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffosrl%2Fnewt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffosrl%2Fnewt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffosrl%2Fnewt/lists"}