Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-12-07 19:05:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

Manual pages (#1346)

Browse Source 
* 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.
This commit is contained in:
Miek Gieben
2018-01-04 12:53:07 +00:00
committed by GitHub
parent 0600f8c058
commit 58221f55db
62 changed files with 3397 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
plugin/whoami/README.md
View File

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