aboutsummaryrefslogtreecommitdiff
path: root/plugin/debug/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/debug/README.md')
-rw-r--r--plugin/debug/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugin/debug/README.md b/plugin/debug/README.md
new file mode 100644
index 000000000..2598a1900
--- /dev/null
+++ b/plugin/debug/README.md
@@ -0,0 +1,20 @@
+# debug
+
+*debug* disables the automatic recovery upon a CoreDNS 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.
+
+## Syntax
+
+~~~ txt
+debug
+~~~
+
+## Examples
+
+Disable CoreDNS' ability to recover from crashes:
+
+~~~ txt
+debug
+~~~