From: Tomas Krizek <tomas.krizek@nic.cz>
Date: Wed, 15 Jan 2020 11:38:02 +0000 (+0100)
Subject: doc: update network documentation
X-Git-Tag: v5.0.0~6^2~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5b6c81eb930cf31ded9ec6e551ae3d403760c299;p=thirdparty%2Fknot-resolver.git

doc: update network documentation
---

diff --git a/daemon/bindings/net_server.rst b/daemon/bindings/net_server.rst
index 25273b4e5..1ce57ec07 100644
--- a/daemon/bindings/net_server.rst
+++ b/daemon/bindings/net_server.rst
@@ -14,10 +14,13 @@ First you need to decide what service should be available on given IP address
   ":ref:`DNS-over-TLS (DoT) <tls-server-config>`","``tls``"
   ":ref:`mod-http-doh`","``doh``"
   ":ref:`Web management <mod-http-built-in-services>`","``webmgmt``"
+  ":ref:`Control socket <control-sockets>`","``control``"
 
+.. note:: By default, **unencrypted DNS and DNS-over-TLS** are configured to **listen
+   on localhost**.
 
-
-*By default, these are configured to listen on localhost.*
+   Control sockets are created either in
+   ``/run/knot-resolver/control/`` (when using systemd) or ``$PWD/control/``.
 
 .. function:: net.listen(addresses, [port = 53, { kind = 'dns', freebind = false }])
 
@@ -35,6 +38,7 @@ First you need to decide what service should be available on given IP address
   ":ref:`DNS-over-TLS (DoT) <tls-server-config>`","``net.listen('192.0.2.123', 853, { kind = 'tls' })``"
   ":ref:`mod-http-doh`","``net.listen('192.0.2.123', 443, { kind = 'doh' })``"
   ":ref:`Web management <mod-http-built-in-services>`","``net.listen('192.0.2.123', 8453, { kind = 'webmgmt' })``"
+  ":ref:`Control socket <control-sockets>`","``net.listen('/tmp/kresd.control', nil, { kind = 'control' })``"
 
 
 Examples:
diff --git a/daemon/scripting.rst b/daemon/scripting.rst
index a7ff29275..25c7c0a8c 100644
--- a/daemon/scripting.rst
+++ b/daemon/scripting.rst
@@ -13,6 +13,9 @@ a little Lua function which gathers statistics and returns them in JSON string.
 This can be used by an external system which uses control socket to call this
 user-defined function and to retrieve its results.
 
+
+.. _control-sockets:
+
 Control sockets
 ---------------
 Control socket acts like "an interactive configuration file" so all actions
diff --git a/doc/quickstart-install.rst b/doc/quickstart-install.rst
index b7937f2f5..b5d2a7053 100644
--- a/doc/quickstart-install.rst
+++ b/doc/quickstart-install.rst
@@ -68,7 +68,7 @@ Use
 package from AUR_.
 
 
-**OpenSUSE Leap / Tumbleweed**
+**openSUSE Leap / Tumbleweed**
 Add the `OBS <https://en.opensuse.org/Portal:Build_Service>`_ package repository `home:CZ-NIC:knot-resolver-latest <https://software.opensuse.org/download.html?project=home%3ACZ-NIC%3Aknot-resolver-latest&package=knot-resolver>`_ to your system.
 
 .. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
diff --git a/modules/http/README.rst b/modules/http/README.rst
index 514d77a3a..5f0df46a1 100644
--- a/modules/http/README.rst
+++ b/modules/http/README.rst
@@ -3,6 +3,10 @@
 HTTP services
 =============
 
+.. tip:: In most distributions, the ``http`` module is available from a
+   separate package ``knot-resolver-module-http``. The module isn't packaged
+   for openSUSE.
+
 This module does the heavy lifting to provide an HTTP and HTTP/2 enabled
 server which provides few built-in services and also allows other
 modules to export restful APIs and websocket streams.