Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/finzzz/wgzero
Zero overhead wireguard setup
https://github.com/finzzz/wgzero
Last synced: about 2 months ago
JSON representation
Zero overhead wireguard setup
- Host: GitHub
- URL: https://github.com/finzzz/wgzero
- Owner: finzzz
- Archived: true
- Created: 2021-03-15T14:59:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-15T12:16:47.000Z (over 2 years ago)
- Last Synced: 2024-06-15T02:33:43.906Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 771 KB
- Stars: 49
- Watchers: 5
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-wireguard - wgzero - Zero overhead wireguard setup. (Projects / Tools)
README
# WGZero
CLI based wireguard server manager. Tested on Debian Bullseye.
## Features
- Plain IPv4 installation
- Multi interfaces support
- IPv6
- NAT
- Full routing
- Import & uninstall
- Easy backup
## Requirements
### Packages
[wireguard](https://www.wireguard.com/install/) curl qrencode iptables jq bsdmainutils
### IPv6
If you need IPv6, please make sure you can access internet using ipv6 before proceeding.
There are 2 types of connection:
#### NAT
- Internal IPv6 communication uses ULA (Unique Local Address).
- Prioritize on using public IPv6 (shared with all clients) and fallback to IPv4 when not available.
see image
#### Full Routing
- Assign unique public IPv6 to each clients.
- You need to have an IPv6 address and a block of /64 IPv6 addresses.
- IPv6 address should be assigned to main interface and /64 is reserved for wireguard
- If you only get /64 from VPS provider, you need to split it into smaller blocks and install ndppd (see [example](docs/fr.md))
- If you don't have it, you can get free IPv6 from [Tunnelbroker](https://tunnelbroker.net/) (see [example](docs/tunnelbroker.md))
see image
## Installation
```bash
curl -o /usr/local/bin/wgzero https://raw.githubusercontent.com/finzzz/wgzero/master/wgzero
chmod +x /usr/local/bin/wgzero
wgzero install
```
### Example Installation
- [Plain IPv4](docs/v4.md)
- [NAT](docs/nat.md)
- Full Routing
- [only has /64 block](docs/fr.md)
- [Tunnerbroker](docs/tunnelbroker.md)
## Backup and restore
Backup is simple, just save `/etc/wireguard/.conf`. All of the data including clients are stored in that file.
To restore, simply run `wgzero import .conf` on new host.
## Other Commands
```
wgzero install
wgzero uninstall
wgzero import wg0.conf
# default wg0
wgzero list
wgzero show clientname
wgzero qr clientname
wgzero enable clientname
wgzero disable clientname
wgzero del clientname
```
## [FAQ and Troubleshooting](docs/faq.md)