Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-28 00:34:24 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: less CoreDNS in docs (#1154)

Browse Source 
Various other changes.
This commit is contained in:
Miek Gieben
2017-10-20 09:47:43 +01:00
committed by GitHub
parent 11203e440d
commit c1f67493de
8 changed files with 11 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
plugin/autopath/README.md
View File

@@ -1,6 +1,6 @@
# autopath # 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 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 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. 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).

2
plugin/chaos/README.md
View File

@@ -1,6 +1,6 @@
# chaos # 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. This is useful for retrieving version or author information from the server.

4
plugin/debug/README.md
View File

@@ -1,6 +1,6 @@
# debug # 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 Note that the *errors* plugin (if loaded) will also set a `recover` negating this setting. The main
use of *debug* is to help testing. use of *debug* is to help testing.
@@ -13,7 +13,7 @@ debug
## Examples ## Examples
Disable CoreDNS' ability to recover from crashes: Disable the ability to recover from crashes:
~~~ corefile ~~~ corefile
. { . {

4
plugin/health/README.md
View File

@@ -1,6 +1,8 @@
# health # 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 ## Syntax

2
plugin/metrics/README.md
View File

@@ -1,6 +1,6 @@
# prometheus # 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 default location for the metrics is `localhost:9153`. The metrics path is fixed to `/metrics`.
The following metrics are exported: The following metrics are exported:

2
plugin/reverse/README.md
View File

@@ -1,6 +1,6 @@
# reverse # 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 ## Syntax

2
plugin/root/README.md
View File

@@ -1,6 +1,6 @@
# root # 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 default root is the current working directory of CoreDNS. A relative root path is relative to
the current working directory. the current working directory.

2
plugin/whoami/README.md
View File

@@ -3,7 +3,7 @@
*whoami* returns your resolver's local IP address, port and transport. Your IP address is returned *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. 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 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". section as a SRV record, transport can be "tcp" or "udp".