From: Vladimír Čunát <vladimir.cunat@nic.cz>
Date: Wed, 22 Feb 2017 13:47:26 +0000 (+0100)
Subject: modules/dnstap: move description into the docs
X-Git-Tag: v1.3.0~23^2~62^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0e62dafdd9a249f15b2ed4acfa28caa2f101a16c;p=thirdparty%2Fknot-resolver.git

modules/dnstap: move description into the docs
---

diff --git a/doc/modules.rst b/doc/modules.rst
index cc25562e1..dade86c98 100644
--- a/doc/modules.rst
+++ b/doc/modules.rst
@@ -24,3 +24,4 @@ Knot DNS Resolver modules
 .. include:: ../modules/cookies/README.rst
 .. include:: ../modules/version/README.rst
 .. include:: ../modules/workarounds/README.rst
+.. include:: ../modules/dnstap/README.rst
diff --git a/modules/dnstap/README.rst b/modules/dnstap/README.rst
new file mode 100644
index 000000000..e33b5a91c
--- /dev/null
+++ b/modules/dnstap/README.rst
@@ -0,0 +1,24 @@
+.. _mod-dnstap:
+
+Dnstap
+------
+
+Dnstap module currently supports logging dns responses to a unix socket
+in dnstap format using fstrm framing library.  The unix socket and the
+socket reader should be present before starting kresd.
+
+Configuration
+^^^^^^^^^^^^^
+Tunables:
+
+* ``sockpath``: the the unix socket file where dnstap messages will be sent
+* ``logRespPkt``: if true responses in wire format will be logged
+
+.. code-block:: lua
+
+    modules = {
+        dnstap = {
+            sockPath = "/tmp/dnstap.sock",
+            logRespPkt = true
+        }
+    }
diff --git a/modules/dnstap/dnstap.c b/modules/dnstap/dnstap.c
index 872105ccf..9417b08aa 100644
--- a/modules/dnstap/dnstap.c
+++ b/modules/dnstap/dnstap.c
@@ -15,20 +15,6 @@
  * @file dnstap.c
  * @brief dnstap based query logging support
  *
- * dnstap module currently supports logging dns responses to a unix socket
- * in dnstap format using fstrm framing library. The unix socket and the
- * socket reader should be present before starting kresd
- *
- * Tunables:
- * sockpath: is the the unix socket file where dnstap messages will be send
- * logRespPkt: if true responses in wire format will be logged
- *
- * sample configuration for dnstap
- * dnstap = {
- *     sockPath = "/tmp/dnstap.sock",
- *     logRespPkt = true
- * }
- *
  */
 
 #include "lib/module.h"