aboutsummaryrefslogtreecommitdiff
path: root/plugin
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2018-05-24 07:51:59 +0100
committerGravatar GitHub <noreply@github.com> 2018-05-24 07:51:59 +0100
commitc0fbef07147552b48eca243ce9839a7920686745 (patch)
treed04f842c3e0a6e8f4ad2287ea01f5791c1eef218 /plugin
parent4ec613e186fa1aa62c96791ed0bdc94e92a5522d (diff)
downloadcoredns-c0fbef07147552b48eca243ce9839a7920686745.tar.gz
coredns-c0fbef07147552b48eca243ce9839a7920686745.tar.zst
coredns-c0fbef07147552b48eca243ce9839a7920686745.zip
generate doc for 1.1.3 (#1832)
Diffstat (limited to 'plugin')
-rw-r--r--plugin/pprof/README.md8
-rw-r--r--plugin/rewrite/README.md5
2 files changed, 5 insertions, 8 deletions
diff --git a/plugin/pprof/README.md b/plugin/pprof/README.md
index 34f43cb48..27d64aee7 100644
--- a/plugin/pprof/README.md
+++ b/plugin/pprof/README.md
@@ -9,12 +9,8 @@
You can visit `/debug/pprof` on your site for an index of the available endpoints. By default it
will listen on localhost:6053.
-> This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If
-> you use pprof on a live server, consider restricting access or enabling it only temporarily.
-
-For more information, please see [Go's pprof
-documentation](https://golang.org/pkg/net/http/pprof/) and read
-[Profiling Go Programs](https://blog.golang.org/profiling-go-programs).
+This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If
+you use pprof on a live server, consider restricting access or enabling it only temporarily.
This plugin can only be used once per Server Block.
diff --git a/plugin/rewrite/README.md b/plugin/rewrite/README.md
index a25017ebf..04863cdbe 100644
--- a/plugin/rewrite/README.md
+++ b/plugin/rewrite/README.md
@@ -17,12 +17,14 @@ rewrite [continue|stop] FIELD FROM TO
~~~
* **FIELD** indicates what part of the request/response is being re-written.
- * `type` - the type field of the request will be rewritten. FROM/TO must be a DNS record type (`A`, `MX`, etc);
+
+ * `type` - the type field of the request will be rewritten. FROM/TO must be a DNS record type (`A`, `MX`, etc);
e.g., to rewrite ANY queries to HINFO, use `rewrite type ANY HINFO`.
* `class` - the class of the message will be rewritten. FROM/TO must be a DNS class type (`IN`, `CH`, or `HS`) e.g., to rewrite CH queries to IN use `rewrite class CH IN`.
* `name` - the query name in the _request_ is rewritten; by default this is a full match of the name, e.g., `rewrite name miek.nl example.org`. Other match types are supported, see the **Name Field Rewrites** section below.
* `answer name` - the query name in the _response_ is rewritten. This option has special restrictions and requirements, in particular it must always combined with a `name` rewrite. See below in the **Response Rewrites** section.
* `edns0` - an EDNS0 option can be appended to the request as described below in the **EDNS0 Options** section.
+
* **FROM** is the name or type to match
* **TO** is the destination name or type to rewrite to
@@ -240,4 +242,3 @@ rewrite [continue|stop] {type|class|edns0|name [exact|prefix|suffix|substring|re
~~~
The syntax above doesn't cover the multi line block option for specifying a name request+response rewrite rule described in the **Response Rewrite** section.
-