diff --git a/README.md b/README.md new file mode 100644 index 0000000..b1b06c5 --- /dev/null +++ b/README.md @@ -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 +} +``` + +For example: +``` +$ cat Corefile +.:53 { + wgsd jordanwhited.net. utun4 +} +``` \ No newline at end of file