]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: nsid module polish for new docs structure
authorPetr Špaček <petr.spacek@nic.cz>
Fri, 3 Jan 2020 19:28:29 +0000 (20:28 +0100)
committerTomas Krizek <tomas.krizek@nic.cz>
Wed, 15 Jan 2020 09:38:16 +0000 (10:38 +0100)
modules/nsid/README.rst

index 3ac4c00b4efeb080766ef27888185b3bc33dedb7..ec967d765b24a74d9f924a73a5fa35d12b1442ce 100644 (file)
@@ -3,16 +3,11 @@
 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.
+Module ``nsid`` provides server-side support for :rfc:`5001`
+which allows DNS clients to request resolver to send back its NSID
+along with the reply to a DNS request.
+This is useful for debugging larger resolver farms
+(e.g. when using `multiple instances`_, anycast or load balancers).
 
 NSID value can be configured in the resolver's configuration file:
 
@@ -21,15 +16,15 @@ NSID value can be configured in the resolver's configuration file:
    modules.load('nsid')
    nsid.name('instance 1')
 
-.. tip:: When dealing with multiple kresd instances managed with
-   systemd, see :ref:`instance-specific-configuration`.
+.. tip:: When dealing with Knot Resolver running in `multiple instances`
+        managed with systemd see :ref:`instance-specific-configuration`.
 
 You can also obtain configured NSID value:
 
 .. code-block:: lua
 
-   nsid.name()
-   instance 1
+   nsid.name()
+   'instance 1'
 
 The module can be disabled at run-time: