modules/dnstap: move description into the docs

1 files changed, 24 insertions, 0 deletions

diff --git a/modules/dnstap/README.rst b/modules/dnstap/README.rst
new file mode 100644
index 00000000..e33b5a91
--- /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
+        }
+    }