From: Oto Šťáva Date: Fri, 12 Jan 2024 15:21:31 +0000 (+0100) Subject: Update links to documentation X-Git-Tag: v6.0.6~11^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0f5d7bd18f46b657c71e3145d64ad3c80fb1cef4;p=thirdparty%2Fknot-resolver.git Update links to documentation Replaces all mentions of `knot-resolver.readthedocs.io` with `www.knot-resolver.cz/documentation/latest`. Some of the links used to point to the `latest` documentation, which meant the latest `master` commit, but the current system does not really allow us to do this, so instead we link to the latest stable (which is what `www.knot-resolver.cz/documentation/latest` basically is). We also cannot reliably get the documentation for a particular version in the code, so it all just points to `latest` as well. This may change in the future, although I do not yet have a good approach in mind (particularly, I don't want to bother our admins with nginx configuration updates for each newly released version). --- diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 02a3f552e..f5abec54b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -706,7 +706,7 @@ docs:develop: - doc/html environment: name: docs-develop/$CI_COMMIT_REF_NAME - url: https://$CI_PROJECT_NAMESPACE.pages.nic.cz/-/knot-resolver/-/jobs/$CI_JOB_ID/artifacts/doc/html/index.html + url: https://www.knot-resolver.cz/documentation/artifacts/$CI_JOB_ID/index.html # This job deploys the Knot Resolver documentation into a release environment, # which may be found at @@ -727,7 +727,7 @@ docs:release: - doc/html environment: name: docs-release/$CI_COMMIT_TAG - url: https://$CI_PROJECT_NAMESPACE.pages.nic.cz/-/knot-resolver/-/jobs/$CI_JOB_ID/artifacts/doc/html/index.html + url: https://www.knot-resolver.cz/documentation/artifacts/$CI_JOB_ID/index.html # This job deploys the current docs as pages: diff --git a/README.md b/README.md index 42fce0b4f..ade943ef7 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,24 @@ [![Build Status](https://gitlab.nic.cz/knot/knot-resolver/badges/nightly/pipeline.svg?x)](https://gitlab.nic.cz/knot/knot-resolver/commits/nightly) [![Coverage Status](https://gitlab.nic.cz/knot/knot-resolver/badges/nightly/coverage.svg?x)](https://knot.pages.nic.cz/knot-resolver/) -[![Documentation Status](https://readthedocs.org/projects/knot-resolver/badge/?version=latest)](https://readthedocs.org/projects/knot-resolver/?badge=latest) [![Packaging status](https://repology.org/badge/tiny-repos/knot-resolver.svg)](https://repology.org/project/knot-resolver/versions) Knot Resolver is a caching full resolver implementation written in C and [LuaJIT][luajit], both a resolver library and a daemon. The core architecture is tiny and efficient, and provides a foundation and -a state-machine like API for extensions. There are three modules built-in - *iterator*, *validator*, *cache*, and a few more are loaded by default. Most of the [rich features](https://knot-resolver.readthedocs.io/en/latest/config-overview.html) are written in Lua(JIT) and C. Batteries are included, but optional. +a state-machine like API for extensions. There are three modules built-in - *iterator*, *validator*, *cache*, and a few more are loaded by default. Most of the [rich features](https://www.knot-resolver.cz/documentation/latest/config-overview.html) are written in Lua(JIT) and C. Batteries are included, but optional. The LuaJIT modules, support DNS privacy and DNSSEC, and persistent cache with low memory footprint make it a great personal DNS resolver or a research tool to tap into DNS data. TL;DR it's the [OpenResty][openresty] of DNS. Strong filtering rules, and auto-configuration with etcd make it a great large-scale resolver solution. -The server adopts a [different scaling strategy][scaling] than the rest of the DNS recursors - no threading, shared-nothing architecture (except MVCC cache that may be shared) that allows you to pin instances on available CPU cores and grow by self-replication. You can start and stop additional nodes depending on the contention without downtime. +The server adopts a [different scaling strategy][scaling] than the rest of the DNS recursors - no threading, shared-nothing architecture (except MVCC cache that may be shared) that allows you to pin instances on available CPU cores and grow by self-replication. You can start and stop additional nodes depending on the contention without downtime, which is by default automated by the included [manager][manager]. It also has strong support for DNS over TCP, notably TCP Fast-Open, query pipelining and deduplication, and response reordering. ### Packages The latest stable packages for various distributions are available in our -[upstream repository](https://build.opensuse.org/package/show/home:CZ-NIC:knot-resolver-latest/knot-resolver). -Follow the -[installation instructions](https://software.opensuse.org//download.html?project=home%3ACZ-NIC%3Aknot-resolver-latest&package=knot-resolver) -to add this repository to your system. +[upstream repository](https://pkg.labs.nic.cz/doc/?project=knot-resolver). +Follow the installation instructions to add this repository to your system. Knot Resolver is also available from the following distributions' repositories. @@ -36,7 +33,7 @@ Knot Resolver is also available from the following distributions' repositories. ### Building from sources -Knot Resolver mainly [depends][depends] on Knot DNS libraries, [LuaJIT][luajit] and [libuv][libuv]. +Knot Resolver mainly [depends][depends] on Knot DNS libraries, [LuaJIT][luajit], and [libuv][libuv]. See the [Building project][depends] documentation page for more information. ### Docker image @@ -57,11 +54,12 @@ The project builds a resolver library in the `lib` directory, and a daemon in th $ kresd ``` -See the documentation at [knot-resolver.readthedocs.io][doc] for more options. +See the documentation at [knot-resolver.cz/documentation/latest][doc] for more options. -[depends]: https://knot-resolver.readthedocs.io/en/stable/build.html -[doc]: https://knot-resolver.readthedocs.io/en/stable/index.html -[scaling]: https://knot-resolver.readthedocs.io/en/stable/systemd-multiinst.html +[depends]: https://www.knot-resolver.cz/documentation/latest/build.html +[doc]: https://www.knot-resolver.cz/documentation/latest/ +[scaling]: https://www.knot-resolver.cz/documentation/latest/config-multiple-workers.html +[manager]: https://www.knot-resolver.cz/documentation/latest/architecture-manager.html [deckard]: https://gitlab.nic.cz/knot/deckard [luajit]: https://luajit.org/ [libuv]: http://libuv.org diff --git a/ci/respdiff/kresd.config b/ci/respdiff/kresd.config index 2b7b218cb..3d163d7e8 100644 --- a/ci/respdiff/kresd.config +++ b/ci/respdiff/kresd.config @@ -1,5 +1,5 @@ -- SPDX-License-Identifier: GPL-3.0-or-later --- Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +-- Refer to manual: https://www.knot-resolver.cz/documentation/latest/ -- Listen on localhost and external interface net.listen('127.0.0.1', 5353) net.listen('127.0.0.1', 8853, { tls = true }) diff --git a/daemon/lua/trust_anchors.lua.in b/daemon/lua/trust_anchors.lua.in index 56a7f9559..13e815690 100644 --- a/daemon/lua/trust_anchors.lua.in +++ b/daemon/lua/trust_anchors.lua.in @@ -20,7 +20,7 @@ local function upgrade_required(msg) msg = '' end panic('Configuration upgrade required: ' .. msg .. 'Please refer to ' .. - 'https://knot-resolver.readthedocs.io/en/stable/upgrading.html') + 'https://www.knot-resolver.cz/documentation/latest/upgrading.html') end -- TODO: Move bootstrap to a separate module or even its own binary diff --git a/distro/pkg/nix/default.nix b/distro/pkg/nix/default.nix index 6d975bf85..535106f39 100644 --- a/distro/pkg/nix/default.nix +++ b/distro/pkg/nix/default.nix @@ -53,7 +53,7 @@ unwrapped = stdenv.mkDerivation rec { nativeBuildInputs = [ pkg-config meson ninja ]; - # http://knot-resolver.readthedocs.io/en/latest/build.html#requirements + # http://www.knot-resolver.cz/documentation/latest/build.html#dependencies buildInputs = [ knot-dns lua.lua libuv gnutls lmdb ] ++ optionals stdenv.isLinux [ systemd libcap_ng ] ++ [ jemalloc nghttp2 ] diff --git a/doc/kresctl.8.in b/doc/kresctl.8.in index 5d5865007..538356afc 100644 --- a/doc/kresctl.8.in +++ b/doc/kresctl.8.in @@ -24,8 +24,8 @@ Knot Resolver via its HTTP API. Full documentation is available at -\fIhttps://knot-resolver.readthedocs.io\fR or in package documentation -(available as knot-resolver-doc package in most distributions. +\fIhttps://www.knot-resolver.cz/documentation/latest/\fR or in package +documentation (available as knot-resolver-doc package in most distributions. .SH OPTIONS The available options are: .TP @@ -61,7 +61,7 @@ Equivalent to PUT method in the underlying HTTP API. .B stop Gracefully stops the running resolver. .SH "SEE ALSO" -\fBkresd(8)\fR, @man_seealso_systemd@\fIhttps://knot-resolver.readthedocs.io/en/v@version@/\fR +\fBkresd(8)\fR, @man_seealso_systemd@\fIhttps://www.knot-resolver.cz/documentation/latest/\fR .SH "AUTHORS" .B kresd developers are mentioned in the AUTHORS file in the distribution. diff --git a/doc/kresd.8.in b/doc/kresd.8.in index b052a5afc..29d4ed9b4 100644 --- a/doc/kresd.8.in +++ b/doc/kresd.8.in @@ -64,8 +64,8 @@ and start The daemon may be configured also as a plain forwarder using query policies. This requires using a config file. Please refer to documentation for configuration file options. It is available at -\fIhttps://knot-resolver.readthedocs.io\fR or in package documentation -(available as knot-resolver-doc package in most distributions). +\fIhttps://www.knot-resolver.cz/documentation/latest/\fR or in package +documentation (available as knot-resolver-doc package in most distributions). The available CLI options are: .TP @@ -116,7 +116,7 @@ Show short command-line option help. .B \-V Show the version. .SH "SEE ALSO" -@man_seealso_systemd@\fIhttps://knot-resolver.readthedocs.io/en/v@version@/\fR +@man_seealso_systemd@\fIhttps://www.knot-resolver.cz/documentation/latest/\fR .SH "AUTHORS" .B kresd developers are mentioned in the AUTHORS file in the distribution. diff --git a/etc/config/config.cluster b/etc/config/config.cluster index 3bd12dd28..87873be48 100644 --- a/etc/config/config.cluster +++ b/etc/config/config.cluster @@ -4,7 +4,7 @@ -- In this case cache should be made as large as possible, and prefetching turned off -- as the resolver is busy most of the time. -- Alternative is using `etcd` as a configuration backend. --- Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +-- Refer to manual: https://www.knot-resolver.cz/documentation/latest/ -- Network interface configuration net.listen('127.0.0.1', 53, { kind = 'dns' }) diff --git a/etc/config/config.docker b/etc/config/config.docker index f631a545e..66683dbe5 100644 --- a/etc/config/config.docker +++ b/etc/config/config.docker @@ -1,6 +1,6 @@ -- SPDX-License-Identifier: CC0-1.0 -- vim:syntax=lua:set ts=4 sw=4: --- Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +-- Refer to manual: https://www.knot-resolver.cz/documentation/latest/ print('Knot Resolver ' .. package_version()) -- Smaller cache size diff --git a/etc/config/config.internal b/etc/config/config.internal index 46bbf173e..a83b2746f 100644 --- a/etc/config/config.internal +++ b/etc/config/config.internal @@ -1,7 +1,7 @@ -- SPDX-License-Identifier: CC0-1.0 -- vim:syntax=lua:set ts=4 sw=4: -- Config file example usable for multi-user ISP resolver --- Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +-- Refer to manual: https://www.knot-resolver.cz/documentation/latest/ -- Network interface configuration net.listen('127.0.0.1', 53, { kind = 'dns' }) diff --git a/etc/config/config.isp b/etc/config/config.isp index d4e2f9af9..b8600529a 100644 --- a/etc/config/config.isp +++ b/etc/config/config.isp @@ -1,7 +1,7 @@ -- SPDX-License-Identifier: CC0-1.0 -- vim:syntax=lua:set ts=4 sw=4: -- Config file example usable for ISP resolver --- Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +-- Refer to manual: https://www.knot-resolver.cz/documentation/latest/ -- Network interface configuration net.listen('127.0.0.1', 53, { kind = 'dns' }) diff --git a/etc/config/config.personal b/etc/config/config.personal index 961a2f660..a477a0e28 100644 --- a/etc/config/config.personal +++ b/etc/config/config.personal @@ -1,6 +1,6 @@ -- SPDX-License-Identifier: CC0-1.0 -- vim:syntax=lua:set ts=4 sw=4: --- Refer to manual: https://knot-resolver.readthedocs.org/en/stable/ +-- Refer to manual: https://www.knot-resolver.cz/documentation/latest/ -- Network interface configuration net.listen('127.0.0.1', 53, { kind = 'dns' }) diff --git a/etc/config/config.privacy b/etc/config/config.privacy index 6c14d7400..1711053ff 100644 --- a/etc/config/config.privacy +++ b/etc/config/config.privacy @@ -1,7 +1,7 @@ -- SPDX-License-Identifier: CC0-1.0 -- vim:syntax=lua:set ts=4 sw=4: -- Config file example usable for privacy-preserving resolver --- Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +-- Refer to manual: https://www.knot-resolver.cz/documentation/latest/ -- Network interface configuration net.listen('127.0.0.1', 53, { kind = 'dns' }) diff --git a/etc/config/config.splitview b/etc/config/config.splitview index a8a934481..0b8216a19 100644 --- a/etc/config/config.splitview +++ b/etc/config/config.splitview @@ -1,7 +1,7 @@ -- SPDX-License-Identifier: CC0-1.0 -- vim:syntax=lua:set ts=4 sw=4: -- Config file with split-view for internal zone --- Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +-- Refer to manual: https://www.knot-resolver.cz/documentation/latest/ -- Network interface configuration net.listen('127.0.0.1', 53, { kind = 'dns' }) diff --git a/lib/module.c b/lib/module.c index 83ae77370..79219d3a1 100644 --- a/lib/module.c +++ b/lib/module.c @@ -88,7 +88,7 @@ static int load_sym_c(struct kr_module *module, uint32_t api_required) /* In case someone re-compiled against new kresd * but haven't actually changed the symbols. */ kr_log_error(SYSTEM, "module %s requires upgrade. Please refer to " - "https://knot-resolver.readthedocs.io/en/stable/upgrading.html", + "https://www.knot-resolver.cz/documentation/latest/upgrading.html", module->name); return kr_error(ENOTSUP); } diff --git a/manager/etc/knot-resolver/config.example.internal.yaml b/manager/etc/knot-resolver/config.example.internal.yaml index 9c934af23..6c11b2c69 100644 --- a/manager/etc/knot-resolver/config.example.internal.yaml +++ b/manager/etc/knot-resolver/config.example.internal.yaml @@ -1,4 +1,4 @@ -# Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +# Refer to manual: https://www.knot-resolver.cz/documentation/latest/ network: listen: diff --git a/manager/etc/knot-resolver/config.example.isp.yaml b/manager/etc/knot-resolver/config.example.isp.yaml index 72b75e000..6f7fbe504 100644 --- a/manager/etc/knot-resolver/config.example.isp.yaml +++ b/manager/etc/knot-resolver/config.example.isp.yaml @@ -1,4 +1,4 @@ -# Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +# Refer to manual: https://www.knot-resolver.cz/documentation/latest/ network: listen: diff --git a/manager/etc/knot-resolver/config.example.personal.yaml b/manager/etc/knot-resolver/config.example.personal.yaml index a3df2c2a2..b7d11c1aa 100644 --- a/manager/etc/knot-resolver/config.example.personal.yaml +++ b/manager/etc/knot-resolver/config.example.personal.yaml @@ -1,4 +1,4 @@ -# Refer to manual: https://knot-resolver.readthedocs.io/en/stable/ +# Refer to manual: https://www.knot-resolver.cz/documentation/latest/ network: listen: diff --git a/manager/knot_resolver_manager/datamodel/design-notes.yml b/manager/knot_resolver_manager/datamodel/design-notes.yml index fb909acc9..e4424bc89 100644 --- a/manager/knot_resolver_manager/datamodel/design-notes.yml +++ b/manager/knot_resolver_manager/datamodel/design-notes.yml @@ -148,7 +148,7 @@ forward: # TODO: "name" is from Unbound, but @vcunat would prefer "subtree" or s - name: '.' # Root is the default so could be omitted? servers: [2001:148f:fffe::1, 2001:148f:ffff::1, 185.43.135.1, 193.14.47.1] # TLS forward, server authenticated using hostname and system-wide CA certificates - # https://knot-resolver.readthedocs.io/en/stable/modules-policy.html?highlight=forward#tls-examples + # https://www.knot-resolver.cz/documentation/latest/modules-policy.html?highlight=forward#tls-examples - name: '.' servers: - address: [ 192.0.2.1, 192.0.2.2@5353 ] @@ -234,4 +234,4 @@ forward: - subtree: 1.168.192.in-addr.arpa servers: [ 192.0.2.1@5353 ] options: - dnssec: false # policy.STUB? \ No newline at end of file + dnssec: false # policy.STUB? diff --git a/manager/knot_resolver_manager/datamodel/types/enums.py b/manager/knot_resolver_manager/datamodel/types/enums.py index cd45e1d60..bc93ae2fe 100644 --- a/manager/knot_resolver_manager/datamodel/types/enums.py +++ b/manager/knot_resolver_manager/datamodel/types/enums.py @@ -20,7 +20,7 @@ PolicyActionEnum = Literal[ "reqtrace", ] -# FLAGS from https://knot-resolver.readthedocs.io/en/stable/lib.html?highlight=options#c.kr_qflags +# FLAGS from https://www.knot-resolver.cz/documentation/latest/lib.html?highlight=options#c.kr_qflags PolicyFlagEnum = Literal[ "no-minimize", "no-ipv4", diff --git a/systemd/kresd.systemd.7.in b/systemd/kresd.systemd.7.in index a602b8e68..cb0a65feb 100644 --- a/systemd/kresd.systemd.7.in +++ b/systemd/kresd.systemd.7.in @@ -93,7 +93,7 @@ To start all enabled kresd daemons, you can also use the provided \fIkresd.targe .SH "SEE ALSO" \fIkresd(8)\fR, \fIsystemd.unit(5)\fR, -\fIhttps://knot-resolver.readthedocs.io/en/v@version@/\fR +\fIhttps://www.knot-resolver.cz/documentation/latest/\fR .SH "AUTHORS" .B kresd