diff options
| -rw-r--r-- | plugin/autopath/README.md | 7 | ||||
| -rw-r--r-- | plugin/chaos/README.md | 2 | ||||
| -rw-r--r-- | plugin/debug/README.md | 4 | ||||
| -rw-r--r-- | plugin/health/README.md | 4 | ||||
| -rw-r--r-- | plugin/metrics/README.md | 2 | ||||
| -rw-r--r-- | plugin/reverse/README.md | 2 | ||||
| -rw-r--r-- | plugin/root/README.md | 2 | ||||
| -rw-r--r-- | plugin/whoami/README.md | 2 |
8 files changed, 11 insertions, 14 deletions
diff --git a/plugin/autopath/README.md b/plugin/autopath/README.md index 53e47b31f..9929bc672 100644 --- a/plugin/autopath/README.md +++ b/plugin/autopath/README.md @@ -1,6 +1,6 @@ # autopath -*autopath* allows CoreDNS to perform server side search path completion. +*autopath* allows for server side search path completion. If it sees a query that matches the first element of the configured search path, *autopath* will follow the chain of search path elements and returns the first reply that is not NXDOMAIN. On any @@ -44,8 +44,3 @@ autopath @kubernetes ~~~ Use the search path dynamically retrieved from the kubernetes plugin. - -## Bugs - -Replies from this plugin are not cached, as the *cache* plugin is configured after this one (see -plugin.cfg). diff --git a/plugin/chaos/README.md b/plugin/chaos/README.md index 3dfcc1112..8af6f492a 100644 --- a/plugin/chaos/README.md +++ b/plugin/chaos/README.md @@ -1,6 +1,6 @@ # chaos -*chaos* allows CoreDNS to respond to TXT queries in the CH class. +*chaos* allows for responding to TXT queries in the CH class. This is useful for retrieving version or author information from the server. diff --git a/plugin/debug/README.md b/plugin/debug/README.md index b3dab62d9..5990bf6bb 100644 --- a/plugin/debug/README.md +++ b/plugin/debug/README.md @@ -1,6 +1,6 @@ # debug -*debug* disables the automatic recovery upon a CoreDNS crash so that you'll get a nice stack trace. +*debug* disables the automatic recovery upon a crash so that you'll get a nice stack trace. Note that the *errors* plugin (if loaded) will also set a `recover` negating this setting. The main use of *debug* is to help testing. @@ -13,7 +13,7 @@ debug ## Examples -Disable CoreDNS' ability to recover from crashes: +Disable the ability to recover from crashes: ~~~ corefile . { diff --git a/plugin/health/README.md b/plugin/health/README.md index 8212aab9f..f8395d8cd 100644 --- a/plugin/health/README.md +++ b/plugin/health/README.md @@ -1,6 +1,8 @@ # health -*health* enables a simple health check endpoint. By default, it listens on port 8080. +*health* enables a simple health check endpoint. + +By default, it listens on port 8080. ## Syntax diff --git a/plugin/metrics/README.md b/plugin/metrics/README.md index 1abb5b40c..a5283b27b 100644 --- a/plugin/metrics/README.md +++ b/plugin/metrics/README.md @@ -1,6 +1,6 @@ # prometheus -*prometheus* enables [Prometheus](https://prometheus.io/) metrics for CoreDNS. +*prometheus* enables [Prometheus](https://prometheus.io/) metrics. The default location for the metrics is `localhost:9153`. The metrics path is fixed to `/metrics`. The following metrics are exported: diff --git a/plugin/reverse/README.md b/plugin/reverse/README.md index 0e0e4c7a6..97a098def 100644 --- a/plugin/reverse/README.md +++ b/plugin/reverse/README.md @@ -1,6 +1,6 @@ # reverse -*reverse* allows CoreDNS to respond dynamically to a PTR request and the related A/AAAA request. +*reverse* allows for dynamic responses to PTR and the related A/AAAA requests. ## Syntax diff --git a/plugin/root/README.md b/plugin/root/README.md index 0b73ce78b..41b40e4d3 100644 --- a/plugin/root/README.md +++ b/plugin/root/README.md @@ -1,6 +1,6 @@ # root -*root* simply specifies the root of where CoreDNS finds (e.g.) zone files. +*root* simply specifies the root of where to find (zone) files. The default root is the current working directory of CoreDNS. A relative root path is relative to the current working directory. diff --git a/plugin/whoami/README.md b/plugin/whoami/README.md index 7d231ba26..6d7024895 100644 --- a/plugin/whoami/README.md +++ b/plugin/whoami/README.md @@ -3,7 +3,7 @@ *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. -When CoreDNS can find a Corefile to load, this is the default plugin it loads. +When CoreDNS can not find a Corefile to load, this is the default plugin it loads. 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". |