github/jwhited-wgsd
1
0
Fork 0
mirror of https://github.com/jwhited/wgsd.git synced 2025-01-18 13:59:34 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

add wgsd-client README

Browse Source
This commit is contained in:
Jordan Whited 2020-05-26 14:45:31 -07:00
parent 7d513c4d71
commit 6bb19aedf6
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
cmd/wgsd-client/README.md Normal file
View File

@ -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
```