From 9b3b8ec968c6f7bda0d10a0d4fe593a92560ee7d Mon Sep 17 00:00:00 2001
From: Daniel-Constantin Mierla <miconda@gmail.com>
Date: Sat, 6 Apr 2024 08:35:19 +0200
Subject: [PATCH] corex: docs for dns_file parameter

---
 src/modules/corex/doc/corex_admin.xml | 36 ++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/src/modules/corex/doc/corex_admin.xml b/src/modules/corex/doc/corex_admin.xml
index d5cfe1db477..3cdad0aa2a5 100644
--- a/src/modules/corex/doc/corex_admin.xml
+++ b/src/modules/corex/doc/corex_admin.xml
@@ -162,6 +162,41 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
 modparam("corex", "dns_cache", "type=A;name=kamailio.org;addr=193.22.119.66;ttl=3600000;flags=0")
 modparam("corex", "dns_cache", "type=AAAA;name=kamailio.org;addr=2a00:d60:0:400::2;ttl=3600000;flags=0")
 ...
+</programlisting>
+	    </example>
+	</section>
+	<section id="corex.p.dns_file">
+	    <title><varname>dns_file</varname> (string)</title>
+	    <para>
+		Path to the file from where to load dns_cache records. It can be set
+		many times to add more than one file.
+	    </para>
+	    <para>
+	    Inside the file, the dns_cache record has to be in a single line, with
+	    the format of the dns_cache module parameter (see above). Empty lines
+	    or lines with whitespaces only are ignored. Comment lines have to start
+	    with '#'. Comments are not accepted after dns_cache records, only on
+	    separate lines.
+	    </para>
+	    <para>
+		<emphasis>
+		    Default value is <quote>NULL</quote>.
+		</emphasis>
+	    </para>
+	    <example>
+		<title>Set <varname>dns_file</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+# content of /etc/kamailio/kamailio-cache.dns
+
+# IPv4 record
+type=A;name=kamailio.org;addr=193.22.119.66;ttl=3600000;flags=0
+# IPv6 record
+type=AAAA;name=kamailio.org;addr=2a00:d60:0:400::2;ttl=3600000;flags=0
+...
+...
+modparam("corex", "dns_file", "/etc/kamailio/kamailio-cache.dns")
+...
 </programlisting>
 	    </example>
 	</section>
@@ -1291,4 +1326,3 @@ sub do_uncompress() {
         </example>
     </section>
 </chapter>
-