]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: .yml -> .yaml
authorVladimír Čunát <vladimir.cunat@nic.cz>
Sun, 23 Jul 2023 08:57:23 +0000 (10:57 +0200)
committerVladimír Čunát <vladimir.cunat@nic.cz>
Sun, 23 Jul 2023 09:00:13 +0000 (11:00 +0200)
At least in parts where it wouldn't conflict with other doc WIP.

doc/deployment-docker.rst
doc/deployment-manual.rst
doc/gettingstarted-config.rst
doc/manager-api.rst
doc/upgrading-to-6.rst

index 787a9b7a37e324000549f22b7faafe7e13c9a224..462ab061dd6a75926ed6580dda3948414351cbf3 100644 (file)
@@ -13,7 +13,7 @@ An official Docker image can be found on `Docker Hub <https://hub.docker.com/r/c
 
     docker run --rm -ti -P docker.io/cznic/knot-resolver
 
-The configuration file is located at ``/etc/knot-resolver/config.yml`` and the cache is at ``/var/cache/knot-resolver``. We recommend configuring a persistent cache across container restarts.
+The configuration file is located at ``/etc/knot-resolver/config.yaml`` and the cache is at ``/var/cache/knot-resolver``. We recommend configuring a persistent cache across container restarts.
 
 .. warning::
     
index d53a16926262cc466da0c45d8bdc56aa1504d319..cc8306e5aad7d67cdcf7821d3d1be7d01b74d968 100644 (file)
@@ -2,7 +2,7 @@
 Manual
 ******
 
-The Knot Resolver can be started with the command ``knot-resolver``. You can provide an optional argument ``--config path/to/config.yml`` to load a different than default configuration file.
+The Knot Resolver can be started with the command ``knot-resolver``. You can provide an optional argument ``--config path/to/config.yaml`` to load a different than default configuration file.
 
 The resolver does not have any external runtime dependencies and it should be able to run in most environments. It should be possible to wrap it with any container technology.
 
@@ -12,4 +12,4 @@ Multiple instances on a single server
 
 The only limitation for running multiple instances of Knot Resolver is that all instances must have a different runtime directory. There are however safeguards in place that should prevent accidental runtime directory conflicts.
 
-It is possible to share cache between multiple instances, just make sure that all instances have the same cache config and there is only a single garbage collector running (disable it in all but one config file).
\ No newline at end of file
+It is possible to share cache between multiple instances, just make sure that all instances have the same cache config and there is only a single garbage collector running (disable it in all but one config file).
index 8e81ffbd4bf61d9d95158c5ade2ee810da8409ea..63158a7d1e9afafe067dccc66b47ffe3644bcf61 100644 (file)
@@ -6,7 +6,7 @@
 Configuration
 *************
 
-Easiest way to configure Knot Resolver is to put YAML configuration in ``/etc/knot-resolver/config.yml`` file.
+Easiest way to configure Knot Resolver is to put YAML configuration in ``/etc/knot-resolver/config.yaml`` file.
 
 You can start exploring the configuration by continuing in this chapter or look at the complete :ref:`configuration <configuration-chapter>` documentation.
 
@@ -24,7 +24,7 @@ Examples are also installed as documentation files, typically in ``/usr/share/do
 
     .. code-block::
 
-        $ kresctl validate /etc/knot-resolver/config.yml
+        $ kresctl validate /etc/knot-resolver/config.yaml
 
 If you update the configuration file while Knot Resolver is running, you can force the resolver to **reload** it by invoking a ``systemd`` reload command.
 
@@ -260,4 +260,4 @@ See chapter :ref:`cache_persistence`.
 .. :ref:`operation-chapter` chapters.
 
 .. _`DNS Privacy Test Servers`: https://dnsprivacy.org/wiki/display/DP/DNS+Privacy+Test+Servers
-.. _tmpfs: https://en.wikipedia.org/wiki/Tmpfs
\ No newline at end of file
+.. _tmpfs: https://en.wikipedia.org/wiki/Tmpfs
index 592710903129a848f5a6ecfaa44cb977d9eee5a6..0001824d253e0e06e2d4496a14a37709d0506dcd 100644 (file)
@@ -14,7 +14,7 @@ You can use HTTP API to dynamically change configuration of already running Knot
 By default the API is configured as UNIX domain socket ``manager.sock`` located in the resolver's rundir (typically ``/run/knot-resolver/``).
 This socket is used by ``kresctl`` utility in default.
 
-The API setting can be changed only in ``/etc/knot-resolver/config.yml`` configuration file:
+The API setting can be changed only in ``/etc/knot-resolver/config.yaml`` configuration file:
 
 .. code-block:: yaml
 
index b8aa0831c14f2bfdfc5533e9aeb14ccfff05d4ad..1b8c874d2d7a90ed77b5cc77701c6696d161d1bd 100644 (file)
@@ -35,7 +35,7 @@ open logs of all instances                  ``journalctl -u knot-resolver``
 open log of a single kresd instances        ``journalctl -u knot-resolver _PID=xxx``                                                     ``journalctl -u kresd@1``
 updating config programatically             use HTTP API or ``kresctl`` command                                                          write a custom tool to generate new config and restart ``kresd``'s
 handling errors during config changes       HTTP API just reports error, resolver keeps running with previous config                     custom tools for every user
-validate new config                         ``kresctl validate path/to/new/config.yml`` (not fully bullet proof), then try to run it     run ``kresd`` with the config and see if it fails
-look at the Lua config                      ``kresctl convert path/to/new/config.yml``                                                   ``cat /path/to/config.conf``
+validate new config                         ``kresctl validate path/to/new/config.yaml`` (not fully bullet proof), then try to run it     run ``kresd`` with the config and see if it fails
+look at the Lua config                      ``kresctl convert path/to/new/config.yaml``                                                   ``cat /path/to/config.conf``
 gather metrics                              point Prometheus etc. at the single HTTP API                                                 collect metrics manually from all individual processes
-==========================================  ===========================================================================================  ==================================================================
\ No newline at end of file
+==========================================  ===========================================================================================  ==================================================================