diff options
-rw-r--r-- | daemon/scripting.rst | 2 | ||||
-rw-r--r-- | doc/architecture.rst | 2 | ||||
-rw-r--r-- | doc/config-dnssec-ta.rst | 4 | ||||
-rw-r--r-- | doc/config-network-forwarding.rst | 6 | ||||
-rw-r--r-- | doc/config-network.rst | 1 | ||||
-rw-r--r-- | doc/config-overview.rst | 2 | ||||
-rw-r--r-- | doc/deployment-no-systemd.rst | 4 | ||||
-rw-r--r-- | doc/deployment-systemd.rst | 3 | ||||
-rw-r--r-- | doc/gettingstarted-startup.rst | 2 | ||||
-rw-r--r-- | doc/index.rst | 2 | ||||
-rw-r--r-- | doc/upgrading.rst | 6 | ||||
-rw-r--r-- | modules/http/README.rst | 4 | ||||
-rw-r--r-- | systemd/multiinst.rst | 2 |
13 files changed, 20 insertions, 20 deletions
diff --git a/daemon/scripting.rst b/daemon/scripting.rst index b2eab0fc..742aa955 100644 --- a/daemon/scripting.rst +++ b/daemon/scripting.rst @@ -134,7 +134,7 @@ process for liveliness by connecting to the UNIX socket. Lua scripts ----------- -As it was mentioned in section :ref:`config-syntax`, Resolver's configuration +As it was mentioned in section :ref:`config-lua-syntax`, Resolver's configuration file contains program in Lua programming language. This allows you to write dynamic rules and helps you to avoid repetitive templating that is unavoidable with static configuration. For example parts of configuration can depend on diff --git a/doc/architecture.rst b/doc/architecture.rst index 10fadf62..dc4dc862 100644 --- a/doc/architecture.rst +++ b/doc/architecture.rst @@ -2,7 +2,7 @@ System architecture ******************* -As mentioned in the :ref:`getting started section <gettingstarted-intro>`, Knot Resolver is split into several components, namely the manager, ``kresd`` and the garbage collector. In addition to these custom components, we also rely on `supervisord <http://supervisord.org/>`_. +Knot Resolver is split into several components, namely the manager, ``kresd`` and the garbage collector. In addition to these custom components, we also rely on `supervisord <http://supervisord.org/>`_. .. image:: architecture-schema.svg :width: 100% diff --git a/doc/config-dnssec-ta.rst b/doc/config-dnssec-ta.rst index f05a4e79..b02e2ca7 100644 --- a/doc/config-dnssec-ta.rst +++ b/doc/config-dnssec-ta.rst @@ -21,7 +21,7 @@ policy, or automatically maintained by the resolver itself. In practice this means that you can forget about it and your favorite Linux distribution will take care of it for you. -Following :option:`dnssec` section allow to modify DNSSEC configuration *if you really have to*: +Following :option:`dnssec <dnssec: false|<options>>` section allow to modify DNSSEC configuration *if you really have to*: .. option:: dnssec: false|<options> @@ -96,7 +96,7 @@ Following :option:`dnssec` section allow to modify DNSSEC configuration *if you .. note:: - Static keys are very error-prone and should not be used in production. Use :option:`dnssec/trust-anchors-files` instead. + Static keys are very error-prone and should not be used in production. Use :option:`trust-anchors-files <trust-anchors-files: <list>>` instead. .. code-block:: yaml diff --git a/doc/config-network-forwarding.rst b/doc/config-network-forwarding.rst index 72d37327..f8b1ab70 100644 --- a/doc/config-network-forwarding.rst +++ b/doc/config-network-forwarding.rst @@ -17,7 +17,7 @@ Forwarding implementation in Knot Resolver has following properties: * Answers from *upstream* servers are cached. * Answers from *upstream* servers are locally DNSSEC-validated, unless dnssec is disabled. * Resolver automatically selects which IP address from given set of IP addresses will be used (based on performance characteristics). - * Forwarding can use either unencrypted DNS protocol, or :ref:`config-policy-forwarding-tls`. + * :ref:`Forwarding <config-forward>` can use either encrypted or unencrypted DNS protocol. .. warning:: @@ -38,6 +38,6 @@ Simple examples for **unencrypted** forwarding: - subtree: example.com. servers: [192.0.2.1] -To configure encrypted version please see chapter :ref:`config-policy-forwarding-tls`. +To configure encrypted version please see chapter about :ref:`forwarding <config-forward>`. -Forwarding is documented in depth together with rest of :ref:`config-policy`. +Forwarding is documented in depth together with rest of :ref:`config-policy-new`. diff --git a/doc/config-network.rst b/doc/config-network.rst index 8311543b..11d3588b 100644 --- a/doc/config-network.rst +++ b/doc/config-network.rst @@ -42,7 +42,6 @@ Server (communication with clients) config-network-server config-network-server-tls - .. config-network-http Client (retrieving answers from servers) ======================================== diff --git a/doc/config-overview.rst b/doc/config-overview.rst index 5ea96fb7..a037527d 100644 --- a/doc/config-overview.rst +++ b/doc/config-overview.rst @@ -30,7 +30,7 @@ You can use :ref:`kresctl validate <manager-client>` to check your configuration Whenever a configuration is loaded and the validation fails, we attempt to log a detailed error message explaining what the problem was. For example, it could look like the following. - .. code-block:: + .. code-block:: bash ERROR:knot_resolver_manager.server:multiple configuration errors detected: [/management/interface] invalid port number 66000 diff --git a/doc/deployment-no-systemd.rst b/doc/deployment-no-systemd.rst index 6cb2bb36..68b3464a 100644 --- a/doc/deployment-no-systemd.rst +++ b/doc/deployment-no-systemd.rst @@ -1,9 +1,9 @@ .. SPDX-License-Identifier: GPL-3.0-or-later -.. _usage-without-systemd: - .. include:: deployment-warning.rst +.. _deployment-no-systemd: + ***************************************** Usage without systemd and without manager ***************************************** diff --git a/doc/deployment-systemd.rst b/doc/deployment-systemd.rst index 3b6c3c69..b384adf1 100644 --- a/doc/deployment-systemd.rst +++ b/doc/deployment-systemd.rst @@ -4,7 +4,7 @@ Systemd In the default installation, Knot Resolver contains systemd integration and starting it on such system usually involves only one command. -.. code-block:: +.. code-block:: bash systemctl enable --now knot-resolver.service @@ -13,6 +13,7 @@ If you don't have systemd service file for Knot Resolver already installed in yo .. literalinclude:: ../systemd/knot-resolver.service.in + :language: bash .. note:: diff --git a/doc/gettingstarted-startup.rst b/doc/gettingstarted-startup.rst index 7593aa14..ea339519 100644 --- a/doc/gettingstarted-startup.rst +++ b/doc/gettingstarted-startup.rst @@ -21,7 +21,7 @@ For more information about systemd integration see ``man knot-resolver.systemd`` To start and enable service in one command use ``systemctl enable --now knot-resolver.service`` Unfortunately, for some cases (typically Docker and minimalistic systems), ``systemd`` is not available, therefore it is not possible to use ``knot-resolver.service``. -If you have this problem, look at :ref:`usage without systemd <config-no-systemd>` section. +If you have this problem, look at :ref:`usage without systemd <deployment-no-systemd>` section. .. note:: diff --git a/doc/index.rst b/doc/index.rst index a9b0dd69..f879a967 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,7 +8,7 @@ Welcome to Knot Resolver's documentation! Knot Resolver is an open-source implementation of a caching validating DNS resolver. Modular architecture keeps the core tiny and efficient, and it also provides a state-machine like API for extensions. -If you are a new user, please start with chapter for :ref:`getting started <gettingstarted>`. +If you are a new user, please start with chapter for :ref:`getting started <gettingstarted-chapter>`. .. toctree:: :caption: Getting Started diff --git a/doc/upgrading.rst b/doc/upgrading.rst index e630e9e7..4aa409c6 100644 --- a/doc/upgrading.rst +++ b/doc/upgrading.rst @@ -268,13 +268,13 @@ Configuration file "``trust_anchors.keyfile_default = nil``", "``trust_anchors.remove('.')``" * Network for HTTP endpoints is now configured using same mechanism as for normal DNS endpoints, - please refer to chapter :ref:`network-configuration`. Migration table: + please refer to chapter :ref:`config-lua-network`. Migration table: .. csv-table:: :header: "3.x configuration", "4.x configuration" - "``modules = { http = { host = '192.0.2.1', port = 443 }}``","see chapter :ref:`network-configuration`" - "``http.config({ host = '192.0.2.1', port = 443 })``","see chapter :ref:`network-configuration`" + "``modules = { http = { host = '192.0.2.1', port = 443 }}``","see chapter :ref:`config-lua-network`" + "``http.config({ host = '192.0.2.1', port = 443 })``","see chapter :ref:`config-lua-network`" "``modules = { http = { endpoints = ... }}``","see chapter :ref:`mod-http-custom-endpoint`" "``http.config({ endpoints = ... })``","see chapter :ref:`mod-http-custom-endpoint`" diff --git a/modules/http/README.rst b/modules/http/README.rst index 6d8a075c..461e9a17 100644 --- a/modules/http/README.rst +++ b/modules/http/README.rst @@ -30,7 +30,7 @@ and unlimited number of "used-defined kinds" can be added in configuration. Each network address and port combination can be configured to expose one kind of endpoint. This is done using the same mechanisms as network configuration for plain DNS and DNS-over-TLS, -see chapter :ref:`network-configuration` for more details. +see chapter :ref:`config-lua-network` for more details. .. warning:: Management endpoint (``webmgmt``) must not be directly exposed to untrusted parties. Use `reverse-proxy`_ like Apache_ @@ -47,7 +47,7 @@ Example configuration This section shows how to configure HTTP module itself. For information how to configure HTTP server's IP addresses and ports please see chapter -:ref:`network-configuration`. +:ref:`config-lua-network`. .. code-block:: lua diff --git a/systemd/multiinst.rst b/systemd/multiinst.rst index 2a5c63c0..00b18029 100644 --- a/systemd/multiinst.rst +++ b/systemd/multiinst.rst @@ -6,7 +6,7 @@ Multiple instances ================== .. note:: This section describes the usage of kresd when running under systemd. - For other uses, please refer to :ref:`usage-without-systemd`. + For other uses, please refer to :ref:`deployment-no-systemd`. Knot Resolver can utilize multiple CPUs running in multiple independent instances (processes), where each process utilizes at most single CPU core on your machine. If your machine handles a lot of DNS traffic run multiple instances. |