Browse code

modules: readme files regenerated - secsipid ... [skip ci]

Kamailio Dev authored on 12/11/2020 13:46:14
Showing 1 changed files
... ...
@@ -28,6 +28,8 @@ Daniel-Constantin Mierla
28 28
 
29 29
               3.1. expire (int)
30 30
               3.2. timeout (int)
31
+              3.3. cache_dir (str)
32
+              3.4. cache_expire (int)
31 33
 
32 34
         4. Functions
33 35
 
... ...
@@ -41,9 +43,11 @@ Daniel-Constantin Mierla
41 43
 
42 44
    1.1. Set expire parameter
43 45
    1.2. Set timeout parameter
44
-   1.3. secsipid_check_identity usage
45
-   1.4. secsipid_add_identity usage
46
-   1.5. Libsecsipid usage
46
+   1.3. Set cache_dir parameter
47
+   1.4. Set cache_expire parameter
48
+   1.5. secsipid_check_identity usage
49
+   1.6. secsipid_add_identity usage
50
+   1.7. Libsecsipid usage
47 51
 
48 52
 Chapter 1. Admin Guide
49 53
 
... ...
@@ -59,6 +63,8 @@ Chapter 1. Admin Guide
59 63
 
60 64
         3.1. expire (int)
61 65
         3.2. timeout (int)
66
+        3.3. cache_dir (str)
67
+        3.4. cache_expire (int)
62 68
 
63 69
    4. Functions
64 70
 
... ...
@@ -95,6 +101,8 @@ Chapter 1. Admin Guide
95 101
 
96 102
    3.1. expire (int)
97 103
    3.2. timeout (int)
104
+   3.3. cache_dir (str)
105
+   3.4. cache_expire (int)
98 106
 
99 107
 3.1. expire (int)
100 108
 
... ...
@@ -120,6 +128,30 @@ modparam("secsipid", "expire", 600)
120 128
 modparam("secsipid", "timeout", 2)
121 129
 ...
122 130
 
131
+3.3. cache_dir (str)
132
+
133
+   The path to the directory where to save cached pyblic keys. If set, it
134
+   activates the public key file caching in the libsecsipid library.
135
+
136
+   Default value is "".
137
+
138
+   Example 1.3. Set cache_dir parameter
139
+...
140
+modparam("secsipid", "cache_dir", "/tmp/kamailio/secsipid")
141
+...
142
+
143
+3.4. cache_expire (int)
144
+
145
+   The interval in seconds after which a cached public key is considered
146
+   expired. This value is passed to the libsecsipid library.
147
+
148
+   Default value is 3600.
149
+
150
+   Example 1.4. Set cache_expire parameter
151
+...
152
+modparam("secsipid", "cache_expire", 7200)
153
+...
154
+
123 155
 4. Functions
124 156
 
125 157
    4.1. secsipid_check_identity(keyPath)
... ...
@@ -139,7 +171,7 @@ modparam("secsipid", "timeout", 2)
139 171
 
140 172
    This function can be used from ANY_ROUTE.
141 173
 
142
-   Example 1.3. secsipid_check_identity usage
174
+   Example 1.5. secsipid_check_identity usage
143 175
 ...
144 176
 request_route {
145 177
     ...
... ...
@@ -168,7 +200,7 @@ request_route {
168 200
 
169 201
    This function can be used from ANY_ROUTE.
170 202
 
171
-   Example 1.4. secsipid_add_identity usage
203
+   Example 1.6. secsipid_add_identity usage
172 204
 ...
173 205
 request_route {
174 206
     ...
... ...
@@ -192,7 +224,7 @@ request_route {
192 224
    installed and its environment configured, then run the following
193 225
    commands:
194 226
 
195
-   Example 1.5. Libsecsipid usage
227
+   Example 1.7. Libsecsipid usage
196 228
 ...
197 229
 go get https://github.com/asipto/secsipidx
198 230
 cd $GOPATH/src/github.com/asipto/secsipidx/csecsipid/