-
Notifications
You must be signed in to change notification settings - Fork 909
/
topos_admin.xml
198 lines (191 loc) · 4.79 KB
/
topos_admin.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
%docentities;
]>
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section>
<title>Overview</title>
<para>
This module offers topology hiding by stripping the SIP routing
headers that show topology details.
The script interpreter gets the SIP messages with full content,
so all existing functionality is preserved.
</para>
<para>
The module is transparent for the configuration writer. It only needs to be
loaded (tune the parameters if needed).
</para>
<para>
It works for SIP MESSAGE requests.
</para>
</section>
<section>
<title>Dependencies</title>
<section>
<title>&kamailio; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>rr module</emphasis> - server must perform record
routing to ensure in-dialog requests are encoded/decoded.
</para>
</listitem>
<listitem>
<para>
<emphasis>database module</emphasis> - to store the data
for topology stripping and restoring.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before running
&kamailio; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>none</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Parameters</title>
<section id="topos.p.db_url">
<title><varname>db_url</varname> (str)</title>
<para>
Database URL.
</para>
<para>
<emphasis>
Default value is <quote>&defaultdb;</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>db_url</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("topos", "db_url", "&exampledb;")
...
</programlisting>
</example>
</section>
<section id="topos.p.mask_callid">
<title><varname>mask_callid</varname> (int)</title>
<para>
Note: this functionality is not implemented yet - the
parameter is present in order to be in pair with topoh
module.
</para>
<para>
Whether to replace or not the Call-ID with another
unique id generated by &kamailio;.
</para>
<para>
<emphasis>
Default value is 0 (do not mask).
</emphasis>
</para>
<example>
<title>Set <varname>mask_callid</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("topos", "mask_callid", 1)
...
</programlisting>
</example>
</section>
<section id="topos.p.sanity_checks">
<title><varname>sanity_checks</varname> (int)</title>
<para>
If set to 1, topoh module will bind to sanity module in order
to perform sanity checks over received SIP request. Default
sanity checks are done. It is useful to check if received request
is well formated before proceeding to encoding/decoding.
</para>
<para>
<emphasis>
Default value is 0 (do not bind to sanity module).
</emphasis>
</para>
<example>
<title>Set <varname>sanity_checks</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("topoh", "sanity_checks", 1)
...
</programlisting>
</example>
</section>
<section id="topos.p.branch_expires">
<title><varname>branch_expires</varname> (int)</title>
<para>
Interval in seconds after which the branch records are deleted.
</para>
<para>
<emphasis>
Default value is 180 (3 min).
</emphasis>
</para>
<example>
<title>Set <varname>branch_expires</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("topos", "branch_expires", 300)
...
</programlisting>
</example>
</section>
<section id="topos.p.branch_dialog">
<title><varname>branch_dialog</varname> (int)</title>
<para>
Interval in seconds after which the dialog records are deleted.
</para>
<para>
<emphasis>
Default value is 10800 (3 hours).
</emphasis>
</para>
<example>
<title>Set <varname>branch_dialog</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("topos", "branch_dialog", 3600)
...
</programlisting>
</example>
</section>
<section id="topos.p.clean_interval">
<title><varname>clean_inteval</varname> (int)</title>
<para>
Interval in seconds to run the clean up of stored
records.
</para>
<para>
<emphasis>
Default value is 60 (1 min).
</emphasis>
</para>
<example>
<title>Set <varname>clean_interval</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("topos", "clean_interval", 30)
...
</programlisting>
</example>
</section>
</section>
</chapter>