summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVladimír Čunát <vladimir.cunat@nic.cz>2023-10-03 10:16:42 +0200
committerVladimír Čunát <vladimir.cunat@nic.cz>2023-11-26 08:50:00 +0100
commitad3c5f4df403a603c22a4c5f7a942838162f3c51 (patch)
treec4145cc6eab8cf9de56cf491be64748d29afea74
parentMerge !1472: ci/images/debian-12: add Debian 12 CI image for future use (diff)
downloadknot-resolver-ad3c5f4df403a603c22a4c5f7a942838162f3c51.tar.xz
knot-resolver-ad3c5f4df403a603c22a4c5f7a942838162f3c51.zip
doc/config-local-data: begin with typical examples
This doc page is relatively complex and it will only get longer in future, but I expect that 90% of users will be OK with just these simple examples.
-rw-r--r--doc/config-local-data.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/config-local-data.rst b/doc/config-local-data.rst
index 1e452021..24293105 100644
--- a/doc/config-local-data.rst
+++ b/doc/config-local-data.rst
@@ -8,6 +8,21 @@ Local Data and RPZ
Local overrides for DNS data may be defined in the :option:`local-data <local-data:>` configuration tree.
It provides various input formats described in following subsections.
+.. code-block:: yaml
+
+ # Some typical use cases:
+ local-data:
+ addresses:
+ a1.example.com: 2001:db8::1
+ a2.example.org: [ 192.0.2.2, 192.0.2.3, 2001:db8::4 ]
+ addresses-files:
+ - /etc/hosts
+ records: |
+ www.google.com. CNAME forcesafesearch.google.com.
+ rpz:
+ - file: /tmp/blocklist.rpz
+
+
.. option:: local-data:
.. option:: ttl: <time ms|s|m|h|d>