You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/modules_s/pdt/doc/pdt.xml

103 lines
2.8 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<section id="pdt" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
<authorgroup>
<author>
<firstname>Elena-Ramona</firstname>
<surname>Modroiu</surname>
<affiliation><orgname>Asipto</orgname></affiliation>
<address>
<email>ramona@asipto.com</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2003</year>
<holder>FhG FOKUS</holder>
</copyright>
</sectioninfo>
<title>PDT module</title>
<section id="pdt.overview">
<title>Overview</title>
<para>
This module translates a numerical prefix into a domain and updates
accordingly the request URI.
</para>
<para>
The module looks up at the Request-URI part of a message and if the
user part begins with an established prefix it will update the
URI. Updating the uri consists of: remove the prefix from the
user part of the uri and keep the rest as the user part of the new
uri. The host and port are changed with the domain matched for the
leading prefix.
</para>
<para>
&lt;prefix&gt;&lt;userid&gt;&lt;:password&gt;@&lt;mydomain.com&gt; ...
</para>
<para>
and the result will be:
</para>
<para>
&lt;userid&gt;&lt;:password&gt;@&lt;domain[:port]&gt;...
</para>
<example>
<title>prefix-domain translation</title>
<programlisting>
prefix=123
domain[123]=alpha.org
sip:12391001@mydomain.com => sip:91001@alpha.org
</programlisting>
</example>
<para>
The prefix could be prefixed by other digits. These digits will not
be used to look up the domain (the classic example, 00 used for
international calls, then follows the country prefix). For more
information on this, see 'prefix' parameter.
</para>
<itemizedlist>
<listitem>
<para>
A sample config file and the <acronym>MySQL</acronym>
script to create the database needed by PDT are located in
'./doc/'.
</para>
</listitem>
<listitem>
<para>
Sample shell scripts to manage prefix-domain pairs are also located
in './doc/' (pdt_fifo_add.sh, pdt_fifo_delete.sh, pdt_fifo_list.sh).
</para>
</listitem>
</itemizedlist>
</section>
<section id="pdt.dep">
<title>Dependencies</title>
<section>
<title>SER Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>A SER database module (e.g., mysql,
dbtext)</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<xi:include href="params.xml"/>
<xi:include href="functions.xml"/>
<xi:include href="fifo.xml"/>
</section>