From: Aleš Mrázek Date: Thu, 20 Jul 2023 13:05:36 +0000 (+0200) Subject: docs: unnecessary files removed X-Git-Tag: v6.0.2~16^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=418bbac00fd80fa1da09f003afb2494a134e1c5b;p=thirdparty%2Fknot-resolver.git docs: unnecessary files removed --- diff --git a/doc/config-policy.rst b/doc/config-policy.rst deleted file mode 100644 index 2b34a541d..000000000 --- a/doc/config-policy.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. SPDX-License-Identifier: GPL-3.0-or-later - -.. _policies: - -***************************************** -Policy, access control, data manipulation -***************************************** - -Features in this section allow to configure what clients can get access to what -DNS data, i.e. DNS data filtering and manipulation. - -:ref:`mod-policy` specify global policies applicable to all requests, -e.g. for blocking access to particular domain. :ref:`mod-view` allow -to specify per-client policies, e.g. block or unblock access -to a domain only for subset of clients. - -It is also possible to modify data returned to clients, either by providing -:ref:`mod-hints` (answers with statically configured IP addresses), -:ref:`mod-dns64` translation, or :ref:`mod-renumber`. - -Additional modules offer protection against various DNS-based attacks, -see :ref:`mod-rebinding` and :ref:`mod-refuse_nord`. - -At the very end, module :ref:`mod-daf` provides HTTP API for run-time policy -modification, and generally just offers different interface for previously -mentioned features. - - -.. toctree:: - :maxdepth: 1 - - modules-policy - modules-view - modules-hints - modules-dns64 - modules-renumber - config-answer-reordering - modules-rebinding - modules-refuse_nord - modules-daf - diff --git a/doc/config-schema.rst b/doc/config-schema.rst deleted file mode 100644 index 769587d26..000000000 --- a/doc/config-schema.rst +++ /dev/null @@ -1,42 +0,0 @@ -Configuration schema -==================== - - -The configuration schema describes the structure of accepted configuration files (or objects via the API). While originally specified in Python source code, it can be visualized as a `JSON schema `_. - -Getting the JSON schema ------------------------ - -1. The JSON schema can be obtained from a running Resolver by sending a HTTP GET request to the path ``/schema`` on the management socket (by default a Unix socket at ``/var/run/knot-resolver/manager.sock``). -2. The ``kresctl schema`` command outputs the schema of the currently installed version as well. It does not require a running resolver. -3. JSON schema for the most recent Knot Resolver version can be `downloaded here <_static/config.schema.json>`_. - -Validating you configuration ----------------------------- - -As mentioned above, the JSON schema is NOT used to validate the configuration in the Knot Resolver. It's the other way around, the validation process can generate JSON schema that can help you understand the configuration structure. Some validation steps are however dynamic (for example resolving of interface names) and can not be expressed using JSON schema and cannot be even completed without running full Resolver. - -.. note:: - When using the API to change configuration in runtime, your change can be rejected by the validation step even though Knot Resolver would start just fine with the given changed configuration. Some validation steps within the Resolver are dynamic and they are dependent on both your previous configuration and the new one. For example, if you try to change the management socket, the validation will fail even though the new provided address is perfectly valid. Chaning the management socket while running is not supported. - -Most of the validation is however static and you can use the ``kresctl validate`` command to check your configuration file for most errors before actually running the Resolver. - - -Interactive visualization -------------------------- - -The following visualization is interactive and offers good overview of the configuration structure. - -.. raw:: html - - Open in a new tab. - - - -Text-based configuration schema description -------------------------------------------- - -Following, you can find the JSON schema flattened textual representation. It's not meant to be read top-to-bottom, however it can be used as a quick lookup reference. - -.. mdinclude:: config-schema-body.md - diff --git a/doc/manager-kresctl.rst b/doc/manager-kresctl.rst deleted file mode 100644 index a5c2e143c..000000000 --- a/doc/manager-kresctl.rst +++ /dev/null @@ -1,20 +0,0 @@ -=============== -kresctl utility -=============== - -This command-line utility allows you to configure and control running Knot Resolver. -For that it uses the above mentioned HTTP API. - -For example, folowing command changes the number of ``kresd`` workers to 4. - -.. code-block:: - - $ kresctl config /workers 4 - -The utility can also help with configuration **validation** and with configuration format **conversion**. -For more information read full :ref:`kresctl documentation ` or use ``kresctl --help`` command. - -.. note:: - - With no changes in management configuration, ``kresctl`` should work out of the box. - In other case there is ``-s`` argument to specify path to HTTP API endpoint. \ No newline at end of file diff --git a/doc/manager-no-systemd.rst b/doc/manager-no-systemd.rst deleted file mode 100644 index 23f6465ec..000000000 --- a/doc/manager-no-systemd.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. SPDX-License-Identifier: GPL-3.0-or-later - -.. _manager-no-systemd: - -********************* -Usage without systemd -********************* diff --git a/doc/usecase-internal-resolver.rst b/doc/usecase-internal-resolver.rst deleted file mode 100644 index 90cfc6e04..000000000 --- a/doc/usecase-internal-resolver.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. SPDX-License-Identifier: GPL-3.0-or-later - -.. _usecase-internal-resolver: - -***************** -Internal Resolver -***************** - -When running the resolver for the local network, not much has to be changed and the configuration looks essentially the same as when running locally. - -.. code-block:: yaml - - rundir: /var/run/knot-resolver - workers: auto # run as many worker processes as there are available CPU cores - management: - unix-socket: /var/run/knot-resolver/manager.sock - cache: - storage: /var/cache/knot-resolver - size-max: 100MB - network: - listen: - - interface: 'eth0' - port: 53 - kind: 'dns' diff --git a/doc/usecase-isp-resolver.rst b/doc/usecase-isp-resolver.rst deleted file mode 100644 index 5812fd234..000000000 --- a/doc/usecase-isp-resolver.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. SPDX-License-Identifier: GPL-3.0-or-later - -.. _usecase-isp-resolver: - -************ -ISP Resolver -************ diff --git a/doc/usecase-network-interfaces.rst b/doc/usecase-network-interfaces.rst deleted file mode 100644 index 657fb6526..000000000 --- a/doc/usecase-network-interfaces.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. SPDX-License-Identifier: GPL-3.0-or-later - -.. _usecase-network-interfaces: - -******************************* -Listening on network interfaces -******************************* - -The first thing you will probably need to configure are the network interfaces to listen to. - -The following configuration instructs Knot Resolver to receive standard unencrypted DNS queries on IP addresses `192.0.2.1` and `2001:db8::1`. -Encrypted DNS queries are accepted using DNS-over-TLS protocol on all IP addresses configured on network interface `eth0`, TCP port 853. - -.. tabs:: - - .. group-tab:: |yaml| - - .. code-block:: yaml - - network: - listen: - - interface: ['192.0.2.1', '2001:db8::1'] # unencrypted DNS on port 53 is default - - interface: 'eth0' - port: 853 - kind: 'dot' - - .. group-tab:: |lua| - - Network interfaces to listen on and supported protocols are configured using :func:`net.listen()` function. - - .. code-block:: lua - - -- unencrypted DNS on port 53 is default - net.listen('192.0.2.1') - net.listen('2001:db8::1') - net.listen(net.eth0, 853, { kind = 'tls' }) - -.. warning:: - - On machines with multiple IP addresses on the same interface avoid listening on wildcards ``0.0.0.0`` or ``::``. - Knot Resolver could answer from different IP addresses if the network address ranges - overlap, and clients would refuse such a response. \ No newline at end of file diff --git a/doc/usecase-personal-resolver.rst b/doc/usecase-personal-resolver.rst deleted file mode 100644 index d51d039bf..000000000 --- a/doc/usecase-personal-resolver.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. SPDX-License-Identifier: GPL-3.0-or-later - -.. _usecase-personal-resolver: - -***************** -Personal Resolver -***************** - -For local usage on a single system, configuration like the following should be sufficient. Equivalent configuration is the default and should be packaged by your distribution of choice. - -.. code-block:: yaml - - rundir: /var/run/knot-resolver - workers: 1 - management: - unix-socket: /var/run/knot-resolver/manager.sock - cache: - storage: /var/cache/knot-resolver - size-max: 10MB - network: - listen: - - interface: 127.0.0.1@53 \ No newline at end of file