From: Vladimír Čunát <vladimir.cunat@nic.cz>
Date: Tue, 3 Oct 2023 08:16:42 +0000 (+0200)
Subject: doc/config-local-data: begin with typical examples
X-Git-Tag: v6.0.5~9^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ad3c5f4df403a603c22a4c5f7a942838162f3c51;p=thirdparty%2Fknot-resolver.git

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.
---

diff --git a/doc/config-local-data.rst b/doc/config-local-data.rst
index 1e4520212..242931058 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>