aboutsummaryrefslogtreecommitdiff
path: root/plugin/whoami
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2018-01-04 12:53:07 +0000
committerGravatar GitHub <noreply@github.com> 2018-01-04 12:53:07 +0000
commit58221f55db5675c6107d19679c46a216ed072aca (patch)
treef4f86c8ecd35538da492524dec549566daf40809 /plugin/whoami
parent0600f8c058f39c7afec9f915657e06f158d21c47 (diff)
downloadcoredns-58221f55db5675c6107d19679c46a216ed072aca.tar.gz
coredns-58221f55db5675c6107d19679c46a216ed072aca.tar.zst
coredns-58221f55db5675c6107d19679c46a216ed072aca.zip
Manual pages (#1346)
* Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
Diffstat (limited to 'plugin/whoami')
-rw-r--r--plugin/whoami/README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/plugin/whoami/README.md b/plugin/whoami/README.md
index 6d7024895..044e53790 100644
--- a/plugin/whoami/README.md
+++ b/plugin/whoami/README.md
@@ -1,9 +1,14 @@
# whoami
-*whoami* returns your resolver's local IP address, port and transport. Your IP address is returned
- in the additional section as either an A or AAAA record.
+## Name
-When CoreDNS can not find a Corefile to load, this is the default plugin it loads.
+*whoami* - returns your resolver's local IP address, port and transport.
+
+## Description
+
+The *whoami* plugin is not really that useful, but can be used for having a simple (fast) endpoint
+to test clients against. When *whoami* returns a response it will have your client's IP address the
+additional section as either an A or AAAA record.
The reply always has an empty answer section. The port and transport are included in the additional
section as a SRV record, transport can be "tcp" or "udp".
@@ -12,12 +17,12 @@ section as a SRV record, transport can be "tcp" or "udp".
._<transport>.qname. 0 IN SRV 0 0 <port> .
~~~
-If CoreDNS can't find a Corefile on startup this is the *default* plugin that gets loaded. As
-such it can be used to check that CoreDNS is responding to queries. Other than that this plugin
-is of limited use in production.
-
The *whoami* plugin will respond to every A or AAAA query, regardless of the query name.
+If CoreDNS can't find a Corefile on startup this is the _default_ plugin that gets loaded. As such
+it can be used to check that CoreDNS is responding to queries. Other than that this plugin is of
+limited use in production.
+
## Syntax
~~~ txt