Skip to content

Commit

Permalink
modules: readme files regenerated - secsipid ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev committed Nov 12, 2020
1 parent 40cd54b commit 8c16055
Showing 1 changed file with 38 additions and 6 deletions.
44 changes: 38 additions & 6 deletions src/modules/secsipid/README
Expand Up @@ -28,6 +28,8 @@ Daniel-Constantin Mierla

3.1. expire (int)
3.2. timeout (int)
3.3. cache_dir (str)
3.4. cache_expire (int)

4. Functions

Expand All @@ -41,9 +43,11 @@ Daniel-Constantin Mierla

1.1. Set expire parameter
1.2. Set timeout parameter
1.3. secsipid_check_identity usage
1.4. secsipid_add_identity usage
1.5. Libsecsipid usage
1.3. Set cache_dir parameter
1.4. Set cache_expire parameter
1.5. secsipid_check_identity usage
1.6. secsipid_add_identity usage
1.7. Libsecsipid usage

Chapter 1. Admin Guide

Expand All @@ -59,6 +63,8 @@ Chapter 1. Admin Guide

3.1. expire (int)
3.2. timeout (int)
3.3. cache_dir (str)
3.4. cache_expire (int)

4. Functions

Expand Down Expand Up @@ -95,6 +101,8 @@ Chapter 1. Admin Guide

3.1. expire (int)
3.2. timeout (int)
3.3. cache_dir (str)
3.4. cache_expire (int)

3.1. expire (int)

Expand All @@ -120,6 +128,30 @@ modparam("secsipid", "expire", 600)
modparam("secsipid", "timeout", 2)
...

3.3. cache_dir (str)

The path to the directory where to save cached pyblic keys. If set, it
activates the public key file caching in the libsecsipid library.

Default value is "".

Example 1.3. Set cache_dir parameter
...
modparam("secsipid", "cache_dir", "/tmp/kamailio/secsipid")
...

3.4. cache_expire (int)

The interval in seconds after which a cached public key is considered
expired. This value is passed to the libsecsipid library.

Default value is 3600.

Example 1.4. Set cache_expire parameter
...
modparam("secsipid", "cache_expire", 7200)
...

4. Functions

4.1. secsipid_check_identity(keyPath)
Expand All @@ -139,7 +171,7 @@ modparam("secsipid", "timeout", 2)

This function can be used from ANY_ROUTE.

Example 1.3. secsipid_check_identity usage
Example 1.5. secsipid_check_identity usage
...
request_route {
...
Expand Down Expand Up @@ -168,7 +200,7 @@ request_route {

This function can be used from ANY_ROUTE.

Example 1.4. secsipid_add_identity usage
Example 1.6. secsipid_add_identity usage
...
request_route {
...
Expand All @@ -192,7 +224,7 @@ request_route {
installed and its environment configured, then run the following
commands:

Example 1.5. Libsecsipid usage
Example 1.7. Libsecsipid usage
...
go get https://github.com/asipto/secsipidx
cd $GOPATH/src/github.com/asipto/secsipidx/csecsipid/
Expand Down

0 comments on commit 8c16055

Please sign in to comment.