github/jwhited-wgsd
1
0
Fork 0
mirror of https://github.com/jwhited/wgsd.git synced 2025-04-25 13:29:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme to include new option

Browse Source
This commit is contained in:
George Harvey 2021-04-06 15:06:08 +01:00 committed by GitHub
parent 05890efee9
commit c3b719f96d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -40,11 +40,12 @@ wgsd ZONE DEVICE
```
wgsd ZONE DEVICE {
self [ ENDPOINT ] [ ALLOWED-IPS ... ]
only-propagate-subnets self [ ENDPOINT ] [ ALLOWED-IPS ... ]
}
```
* Supplying the `self` option enables serving data about the local WireGuard device in addition to its peers. The optional `ENDPOINT` argument enables setting a custom endpoint in ip:port form. If `ENDPOINT` is omitted wgsd will default to the local IP address for the DNS query and `ListenPort` of the WireGuard device. This can be useful if your host is behind NAT. The optional, variadic `ALLOWED-IPS` argument sets allowed-ips to be served for the local WireGuard device.
* Supplying the optional `only-propagate-subnets` will mean that the registry will only respond to querries with peers that have more than one address listed in their `AllowedIPs`. For example it would responds with peers containing `AllowedIPs=192.168.10.0/24` or `AllowedIPs=192.168.10.2/32, 192.168.10.11/32` but not a peer with `AllowedIPs=192.168.20.1/32`
## Querying