kamailio / kamailio-wiki

Kamailio Wiki with content in markdown format

Kamailio Wiki

Kamailio Wiki with content in markdown format.

• Browse Wiki HTML Pages On Kamailio.Org

• Browse Wiki Pages On Github

Initial content was converted from the Dokuwiki at:

• https://www.kamailio.org/wiki/

Support

To update the content, make a pull request at:

• https://github.com/kamailio/kamailio-wiki

The wiki pages are inside the docs/ folder.

Questions and discussions about the wiki content have to be done via our mailing list:

• sr-users (at) lists.kamailio.org

Thanks for flying Kamailio!

kamailio-wiki's Issues

forward(host, port) - does it exist?

https://www.kamailio.org/wikidocs/cookbooks/devel/core/#forward says that forward() does not have a form with parameters, or at least it says nothing about this form.

https://www.kamailio.org/docs/modules/devel/modules/tm.html#tm.f.t_relay says: “t_relay() is the stateful version for forward() while t_relay(host, port) is similar to forward(host, port). ”

This suggests, that the forward(host, port) form does exist.

Please adjust either the documentation of the core cookbook or of TM, on whether forward(host, port) exists.

No documentation for `description`

See https://www.kamailio.org/wikidocs/cookbooks/devel/core/#description . What is description=ABC good for?

Incorrect upper limit value for `max_branches`

The following is the definition for the max_branches parameter:

max_branches
The maximum number of outgoing branches for each SIP request. It has impact on the size of destination set created in core (e.g., via append_branch()) as well as the serial and parallel forking done via tm module. It replaces the old defined constant MAX_BRANCHES.

The value has to be at least 1 and the upper limit is 31.

Default value: 12

Example of usage:

max_branches=16

However the code appears to limit this at 30:

       /* checking if we have sufficient bitmap capacity for given
         * maximum number of  branches */
        if (sr_dst_max_branches+1>31) {
                LM_CRIT("Too many max UACs for UAC branch_bm_t bitmap: %d\n",
                                sr_dst_max_branches );
                return -1;
        }

Preparing a pull request to update the documentation.

#!KAMAILIO compatibility mode is not documented

The meaning of #!KAMAILIO in the configuration file is nowhere documented, in particular it is not in the core cookbook It is mentioned only at https://www.kamailio.org/docs/modules/devel/modules/tm.html#tm.p.fr_timer_avp and in misc/NEWS under sip-router 3.0 changes → config script changes.

To be honest, I have deleted #!KAMAILIO from my configuration file, since the lack of documentation for this directive implied to me, that #!KAMAILIO does nothing.

Please document what #!KAMAILIO does and at best make it the default.

Unclear default value for dns_try_ipv6

According to https://www.kamailio.org/wikidocs/cookbooks/devel/core/#dns_try_ipv6 the default value for dns_try_ipv6 is no.

https://www.kamailio.org/wikidocs/cookbooks/devel/core suggests reading the file doc/tutorials/dns.txt for details about Kamailio's DNS client.

doc/tutorials/dns.txt contains:

dns_try_ipv6 = on | off … Default: on if Kamailio is compiled with ipv6 support.

So depending on the source the default value of dns_try_ipv6 is different.

images links broken

https://www.kamailio.org/wikidocs/cookbooks/devel/pseudovariables/

there's a pseudovariables.png in the same folder as the .md but the generated doc has a trailing slash, should we move it to a sub folder? then it will break the display on https://github.com/kamailio/kamailio-wiki/blob/main/docs/cookbooks/devel/pseudovariables.md

or maybe create a symbol link?

modparam("…|…", "…", "…") - pipe symbol is not documented

The core cookbook - https://www.kamailio.org/wikidocs/cookbooks/devel/core/ - contains this example:

modparam("acc|auth_db|usrloc", "db_url", "mysql://kamailio:kamailiorw@localhost/kamailio_testbed")

Examples with the pipe symbol in the first parameter of modparam are shown also on other places.

It is not documented, by means of written down words, what does the pipe symbol in modparam("|") do.

Using `break` outside of `case`

https://www.kamailio.org/wikidocs/cookbooks/devel/core/ says about break:

'break' statement can be used to end a 'case' block in a 'switch' statement or exit from a 'while' statement.

…

IMPORTANT NOTE: break can be used only to mark the end of a case branch (as it is in shell scripts). If you are trying to use break outside a case block the script will return error -- you must use return there.

