coredns/middleware/whoami/README.md
Miek Gieben faf83b00dd docs: rewrite using manpage style (#327)
This still needs cleanup, but this is a first pass the cleans some
cruft and documents our style (in middleware.md) and makes all the
docs match that style.
2016-10-10 20:13:22 +01:00

38 lines
770 B
Markdown

# whoami
*whoami* returns your local IP address, port and transport used. Your local IP address is returned in
the additional section as either an A or AAAA record.
The port and transport are included in the additional section as a SRV record, transport can be
"tcp" or "udp".
~~~ txt
._<transport>.qname. 0 IN SRV 0 0 <port> .
~~~
The *whoami* middleware will respond to every A or AAAA query, regardless of the query name.
## Syntax
~~~ txt
whoami
~~~
## Examples
~~~ txt
.:53 {
whoami
}
~~~
When queried for "example.org A", CoreDNS will respond with:
~~~ txt
;; QUESTION SECTION:
;example.org. IN A
;; ADDITIONAL SECTION:
example.org. 0 IN A 10.240.0.1
_udp.example.org. 0 IN SRV 0 0 40212
~~~