[sr-dev] git:master:40cd54b2: secsipid: docs for cache parameters

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 40cd54b2853667c0143ff96ae899991e6fdd30dc
URL: https://github.com/kamailio/kamailio/commit/40cd54b2853667c0143ff96ae899991e6fdd30dc

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-11-12T14:39:05+01:00

secsipid: docs for cache parameters

---

Modified: src/modules/secsipid/doc/secsipid_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/40cd54b2853667c0143ff96ae899991e6fdd30dc.diff
Patch: https://github.com/kamailio/kamailio/commit/40cd54b2853667c0143ff96ae899991e6fdd30dc.patch

---

diff --git a/src/modules/secsipid/doc/secsipid_admin.xml b/src/modules/secsipid/doc/secsipid_admin.xml
index 510da9159d..ca87f563b0 100644
--- a/src/modules/secsipid/doc/secsipid_admin.xml
+++ b/src/modules/secsipid/doc/secsipid_admin.xml
@@ -92,6 +92,46 @@ modparam("secsipid", "expire", 600)
 ...
 modparam("secsipid", "timeout", 2)
 ...
+</programlisting>
+		</example>
+	</section>
+	<section>
+		<title><varname>cache_dir</varname> (str)</title>
+		<para>
+		The path to the directory where to save cached pyblic keys. If set,
+		it activates the public key file caching in the libsecsipid library.
+		</para>
+		<para>
+		<emphasis>
+			Default value is "".
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>cache_dir</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("secsipid", "cache_dir", "/tmp/kamailio/secsipid")
+...
+</programlisting>
+		</example>
+	</section>
+	<section>
+		<title><varname>cache_expire</varname> (int)</title>
+		<para>
+		The interval in seconds after which a cached public key is considered
+		expired. This value is passed to the libsecsipid library.
+		</para>
+		<para>
+		<emphasis>
+			Default value is 3600.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>cache_expire</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("secsipid", "cache_expire", 7200)
+...
 </programlisting>
 		</example>
 	</section>