From c3b719f96d22d48d592f5520e823e228adbb281c Mon Sep 17 00:00:00 2001 From: George Harvey <11440490+HarvsG@users.noreply.github.com> Date: Tue, 6 Apr 2021 15:06:08 +0100 Subject: [PATCH] update readme to include new option --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e0f666..ca457d5 100644 --- a/README.md +++ b/README.md @@ -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