{"id":13587622,"url":"https://github.com/klutchell/balena-wireguard","last_synced_at":"2025-03-18T14:30:41.368Z","repository":{"id":38444081,"uuid":"278918726","full_name":"klutchell/balena-wireguard","owner":"klutchell","description":"wireguard stack for balenacloud","archived":true,"fork":false,"pushed_at":"2024-09-09T13:17:40.000Z","size":361,"stargazers_count":22,"open_issues_count":3,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-14T20:55:11.011Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klutchell.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-11T18:22:34.000Z","updated_at":"2025-03-03T17:59:27.000Z","dependencies_parsed_at":"2023-12-01T00:24:58.514Z","dependency_job_id":"586497cf-35ed-4aa8-8384-bf733d3ccada","html_url":"https://github.com/klutchell/balena-wireguard","commit_stats":null,"previous_names":[],"tags_count":74,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klutchell%2Fbalena-wireguard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klutchell%2Fbalena-wireguard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klutchell%2Fbalena-wireguard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klutchell%2Fbalena-wireguard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klutchell","download_url":"https://codeload.github.com/klutchell/balena-wireguard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243933378,"owners_count":20370989,"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-08-01T15:06:17.473Z","updated_at":"2025-03-18T14:30:41.028Z","avatar_url":"https://github.com/klutchell.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# balena-wireguard\n\n[WireGuard®](https://www.wireguard.com/) is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography.\n\n## Getting Started\n\nYou can one-click-deploy this project to balena using the button below:\n\n[![Deploy with balena](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/klutchell/balena-wireguard)\n\n## Manual Deployment\n\nAlternatively, deployment can be carried out by manually creating a [balenaCloud account](https://dashboard.balena-cloud.com) and application,\nflashing a device, downloading the project and pushing it via the [balena CLI](https://github.com/balena-io/balena-cli).\n\n### Environment Variables\n\n| Name          | Description                                                                                                                                                                                                                                                                                                                                |\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `SERVER_HOST` | External IP or domain name for docker host. Used in server mode. If set to `auto` the container will try to determine and set the external IP automatically.                                                                                                                                                                               |\n| `SERVER_PORT` | External port for docker host. Defaults to `51820`.                                                                                                                                                                                                                                                                                        |\n| `PEERS`       | Number of peers to create confs for. Can be a number like `4` or a list of names such as `myPC,myPhone,myTablet`.                                                                                                                                                                                                                          |\n| `PEER_DNS`    | DNS server set in peer/client configs. Defaults to `1.1.1.1`.                                                                                                                                                                                                                                                                              |\n| `CIDR`        | Internal network CIDR for the wireguard and server and peers. Defaults to `10.13.13.0/24`.                                                                                                                                                                                                                                                 |\n| `ALLOWEDIPS`  | The IPs/Ranges that the peers will be able to reach using the VPN connection. If not specified the default value is `0.0.0.0/0, ::0/0`. This will cause ALL traffic to route through the VPN, if you want split tunneling, set this to only the IPs you would like to use the tunnel AND the ip of the server's WG ip, such as 10.13.13.1. |\n\n## Usage/Examples\n\nOnce your device joins the fleet you'll need to allow some time for it to download the application and start the services.\n\nWhen it's done you can display QR codes for each peer by running `show-peer \u003cpeer\u003e` in the container shell.\n\nFor example, the following CLI command will show the QR code for `myPhone`:\n\n`echo \"show-peer myPhone; exit;\" | balena ssh \u003cUUID\u003e wireguard`\n\nAdditional usage instructions for wireguard can be found here: \u003chttps://www.wireguard.com/\u003e\n\n## Contributing\n\nPlease open an issue or submit a pull request with any features, fixes, or changes.\n\n## Acknowledgements\n\n- \u003chttps://www.balena.io/blog/how-to-run-wireguard-vpn-in-balenaos/\u003e\n- \u003chttps://www.wireguard.com/compilation/\u003e\n- \u003chttps://github.com/linuxserver/docker-wireguard\u003e\n- \u003chttps://github.com/balena-os/kernel-module-build\u003e\n- \u003chttps://github.com/jaredallard-home/wireguard-balena-rpi\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklutchell%2Fbalena-wireguard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklutchell%2Fbalena-wireguard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklutchell%2Fbalena-wireguard/lists"}