55b024c69ce7a05a787759a8a76ecd6070797ae8
[asterisk/asterisk.git] / configs / iax.conf.sample
1
2 ; Inter-Asterisk eXchange driver definition
3 ;
4 ; This configuration is re-read at reload
5 ; or with the CLI command
6 ;       reload chan_iax2.so
7 ;
8 ; General settings, like port number to bind to, and
9 ; an option address (the default is to bind to all
10 ; local addresses).
11 ;
12 [general]
13 ;bindport=4569                  ; bindport and bindaddr may be specified
14 ;                               ; NOTE: bindport must be specified BEFORE bindaddr
15 ;                               ; or may be specified on a specific bindaddr if followed by
16 ;                               ; colon and port (e.g. bindaddr=192.168.0.1:4569)
17 ;bindaddr=192.168.0.1           ; more than once to bind to multiple
18 ;                               ; addresses, but the first will be the 
19 ;                               ; default
20 ;
21 ; Set iaxcompat to yes if you plan to use layered switches or
22 ; some other scenario which may cause some delay when doing a
23 ; lookup in the dialplan. It incurs a small performance hit to
24 ; enable it. This option causes Asterisk to spawn a separate thread
25 ; when it receives an IAX DPREQ (Dialplan Request) instead of
26 ; blocking while it waits for a response.
27 ;
28 ;iaxcompat=yes
29 ;
30 ; Disable UDP checksums (if nochecksums is set, then no checkums will
31 ; be calculated/checked on systems supporting this feature)
32 ;
33 ;nochecksums=no
34 ;
35 ;
36 ; For increased security against brute force password attacks
37 ; enable "delayreject" which will delay the sending of authentication
38 ; reject for REGREQ or AUTHREP if there is a password.  
39 ;
40 ;delayreject=yes
41 ;
42 ; You may specify a global default AMA flag for iaxtel calls.  It must be
43 ; one of 'default', 'omit', 'billing', or 'documentation'.  These flags
44 ; are used in the generation of call detail records.
45 ;
46 ;amaflags=default
47 ;
48 ; You may specify a default account for Call Detail Records in addition
49 ; to specifying on a per-user basis
50 ;
51 ;accountcode=lss0101
52 ;
53 ; You may specify a global default language for users. 
54 ; Can be specified also on a per-user basis
55 ; If omitted, will fallback to english
56 ;
57 ;language=en
58 ;
59 ; Specify bandwidth of low, medium, or high to control which codecs are used
60 ; in general.
61 ;
62 bandwidth=low
63 ;
64 ; You can also fine tune codecs here using "allow" and "disallow" clauses
65 ; with specific codecs.  Use "all" to represent all formats.
66 ;
67 ;allow=all                      ; same as bandwidth=high
68 ;disallow=g723.1                ; Hm...  Proprietary, don't use it...
69 disallow=lpc10                  ; Icky sound quality...  Mr. Roboto.
70 ;allow=gsm                      ; Always allow GSM, it's cool :)
71 ;
72
73 ; You can adjust several parameters relating to the jitter buffer.
74 ; The jitter buffer's function is to compensate for varying
75 ; network delay.
76 ;
77 ; There are presently two jitterbuffer implementations available for Asterisk
78 ; and chan_iax2; the classic and the new, channel/application independent
79 ; implementation.  These are controlled at compile-time.  The new jitterbuffer
80 ; additionally has support for PLC which greatly improves quality as the
81 ; jitterbuffer adapts size, and in compensating for lost packets.
82 ;
83 ; All the jitter buffer settings except dropcount are in milliseconds.
84 ; The jitter buffer works for INCOMING audio - the outbound audio
85 ; will be dejittered by the jitter buffer at the other end.
86 ;
87 ; jitterbuffer=yes|no: global default as to whether you want
88 ; the jitter buffer at all.
89 ;
90 ; forcejitterbuffer=yes|no: in the ideal world, when we bridge VoIP channels
91 ; we don't want to do jitterbuffering on the switch, since the endpoints
92 ; can each handle this.  However, some endpoints may have poor jitterbuffers 
93 ; themselves, so this option will force * to always jitterbuffer, even in this
94 ; case.
95 ; [This option presently applies only to the new jitterbuffer implementation]
96 ;
97 ; dropcount: the jitter buffer is sized such that no more than "dropcount"
98 ; frames would have been "too late" over the last 2 seconds.
99 ; Set to a small number.  "3" represents 1.5% of frames dropped
100 ; [This option is not applicable to, and ignored by the new jitterbuffer implementation]
101 ;
102 ; maxjitterbuffer: a maximum size for the jitter buffer.
103 ; Setting a reasonable maximum here will prevent the call delay
104 ; from rising to silly values in extreme situations; you'll hear
105 ; SOMETHING, even though it will be jittery.
106 ;
107 ; resyncthreshold: when the jitterbuffer notices a significant change in delay
108 ; that continues over a few frames, it will resync, assuming that the change in
109 ; delay was caused by a timestamping mix-up. The threshold for noticing a
110 ; change in delay is measured as twice the measured jitter plus this resync
111 ; threshold.
112 ; Resyncing can be disabled by setting this parameter to -1.
113 ; [This option presently applies only to the new jitterbuffer implementation]
114 ;
115 ; maxjitterinterps: the maximum number of interpolation frames the jitterbuffer
116 ; should return in a row. Since some clients do not send CNG/DTX frames to
117 ; indicate silence, the jitterbuffer will assume silence has begun after
118 ; returning this many interpolations. This prevents interpolating throughout
119 ; a long silence.
120 ; [This option presently applies only to the new jitterbuffer implementation]
121 ;
122 ; maxexcessbuffer: If conditions improve after a period of high jitter,
123 ; the jitter buffer can end up bigger than necessary.  If it ends up
124 ; more than "maxexcessbuffer" bigger than needed, Asterisk will start
125 ; gradually decreasing the amount of jitter buffering.
126 ; [This option is not applicable to, and ignored by the new jitterbuffer implementation]
127 ;
128 ; minexcessbuffer: Sets a desired mimimum amount of headroom in 
129 ; the jitter buffer.  If Asterisk has less headroom than this, then
130 ; it will start gradually increasing the amount of jitter buffering.
131 ; [This option is not applicable to, and ignored by the new jitterbuffer implementation]
132 ;
133 ; jittershrinkrate: when the jitter buffer is being gradually shrunk 
134 ; (or enlarged), how many millisecs shall we take off per 20ms frame
135 ; received?  Use a small number, or you will be able to hear it
136 ; changing.  An example: if you set this to 2, then the jitter buffer
137 ; size will change by 100 millisecs per second.
138 ; [This option is not applicable to, and ignored by the new jitterbuffer implementation]
139
140 jitterbuffer=no
141 forcejitterbuffer=no
142 ;dropcount=2
143 ;maxjitterbuffer=1000
144 ;maxjitterinterps=10
145 ;resyncthreshold=1000
146 ;maxexcessbuffer=80
147 ;minexcessbuffer=10
148 ;jittershrinkrate=1
149
150 ;trunkfreq=20                   ; How frequently to send trunk msgs (in ms)
151
152 ; Should we send timestamps for the individual sub-frames within trunk frames?
153 ; There is a small bandwidth use for these (less than 1kbps/call), but they
154 ; ensure that frame timestamps get sent end-to-end properly.  If both ends of
155 ; all your trunks go directly to TDM, _and_ your trunkfreq equals the frame
156 ; length for your codecs, you can probably suppress these.  The receiver must
157 ; also support this feature, although they do not also need to have it enabled.
158 ;
159 ; trunktimestamps=yes
160 ;
161 ; Minimum and maximum amounts of time that IAX peers can request as
162 ; a registration expiration interval (in seconds).
163 ; minregexpire = 60
164 ; maxregexpire = 60
165 ;
166 ; IAX helper threads
167 ; Establishes the number of iax helper threads to handle I/O.
168 ; iaxthreadcount = 10
169 ;
170 ; We can register with another IAX server to let him know where we are
171 ; in case we have a dynamic IP address for example
172 ;
173 ; Register with tormenta using username marko and password secretpass
174 ;
175 ;register => marko:secretpass@tormenta.linux-support.net
176 ;
177 ; Register joe at remote host with no password
178 ;
179 ;register => joe@remotehost:5656
180 ;
181 ; Register marko at tormenta.linux-support.net using RSA key "torkey"
182 ;
183 ;register => marko:[torkey]@tormenta.linux-support.net
184 ;
185 ; Sample Registration for iaxtel
186 ;
187 ; Visit http://www.iaxtel.com to register with iaxtel.  Replace "user"
188 ; and "pass" with your username and password for iaxtel.  Incoming 
189 ; calls arrive at the "s" extension of "default" context.
190 ;
191 ;register => user:pass@iaxtel.com
192 ;
193 ; Sample Registration for IAX + FWD
194 ;
195 ; To register using IAX with FWD, it must be enabled by visiting the URL
196 ; http://www.fwdnet.net/index.php?section_id=112
197 ;
198 ; Note that you need an extension in you default context which matches
199 ; your free world dialup number.  Please replace "FWDNumber" with your
200 ; FWD number and "passwd" with your password.
201 ;
202 ;register => FWDNumber:passwd@iax.fwdnet.net
203 ;
204 ;
205 ; You can disable authentication debugging to reduce the amount of 
206 ; debugging traffic.
207 ;
208 ;authdebug=no
209 ;
210 ; See doc/README.tos for a description of the tos parameters.
211 ;tos=ef
212 ;
213 ; If regcontext is specified, Asterisk will dynamically create and destroy
214 ; a NoOp priority 1 extension for a given peer who registers or unregisters
215 ; with us.  The actual extension is the 'regexten' parameter of the registering
216 ; peer or its name if 'regexten' is not provided.  More than one regexten
217 ; may be supplied if they are separated by '&'.  Patterns may be used in
218 ; regexten.
219 ;
220 ;regcontext=iaxregistrations
221 ;
222 ; If we don't get ACK to our NEW within 2000ms, and autokill is set to yes,
223 ; then we cancel the whole thing (that's enough time for one retransmission
224 ; only).  This is used to keep things from stalling for a long time for a host
225 ; that is not available, but would be ill advised for bad connections.  In
226 ; addition to 'yes' or 'no' you can also specify a number of milliseconds.
227 ; See 'qualify' for individual peers to turn on for just a specific peer.
228 ;
229 autokill=yes
230 ;
231 ; codecpriority controls the codec negotiation of an inbound IAX call.
232 ; This option is inherited to all user entities.  It can also be defined 
233 ; in each user entity separately which will override the setting in general.
234 ;
235 ; The valid values are:
236 ;
237 ; caller   - Consider the callers preferred order ahead of the host's.
238 ; host     - Consider the host's preferred order ahead of the caller's.
239 ; disabled - Disable the consideration of codec preference alltogether.
240 ;            (this is the original behaviour before preferences were added)
241 ; reqonly  - Same as disabled, only do not consider capabilities if
242 ;            the requested format is not available the call will only
243 ;            be accepted if the requested format is available.
244 ;
245 ; The default value is 'host'
246 ;
247 ;codecpriority=host
248
249 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
250                                 ; just like friends added from the config file only on a
251                                 ; as-needed basis? (yes|no)
252
253 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
254                                 ; If set to yes, when a IAX2 peer registers successfully, the ip address,
255                                 ; the origination port, the registration period, and the username of
256                                 ; the peer will be set to database via realtime. If not present, defaults to 'yes'.
257
258 ;rtautoclear=yes                ; Auto-Expire friends created on the fly on the same schedule
259                                 ; as if it had just registered? (yes|no|<seconds>)
260                                 ; If set to yes, when the registration expires, the friend will vanish from
261                                 ; the configuration until requested again. If set to an integer,
262                                 ; friends expire within this number of seconds instead of the
263                                 ; registration interval.
264
265 ;rtignoreexpire=yes             ; When reading a peer from Realtime, if the peer's registration
266                                 ; has expired based on its registration interval, used the stored
267                                 ; address information regardless. (yes|no)
268
269 ; Guest sections for unauthenticated connection attempts.  Just specify an
270 ; empty secret, or provide no secret section.
271 ;
272 [guest]
273 type=user
274 context=default
275 callerid="Guest IAX User"
276
277 ;
278 ; Trust Caller*ID Coming from iaxtel.com
279 ;
280 [iaxtel]
281 type=user
282 context=default
283 auth=rsa
284 inkeys=iaxtel
285
286 ;
287 ; Trust Caller*ID Coming from iax.fwdnet.net
288 ;
289 [iaxfwd]
290 type=user
291 context=default
292 auth=rsa
293 inkeys=freeworlddialup
294
295 ;
296 ; Trust callerid delivered over DUNDi/e164
297 ;
298 ;
299 ;[dundi]
300 ;type=user
301 ;dbsecret=dundi/secret
302 ;context=dundi-e164-local
303
304 ;
305 ; Further user sections may be added, specifying a context and a secret used
306 ; for connections with that given authentication name.  Limited IP based
307 ; access control is allowed by use of "allow" and "deny" keywords.  Multiple
308 ; rules are permitted.  Multiple permitted contexts may be specified, in
309 ; which case the first will be the default.  You can also override caller*ID
310 ; so that when you receive a call you set the Caller*ID to be what you want
311 ; instead of trusting what the remote user provides
312 ;
313 ; There are three authentication methods that are supported:  md5, plaintext,
314 ; and rsa.  The least secure is "plaintext", which sends passwords cleartext
315 ; across the net.  "md5" uses a challenge/response md5 sum arrangement, but
316 ; still requires both ends have plain text access to the secret.  "rsa" allows
317 ; unidirectional secret knowledge through public/private keys.  If "rsa"
318 ; authentication is used, "inkeys" is a list of acceptable public keys on the 
319 ; local system that can be used to authenticate the remote peer, separated by
320 ; the ":" character.  "outkey" is a single, private key to use to authenticate
321 ; to the other side.  Public keys are named /var/lib/asterisk/keys/<name>.pub
322 ; while private keys are named /var/lib/asterisk/keys/<name>.key.  Private
323 ; keys should always be 3DES encrypted.
324 ;
325 ;
326 ; NOTE: All hostnames and IP addresses in this file are for example purposes
327 ;       only; you should not expect any of them to actually be available for
328 ;       your use.
329 ;
330 ;
331 ;[markster]
332 ;type=user
333 ;context=default
334 ;context=local
335 ;auth=md5,plaintext,rsa
336 ;secret=markpasswd
337 ;setvar=foo=bar
338 ;dbsecret=mysecrets/place       ; Secrets can be stored in astdb, too
339 ;notransfer=yes         ; Disable IAX native transfer
340 ;jitterbuffer=yes       ; Override global setting an enable jitter buffer
341 ;                       ; for this user
342 ;callerid="Mark Spencer" <(256) 428-6275>
343 ;deny=0.0.0.0/0.0.0.0
344 ;accountcode=markster0101
345 ;permit=209.16.236.73/255.255.255.0
346 ;language=en            ; Use english as default language
347 ;
348 ; Peers may also be specified, with a secret and
349 ; a remote hostname.
350 ;
351 [demo]
352 type=peer
353 username=asterisk
354 secret=supersecret
355 host=216.207.245.47
356 ;sendani=no
357 ;host=asterisk.linux-support.net
358 ;port=5036
359 ;mask=255.255.255.255
360 ;qualify=yes                    ; Make sure this peer is alive
361 ;qualifysmoothing = yes         ; use an average of the last two PONG
362                                 ; results to reduce falsly detected LAGGED hosts
363                                 ; Default: Off
364 ;qualifyfreqok = 60000          ; how frequently to ping the peer when
365                                 ; everything seems to be ok, in milliseconds
366 ;qualifyfreqnotok = 10000       ; how frequently to ping the peer when it's
367                                 ; either LAGGED or UNAVAILABLE, in milliseconds
368 ;jitterbuffer=no                ; Turn off jitter buffer for this peer
369
370 ;
371 ; Peers can remotely register as well, so that they can be mobile.  Default
372 ; IP's can also optionally be given but are not required.  Caller*ID can be
373 ; suggested to the other side as well if it is for example a phone instead of
374 ; another PBX.
375 ;
376
377 ;[dynamichost]
378 ;host=dynamic
379 ;secret=mysecret
380 ;mailbox=1234           ; Notify about mailbox 1234
381 ;inkeys=key1:key2
382 ;peercontext=local      ; Default context to request for calls to peer
383 ;defaultip=216.207.245.34
384 ;callerid="Some Host" <(256) 428-6011>
385 ;
386
387 ;
388 ;[biggateway]
389 ;type=peer
390 ;host=192.168.0.1
391 ;context=*
392 ;secret=myscret
393 ;trunk=yes                      ; Use IAX2 trunking with this host
394 ;timezone=America/New_York      ; Set a timezone for the date/time IE
395 ;
396
397 ;
398 ; Friends are a short cut for creating a user and
399 ; a peer with the same values.
400 ;
401 ;[marko]
402 ;type=friend
403 ;host=dynamic
404 ;regexten=1234
405 ;secret=moofoo
406 ;context=default
407 ;permit=0.0.0.0/0.0.0.0
408