]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: update network documentation
authorTomas Krizek <tomas.krizek@nic.cz>
Wed, 15 Jan 2020 11:38:02 +0000 (12:38 +0100)
committerTomas Krizek <tomas.krizek@nic.cz>
Fri, 17 Jan 2020 12:39:35 +0000 (13:39 +0100)
daemon/bindings/net_server.rst
daemon/scripting.rst
doc/quickstart-install.rst
modules/http/README.rst

index 25273b4e5764be000ffcd8ca24a790f137938817..1ce57ec071676d626a5c99871b36191903997fe1 100644 (file)
@@ -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:
index a7ff29275391c528879c96dddb9b1432b70c7708..25c7c0a8c014c24752b15ff36c892548e724121a 100644 (file)
@@ -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
index b7937f2f5bc203c38d35d27e2841cc8b0258d8cd..b5d2a7053539d95e0fd95a8cd720b14559855bcc 100644 (file)
@@ -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
index 514d77a3a22d522a43151f1d1f252eff4de5d746..5f0df46a1b2e9b379cd50c0e406a9b11ee8eb2c9 100644 (file)
@@ -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.