From 6bb19aedf694fbd9a5427110c0c6f4cf87708609 Mon Sep 17 00:00:00 2001 From: Jordan Whited Date: Tue, 26 May 2020 14:45:31 -0700 Subject: [PATCH] add wgsd-client README --- cmd/wgsd-client/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 cmd/wgsd-client/README.md diff --git a/cmd/wgsd-client/README.md b/cmd/wgsd-client/README.md new file mode 100644 index 0000000..6d4f718 --- /dev/null +++ b/cmd/wgsd-client/README.md @@ -0,0 +1,13 @@ +# wgsd-client +`wgsd-client` is responsible for keeping peer endpoint configuration up to date. It retrieves the list of configured peers, queries `wgsd` for matching public keys, and then sets the endpoint value for each peer if needed. This client is intended to be run periodically via cron or similar scheduling mechanism. It checks all peers once in a serialized fashion and then exits. + +``` +% ./wgsd-client --help +Usage of ./wgsd-client: + -device string + name of Wireguard device to manage + -dns string + ip:port of DNS server + -zone string + dns zone name +``` \ No newline at end of file