At least in parts where it wouldn't conflict with other doc WIP.
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::
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.
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).
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.
.. 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.
.. :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
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
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
+========================================== =========================================================================================== ==================================================================