https://www.kamailio.org/docs/modules/devel/modules/tm.html contains examples with break, like:

request_route {
  seturi("sip:[email protected]");
  append_branch("sip:[email protected]");
  append_branch("sip:[email protected]");
  append_branch("sip:[email protected]");

  t_relay();
  break;
}

Either the definition for break is wrong, or the four tm-examples are incorrect.

The cited documentation is contradicting itself on whether break can be used in while.

possible dead links

output of mkdocs rule

INFO    -  Doc file 'cookbooks/start.md' contains an unrecognized relative link '../index#cookbooks.md', it was left as is. Did you mean '../index.md#cookbooks.md'?
INFO    -  Doc file 'cookbooks/3.2.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/3.2.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/3.3.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/3.3.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/4.0.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/4.0.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/4.0.x/core/cfg.md' contains an unrecognized relative link 'cfg#c-style_control_directives', it was left as is. Did you mean '#c-style_control_directives'?
INFO    -  Doc file 'cookbooks/4.0.x/core/cfg.md' contains an unrecognized relative link '..//core#core_parameters', it was left as is. Did you mean '../core.md#core_parameters'?
INFO    -  Doc file 'cookbooks/4.1.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/4.1.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/4.2.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/4.2.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/4.3.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/4.3.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/4.4.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/4.4.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/5.0.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/5.0.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/5.1.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/5.1.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/5.2.x/core.md' contains an unrecognized relative link '../cookbooks/5.2.x/core#define.md', it was left as is.
INFO    -  Doc file 'cookbooks/5.2.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/5.2.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/5.3.x/core.md' contains an unrecognized relative link '../cookbooks/5.2.x/core#define.md', it was left as is.
INFO    -  Doc file 'cookbooks/5.3.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/5.3.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/5.4.x/core.md' contains an unrecognized relative link '../cookbooks/5.2.x/core#define.md', it was left as is.
INFO    -  Doc file 'cookbooks/5.4.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/5.4.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/5.5.x/core.md' contains an unrecognized relative link '../cookbooks/5.2.x/core#define.md', it was left as is.
INFO    -  Doc file 'cookbooks/5.5.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/5.5.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/5.6.x/core.md' contains an unrecognized relative link '../cookbooks/5.2.x/core#define.md', it was left as is.
INFO    -  Doc file 'cookbooks/5.6.x/core.md' contains an unrecognized relative link 'devel#retcode', it was left as is.
INFO    -  Doc file 'cookbooks/5.6.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/5.7.x/core.md' contains an unrecognized relative link '../cookbooks/5.2.x/core#define.md', it was left as is.
INFO    -  Doc file 'cookbooks/5.7.x/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'cookbooks/devel/core.md' contains an unrecognized relative link '../cookbooks/5.2.x/core#define.md', it was left as is.
INFO    -  Doc file 'cookbooks/devel/core.md' contains an unrecognized relative link 'devel#exit', it was left as is.
INFO    -  Doc file 'devel/git-access.md' contains an unrecognized relative link '../start#guidelines.md', it was left as is.
INFO    -  Doc file 'devel/how-to/main.md' contains an absolute link '/devel/how-to/internal-lib', it was left as is. Did you mean 'internal-lib.md'?
INFO    -  Doc file 'devel/how-to/main.md' contains an absolute link '/devel/how-to/module-readme', it was left as is. Did you mean 'module-readme.md'?
INFO    -  Doc file 'devel/how-to/main.md' contains an absolute link '/devel/how-to/source-tree-run', it was left as is. Did you mean 'source-tree-run.md'?
INFO    -  Doc file 'devel/how-to/main.md' contains an absolute link '/devel/how-to/install-custom-path', it was left as is. Did you mean 'install-custom-path.md'?
INFO    -  Doc file 'devel/irc-meetings/2013b.md' contains an absolute link '/devel/irc-meetings/2013blog', it was left as is. Did you mean '2013blog.md'?
INFO    -  Documentation built in 86.79 seconds

Dead link: up to date list of selects

https://www.kamailio.org/wikidocs/cookbooks/devel/selects/#complete-select-list contains:

## Complete Select List

**For a list with all the selects defined in the devel version (the
master branch) see the auto-generated
<http://sip-router.org/docbook/sip-router/branch/master/select_list/select_list.html>.**

The list presented on this page is **obsolete**.

The link http://sip-router.org/docbook/sip-router/branch/master/select_list/select_list.html does not exist.