add README

This commit is contained in:
Jordan Whited 2020-05-20 20:08:46 -07:00
parent 4880884e1b
commit 24a9e67e0d

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# wgsd
`wgsd` is a CoreDNS plugin that provides Wireguard peer information via DNS-SD semantics. See [this blog post](https://www.jordanwhited.com/posts/wireguard-nat-traversal/) for the background and reasoning behind it.
In order to use this plugin with CoreDNS first you need to [enable it](https://coredns.io/2017/07/25/compile-time-enabling-or-disabling-plugins/). Once it's enabled it can be configured like so:
```
.:53 {
wgsd <zone> <wg device>
}
```
For example:
```
$ cat Corefile
.:53 {
wgsd jordanwhited.net. utun4
}
```