summaryrefslogtreecommitdiffstats
path: root/modules/nsid/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'modules/nsid/README.rst')
-rw-r--r--modules/nsid/README.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/modules/nsid/README.rst b/modules/nsid/README.rst
new file mode 100644
index 0000000..ed052c9
--- /dev/null
+++ b/modules/nsid/README.rst
@@ -0,0 +1,35 @@
+.. _mod-nsid:
+
+Name Server Identifier (NSID)
+-----------------------------
+
+This module provides server-side support for :rfc:`5001`
+and is not enabled by default.
+
+DNS clients can request resolver to send back its NSID along with the reply
+to a DNS request. This is useful for identification of resolver instances
+in larger services (using anycast or load balancers).
+
+
+This is useful tool for debugging larger services,
+as it reveals which particular resolver instance sent the reply.
+
+NSID value can be configured in the resolver's configuration file:
+
+.. code-block:: lua
+
+ modules.load('nsid')
+ nsid.name('instance 1')
+
+You can also obtain configured NSID value:
+
+.. code-block:: lua
+
+ nsid.name()
+ instance 1
+
+The module can be disabled at run-time:
+
+.. code-block:: lua
+
+ modules.unload('nsid')