coredns/plugin/loop/README.md
Chris O'Haver 992e7928c7 Document current limitations of loop (#1996)
* Document current limitations of loop

* Update README.md
2018-07-23 20:37:41 +01:00

47 lines
1.2 KiB
Markdown

# loop
## Name
*loop* - detect simple forwarding loops and halt the server.
## Description
The *loop* plugin will send a random query to ourselves and will then keep track of how many times
we see it. If we see it more than twice, we assume CoreDNS is looping and we halt the process.
The plugin will try to send the query for up to 30 seconds. This is done to give CoreDNS enough time
to start up. Once a query has been successfully sent *loop* disables itself to prevent a query of
death.
The query sent is `<random number>.<random number>.zone` with type set to HINFO.
## Syntax
~~~ txt
loop
~~~
## Examples
Start a server on the default port and load the *loop* and *forward* plugins. The *forward* plugin
forwards to it self.
~~~ txt
. {
loop
forward . 127.0.0.1
}
~~~
After CoreDNS has started it stops the process while logging:
~~~ txt
plugin/loop: Seen "HINFO IN 5577006791947779410.8674665223082153551." more than twice, loop detected
~~~
## Limitations
This plugin only attempts to find simple static forwarding loops at start up time. To detect a loop, all of the following must be true
* the loop must be present at start up time.
* the loop must occur for at least the `HINFO` query type.