From 2cff9291e50c1eaffa1eb782753e9c5aaa4a6506 Mon Sep 17 00:00:00 2001 From: Miek Gieben Date: Sun, 10 Sep 2017 20:46:25 +0100 Subject: [PATCH] mw/whoami: update docs (#1054) * mw/whoami: update docs Parse the corefile in the readme_test.go and other tweaks to the docs. Fixes #1049 * trailing * remove the 53 port --- middleware/whoami/README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/middleware/whoami/README.md b/middleware/whoami/README.md index 87e6e7ac7..4b56a2e77 100644 --- a/middleware/whoami/README.md +++ b/middleware/whoami/README.md @@ -1,15 +1,19 @@ # 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. +*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. -The port and transport are included in the additional section as a SRV record, transport can be -"tcp" or "udp". +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". ~~~ txt ._.qname. 0 IN SRV 0 0 . ~~~ +If CoreDNS can't find a Corefile on startup this is the *default* middleware that gets loaded. As +such it can be used to check that CoreDNS is responding to queries. Other than that this middleware +is of limited use in production. + The *whoami* middleware will respond to every A or AAAA query, regardless of the query name. ## Syntax @@ -20,8 +24,10 @@ whoami ## Examples -~~~ txt -.:53 { +Start a server on the default port and load the *whoami* middleware. + +~~~ corefile +. { whoami } ~~~