Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-31 10:13:14 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
78b26c4678fe064cf21c73e186b51a1fb0273257
coredns/plugin/whoami/README.md

59 lines
1.5 KiB
Markdown
Raw Normal View History

middleware/whoami: add (#264) Add a new middleware that tells you who you are; IP, port and transport is echoed back. Also some various cleanup and documentation improvements while at it: * ResponseWriter: improve the documentation of these helper functions. * And add an NextHandler for use in tests. Make chaos_test.go and * whoam_test.go use it.
2016-09-17 17:09:05 +01:00
# whoami
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.
2018-01-04 12:53:07 +00:00
## Name
middleware/whoami: add (#264) Add a new middleware that tells you who you are; IP, port and transport is echoed back. Also some various cleanup and documentation improvements while at it: * ResponseWriter: improve the documentation of these helper functions. * And add an NextHandler for use in tests. Make chaos_test.go and * whoam_test.go use it.
2016-09-17 17:09:05 +01:00
Remove trailing whitespace (#1955) Prevent future; "remove trailing whitespace" PR, but adding a simple presubmit that checks for this. This presubmit flagged quite some offenders, remove all trailing whitespace from. Apart from that there aren't any other changes. Signed-off-by: Miek Gieben <miek@miek.nl>
2018-07-09 13:08:02 +01:00
*whoami* - returns your resolver's local IP address, port and transport.
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.
2018-01-04 12:53:07 +00:00
## Description
The *whoami* plugin is not really that useful, but can be used for having a simple (fast) endpoint
fix minor typo (#1932)
2018-07-03 16:57:49 +02:00
to test clients against. When *whoami* returns a response it will have your client's IP address in
the additional section as either an A or AAAA record.
doc update (#1140) * doc update Go through all README and fix mistakes, extend example and let more corefile snippets be test for validity. * Cant use spefic addr in test
2017-10-10 09:39:35 +02:00
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
2017-09-10 20:46:25 +01:00
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".
middleware/whoami: add (#264) Add a new middleware that tells you who you are; IP, port and transport is echoed back. Also some various cleanup and documentation improvements while at it: * ResponseWriter: improve the documentation of these helper functions. * And add an NextHandler for use in tests. Make chaos_test.go and * whoam_test.go use it.
2016-09-17 17:09:05 +01:00
~~~ txt
._<transport>.qname. 0 IN SRV 0 0 <port> .
~~~
Remove the word middleware (#1067) * Rename middleware to plugin first pass; mostly used 'sed', few spots where I manually changed text. This still builds a coredns binary. * fmt error * Rename AddMiddleware to AddPlugin * Readd AddMiddleware to remain backwards compat
2017-09-14 09:36:06 +01:00
The *whoami* plugin will respond to every A or AAAA query, regardless of the query name.
middleware/whoami: add (#264) Add a new middleware that tells you who you are; IP, port and transport is echoed back. Also some various cleanup and documentation improvements while at it: * ResponseWriter: improve the documentation of these helper functions. * And add an NextHandler for use in tests. Make chaos_test.go and * whoam_test.go use it.
2016-09-17 17:09:05 +01:00
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.
2018-01-04 12:53:07 +00:00
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.
middleware/whoami: add (#264) Add a new middleware that tells you who you are; IP, port and transport is echoed back. Also some various cleanup and documentation improvements while at it: * ResponseWriter: improve the documentation of these helper functions. * And add an NextHandler for use in tests. Make chaos_test.go and * whoam_test.go use it.
2016-09-17 17:09:05 +01:00
## Syntax
~~~ txt
whoami
~~~
## Examples
Remove the word middleware (#1067) * Rename middleware to plugin first pass; mostly used 'sed', few spots where I manually changed text. This still builds a coredns binary. * fmt error * Rename AddMiddleware to AddPlugin * Readd AddMiddleware to remain backwards compat
2017-09-14 09:36:06 +01:00
Start a server on the default port and load the *whoami* plugin.
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
2017-09-10 20:46:25 +01:00
~~~ corefile
. {
middleware/whoami: add (#264) Add a new middleware that tells you who you are; IP, port and transport is echoed back. Also some various cleanup and documentation improvements while at it: * ResponseWriter: improve the documentation of these helper functions. * And add an NextHandler for use in tests. Make chaos_test.go and * whoam_test.go use it.
2016-09-17 17:09:05 +01:00
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
~~~
Add links to whoami plugin reading material (#1815) * Add links to whoami plugin reading material * create See Also section
2018-05-22 07:38:25 -07:00
## See Also
[Read the blog post][blog] on how this plugin is built, or [explore the source code][code].
[blog]: https://coredns.io/2017/03/01/how-to-add-plugins-to-coredns/
[code]: https://github.com/coredns/coredns/blob/master/plugin/whoami/
Reference in New Issue Copy Permalink