Clarifies trunkmaxsize, trunkfreq, and trunkmtu iax2 options
[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
15                                 ; bindaddr or may be specified on a specific
16                                 ; bindaddr if followed by colon and port
17                                 ;  (e.g. bindaddr=192.168.0.1:4569)
18 ;bindaddr=192.168.0.1           ; more than once to bind to multiple
19 ;                               ; addresses, but the first will be the
20 ;                               ; default
21 ;
22 ; Set iaxcompat to yes if you plan to use layered switches or
23 ; some other scenario which may cause some delay when doing a
24 ; lookup in the dialplan. It incurs a small performance hit to
25 ; enable it. This option causes Asterisk to spawn a separate thread
26 ; when it receives an IAX DPREQ (Dialplan Request) instead of
27 ; blocking while it waits for a response.
28 ;
29 ;iaxcompat=yes
30 ;
31 ; Disable UDP checksums (if nochecksums is set, then no checkums will
32 ; be calculated/checked on systems supporting this feature)
33 ;
34 ;nochecksums=no
35 ;
36 ;
37 ; For increased security against brute force password attacks
38 ; enable "delayreject" which will delay the sending of authentication
39 ; reject for REGREQ or AUTHREP if there is a password.
40 ;
41 ;delayreject=yes
42 ;
43 ; You may specify a global default AMA flag for iaxtel calls.  It must be
44 ; one of 'default', 'omit', 'billing', or 'documentation'.  These flags
45 ; are used in the generation of call detail records.
46 ;
47 ;amaflags=default
48 ;
49 ; ADSI (Analog Display Services Interface) can be enabled if you have
50 ; (or may have) ADSI compatible CPE equipment
51 ;
52 ;adsi=no
53 ;
54 ; Perform an SRV lookup on outbound calls
55 ;
56 ;srvlookup=yes
57 ;
58 ; You may specify a default account for Call Detail Records in addition
59 ; to specifying on a per-user basis
60 ;
61 ;accountcode=lss0101
62 ;
63 ; You may specify a global default language for users.
64 ; Can be specified also on a per-user basis
65 ; If omitted, will fallback to english
66 ;
67 ;language=en
68 ;
69 ; This option specifies a preference for which music on hold class this channel
70 ; should listen to when put on hold if the music class has not been set on the
71 ; channel with Set(CHANNEL(musicclass)=whatever) in the dialplan, and the peer
72 ; channel putting this one on hold did not suggest a music class.
73 ;
74 ; If this option is set to "passthrough", then the hold message will always be
75 ; passed through as signalling instead of generating hold music locally.
76 ;
77 ; This option may be specified globally, or on a per-user or per-peer basis.
78 ;
79 ;mohinterpret=default
80 ;
81 ; This option specifies which music on hold class to suggest to the peer channel
82 ; when this channel places the peer on hold. It may be specified globally or on
83 ; a per-user or per-peer basis.
84 ;
85 ;mohsuggest=default
86 ;
87 ; Specify bandwidth of low, medium, or high to control which codecs are used
88 ; in general.
89 ;
90 bandwidth=low
91 ;
92 ; You can also fine tune codecs here using "allow" and "disallow" clauses
93 ; with specific codecs.  Use "all" to represent all formats.
94 ;
95 ;allow=all                      ; same as bandwidth=high
96 ;disallow=g723.1                ; Hm...  Proprietary, don't use it...
97 disallow=lpc10                  ; Icky sound quality...  Mr. Roboto.
98 ;allow=gsm                      ; Always allow GSM, it's cool :)
99 ;
100
101 ; You can adjust several parameters relating to the jitter buffer.
102 ; The jitter buffer's function is to compensate for varying
103 ; network delay.
104 ;
105 ; All the jitter buffer settings are in milliseconds.
106 ; The jitter buffer works for INCOMING audio - the outbound audio
107 ; will be dejittered by the jitter buffer at the other end.
108 ;
109 ; jitterbuffer=yes|no: global default as to whether you want
110 ; the jitter buffer at all.
111 ;
112 ; forcejitterbuffer=yes|no: in the ideal world, when we bridge VoIP channels
113 ; we don't want to do jitterbuffering on the switch, since the endpoints
114 ; can each handle this.  However, some endpoints may have poor jitterbuffers
115 ; themselves, so this option will force * to always jitterbuffer, even in this
116 ; case.
117 ;
118 ; maxjitterbuffer: a maximum size for the jitter buffer.
119 ; Setting a reasonable maximum here will prevent the call delay
120 ; from rising to silly values in extreme situations; you'll hear
121 ; SOMETHING, even though it will be jittery.
122 ;
123 ; resyncthreshold: when the jitterbuffer notices a significant change in delay
124 ; that continues over a few frames, it will resync, assuming that the change in
125 ; delay was caused by a timestamping mix-up. The threshold for noticing a
126 ; change in delay is measured as twice the measured jitter plus this resync
127 ; threshold.
128 ; Resyncing can be disabled by setting this parameter to -1.
129 ;
130 ; maxjitterinterps: the maximum number of interpolation frames the jitterbuffer
131 ; should return in a row. Since some clients do not send CNG/DTX frames to
132 ; indicate silence, the jitterbuffer will assume silence has begun after
133 ; returning this many interpolations. This prevents interpolating throughout
134 ; a long silence.
135 ;
136 ;
137 ; jittertargetextra: number of milliseconds by which the new jitter buffer
138 ; will pad its size. the default is 40, so without modification, the new
139 ; jitter buffer will set its size to the jitter value plus 40 milliseconds.
140 ; increasing this value may help if your network normally has low jitter,
141 ; but occasionally has spikes.
142 ;
143
144 jitterbuffer=no
145 forcejitterbuffer=no
146 ;maxjitterbuffer=1000
147 ;maxjitterinterps=10
148 ;resyncthreshold=1000
149 ;jittertargetextra=40
150
151 ; Minimum and maximum amounts of time that IAX peers can request as
152 ; a registration expiration interval (in seconds).
153 ; minregexpire = 60
154 ; maxregexpire = 60
155 ;
156 ; Enable IAX2 encryption.  The default is no.
157 ;
158 ; encryption = yes
159 ;
160 ; Force encryption insures no connection is established unless both sides support
161 ; encryption.  By turning this option on, encryption is automatically turned on as well.
162 ;
163 ; forceencryption = yes
164
165 ; This option defines the maximum payload in bytes an IAX2 trunk can support at a given time.
166 ; The best way to explain this is to provide an example.  If the maximum number of calls
167 ; to be supported is 800, and each call transmits 20ms frames of audio using ulaw
168 ; ((8000hz / 1000ms) * 20ms * 1 byte per sample = 160 bytes per frame), the maximum load
169 ; in bytes is (160 bytes per frame) * (800 calls) = 128000 bytes total. Once this limit is
170 ; reached, calls may be dropped or begin to lose audio.  Depending on the codec in use and
171 ; number of channels to be supported this value may need to be raised, but in most cases the
172 ; default value is large enough.
173 ;
174 ; trunkmaxsize = 128000 ; defaults to 128000 bytes, which supports up to 800 calls of ulaw
175 ;                       ; at 20ms a frame.
176
177 ; With a large amount of traffic on IAX2 trunks, there is a risk of bad voice quality when
178 ; allowing the Linux system to handle fragmentation of UDP packets. Depending on the size of
179 ; each payload, allowing the O/S to handle fragmentation may not be very efficient. This
180 ; setting sets the maximum transmission unit for IAX2 UDP trunking. The default is 1240 bytes
181 ; which means if a trunk's payload is over 1240 bytes for every 20ms it will be broken into
182 ; multiple 1240 byte messages.  Zero disables this functionality and let's the O/S handle
183 ; fragmentation.
184 ;
185 ; trunkmtu = 1240 ; trunk data will be sent in 1240 byte messages.
186
187 ; trunkfreq sets how frequently trunk messages are sent in milliseconds. This value is 20ms by
188 ; default, which means the trunk will send all the date queued to it in the past 20ms.  By
189 ; increasing the time between sending trunk messages, the trunk's payload size will increase as
190 ; well.  Note, depending on the size set by trunkmtu, messages may be sent more often than
191 ; specified.  For example if a trunk's message size grows to the trunkmtu size before 20ms is
192 ; reached that message will be sent immediately.
193 ;
194 ; trunkfreq=20     ; How frequently to send trunk msgs (in ms). This is 20ms by default.
195
196 ; Should we send timestamps for the individual sub-frames within trunk frames?
197 ; There is a small bandwidth use for these (less than 1kbps/call), but they
198 ; ensure that frame timestamps get sent end-to-end properly.  If both ends of
199 ; all your trunks go directly to TDM, _and_ your trunkfreq equals the frame
200 ; length for your codecs, you can probably suppress these.  The receiver must
201 ; also support this feature, although they do not also need to have it enabled.
202 ;
203 ; trunktimestamps=yes
204 ;
205
206 ; IAX helper threads
207
208 ; Establishes the number of iax helper threads to handle I/O.
209 ; iaxthreadcount = 10
210 ; Establishes the number of extra dynamic threads that may be spawned to handle I/O
211 ; iaxmaxthreadcount = 100
212 ;
213 ; We can register with another IAX server to let him know where we are
214 ; in case we have a dynamic IP address for example
215 ;
216 ; Register with tormenta using username marko and password secretpass
217 ;
218 ;register => marko:secretpass@tormenta.linux-support.net
219 ;
220 ; Register joe at remote host with no password
221 ;
222 ;register => joe@remotehost:5656
223 ;
224 ; Register marko at tormenta.linux-support.net using RSA key "torkey"
225 ;
226 ;register => marko:[torkey]@tormenta.linux-support.net
227 ;
228 ; Sample Registration for iaxtel
229 ;
230 ; Visit http://www.iaxtel.com to register with iaxtel.  Replace "user"
231 ; and "pass" with your username and password for iaxtel.  Incoming
232 ; calls arrive at the "s" extension of "default" context.
233 ;
234 ;register => user:pass@iaxtel.com
235 ;
236 ; Sample Registration for IAX + FWD
237 ;
238 ; To register using IAX with FWD, it must be enabled by visiting the URL
239 ; http://www.fwdnet.net/index.php?section_id=112
240 ;
241 ; Note that you need an extension in you default context which matches
242 ; your free world dialup number.  Please replace "FWDNumber" with your
243 ; FWD number and "passwd" with your password.
244 ;
245 ;register => FWDNumber:passwd@iax.fwdnet.net
246 ;
247 ;
248 ; You can disable authentication debugging to reduce the amount of
249 ; debugging traffic.
250 ;
251 ;authdebug=no
252 ;
253 ; See qos.tex or Quality of Service section of asterisk.pdf for a description of these parameters.
254 ;tos=ef
255 ;cos=5
256 ;
257 ; If regcontext is specified, Asterisk will dynamically create and destroy
258 ; a NoOp priority 1 extension for a given peer who registers or unregisters
259 ; with us.  The actual extension is the 'regexten' parameter of the registering
260 ; peer or its name if 'regexten' is not provided.  More than one regexten
261 ; may be supplied if they are separated by '&'.  Patterns may be used in
262 ; regexten.
263 ;
264 ;regcontext=iaxregistrations
265 ;
266 ; If we don't get ACK to our NEW within 2000ms, and autokill is set to yes,
267 ; then we cancel the whole thing (that's enough time for one retransmission
268 ; only).  This is used to keep things from stalling for a long time for a host
269 ; that is not available, but would be ill advised for bad connections.  In
270 ; addition to 'yes' or 'no' you can also specify a number of milliseconds.
271 ; See 'qualify' for individual peers to turn on for just a specific peer.
272 ;
273 autokill=yes
274 ;
275 ; codecpriority controls the codec negotiation of an inbound IAX call.
276 ; This option is inherited to all user entities.  It can also be defined
277 ; in each user entity separately which will override the setting in general.
278 ;
279 ; The valid values are:
280 ;
281 ; caller   - Consider the callers preferred order ahead of the host's.
282 ; host     - Consider the host's preferred order ahead of the caller's.
283 ; disabled - Disable the consideration of codec preference altogether.
284 ;            (this is the original behaviour before preferences were added)
285 ; reqonly  - Same as disabled, only do not consider capabilities if
286 ;            the requested format is not available the call will only
287 ;            be accepted if the requested format is available.
288 ;
289 ; The default value is 'host'
290 ;
291 ;codecpriority=host
292 ;
293 ; allowfwdownload controls whether this host will serve out firmware to
294 ; IAX clients which request it.  This has only been used for the IAXy,
295 ; and it has been recently proven that this firmware distribution method
296 ; can be used as a source of traffic amplification attacks.  Also, the
297 ; IAXy firmware has not been updated for at least 18 months, so unless
298 ; you are provisioning IAXys in a secure network, we recommend that you
299 ; leave this option to the default, off.
300 ;
301 ;allowfwdownload=yes
302
303 ;rtcachefriends=yes     ; Cache realtime friends by adding them to the internal list
304                         ; just like friends added from the config file only on a
305                         ; as-needed basis? (yes|no)
306
307 ;rtsavesysname=yes    ; Save systemname in realtime database at registration
308                       ; Default = no
309
310 ;rtupdate=yes           ; Send registry updates to database using realtime? (yes|no)
311                         ; If set to yes, when a IAX2 peer registers successfully,
312                         ; the ip address, the origination port, the registration period,
313                         ; and the username of the peer will be set to database via realtime.
314                         ; If not present, defaults to 'yes'.
315
316 ;rtautoclear=yes        ; Auto-Expire friends created on the fly on the same schedule
317                         ; as if it had just registered? (yes|no|<seconds>)
318                         ; If set to yes, when the registration expires, the friend will
319                         ; vanish from the configuration until requested again.
320                         ; If set to an integer, friends expire within this number of
321                         ; seconds instead of the registration interval.
322
323 ;rtignoreregexpire=yes  ; When reading a peer from Realtime, if the peer's registration
324                         ; has expired based on its registration interval, used the stored
325                         ; address information regardless. (yes|no)
326
327 ;parkinglot=edvina              ; Default parkinglot for IAX peers and users
328                                 ; This can also be configured per device
329                                 ; Parkinglots are defined in features.conf
330
331
332 ;
333 ; The following two options are used to disable call token validation for the
334 ; purposes of interoperability with IAX2 endpoints that do not yet support it.
335 ;
336 ; Call token validation can be set as optional for a single IP address or IP
337 ; address range by using the 'calltokenoptional' option. 'calltokenoptional' is
338 ; only a global option.  
339 ;
340 ;calltokenoptional=209.16.236.73/255.255.255.0
341 ;
342 ; In a peer/user/friend definition, the 'requirecalltoken' option may be used.
343 ; By setting 'requirecalltoken=no', call token validation becomes optional for
344 ; that peer/user.  By setting 'requirecalltoken=auto', call token validation 
345 ; is optional until a call token supporting peer registers successfully using
346 ; call token validation.  This is used as an indication that from now on, we
347 ; can require it from this peer.  So, requirecalltoken is internally set to yes.
348 ; By default, 'requirecalltoken=yes'.
349 ;
350 ;requirecalltoken=no
351 ;
352
353 ;
354 ; These options are used to limit the amount of call numbers allocated to a
355 ; single IP address.  Before changing any of these values, it is highly encouraged
356 ; to read the user guide associated with these options first.  In most cases, the
357 ; default values for these options are sufficient.
358 ;
359 ; The 'maxcallnumbers' option limits the amount of call numbers allowed for each
360 ; individual remote IP address.  Once an IP address reaches it's call number
361 ; limit, no more new connections are allowed until the previous ones close.  This
362 ; option can be used in a peer definition as well, but only takes effect for
363 ; the IP of a dynamic peer after it completes registration.
364 ;
365 ;maxcallnumbers=512
366 ;
367 ; The 'maxcallnumbers_nonvalidated' is used to set the combined number of call
368 ; numbers that can be allocated for connections where call token  validation
369 ; has been disabled.  Unlike the 'maxcallnumbers' option, this limit is not
370 ; separate for each individual IP address.  Any connection resulting in a
371 ; non-call token validated call number being allocated contributes to this
372 ; limit.  For use cases, see the call token user guide.  This option's 
373 ; default value of 8192 should be sufficient in most cases.
374 ;
375 ;maxcallnumbers_nonvalidated=1024
376 ;
377 ; The [callnumberlimits] section allows custom call number limits to be set
378 ; for specific IP addresses and IP address ranges.  These limits take precedence
379 ; over the global 'maxcallnumbers' option, but may still be overridden by a
380 ; peer defined 'maxcallnumbers' entry.  Note that these limits take effect
381 ; for every individual address within the range, not the range as a whole. 
382 ;
383 ;[callnumberlimits]
384 ;10.1.1.0/255.255.255.0 = 24
385 ;10.1.2.0/255.255.255.0 = 32
386 ;
387
388 ; Guest sections for unauthenticated connection attempts.  Just specify an
389 ; empty secret, or provide no secret section.
390 ;
391 [guest]
392 type=user
393 context=default
394 callerid="Guest IAX User"
395
396 ;
397 ; Trust Caller*ID Coming from iaxtel.com
398 ;
399 [iaxtel]
400 type=user
401 context=default
402 auth=rsa
403 inkeys=iaxtel
404
405 ;
406 ; Trust Caller*ID Coming from iax.fwdnet.net
407 ;
408 [iaxfwd]
409 type=user
410 context=default
411 auth=rsa
412 inkeys=freeworlddialup
413
414 ;
415 ; Trust callerid delivered over DUNDi/e164
416 ;
417 ;
418 ;[dundi]
419 ;type=user
420 ;dbsecret=dundi/secret
421 ;context=dundi-e164-local
422
423 ;
424 ; Further user sections may be added, specifying a context and a secret used
425 ; for connections with that given authentication name.  Limited IP based
426 ; access control is allowed by use of "permit" and "deny" keywords.  Multiple
427 ; rules are permitted.  Multiple permitted contexts may be specified, in
428 ; which case the first will be the default.  You can also override caller*ID
429 ; so that when you receive a call you set the Caller*ID to be what you want
430 ; instead of trusting what the remote user provides
431 ;
432 ; There are three authentication methods that are supported:  md5, plaintext,
433 ; and rsa.  The least secure is "plaintext", which sends passwords cleartext
434 ; across the net.  "md5" uses a challenge/response md5 sum arrangement, but
435 ; still requires both ends have plain text access to the secret.  "rsa" allows
436 ; unidirectional secret knowledge through public/private keys.  If "rsa"
437 ; authentication is used, "inkeys" is a list of acceptable public keys on the
438 ; local system that can be used to authenticate the remote peer, separated by
439 ; the ":" character.  "outkey" is a single, private key to use to authenticate
440 ; to the other side.  Public keys are named /var/lib/asterisk/keys/<name>.pub
441 ; while private keys are named /var/lib/asterisk/keys/<name>.key.  Private
442 ; keys should always be 3DES encrypted.
443 ;
444 ;
445 ; NOTE: All hostnames and IP addresses in this file are for example purposes
446 ;       only; you should not expect any of them to actually be available for
447 ;       your use.
448 ;
449 ;
450 ;[markster]
451 ;type=user
452 ;context=default
453 ;context=local
454 ;auth=md5,plaintext,rsa
455 ;secret=markpasswd
456 ;setvar=ATTENDED_TRANSFER_COMPLETE_SOUND=beep   ; This channel variable will
457                                                 ; cause the given audio file to
458                                                 ; be played upon completion of
459                                                 ; an attended transfer.
460 ;dbsecret=mysecrets/place       ; Secrets can be stored in astdb, too
461 ;transfer=no            ; Disable IAX native transfer
462 ;transfer=mediaonly     ; When doing IAX native transfers, transfer
463                         ; only media stream
464 ;jitterbuffer=yes       ; Override global setting an enable jitter buffer
465 ;                       ; for this user
466 ;maxauthreq=10          ; Set maximum number of outstanding AUTHREQs waiting for replies. Any further authentication attempts will be blocked
467 ;                       ; if this limit is reached until they expire or a reply is received.
468 ;callerid="Mark Spencer" <(256) 428-6275>
469 ;deny=0.0.0.0/0.0.0.0
470 ;accountcode=markster0101
471 ;permit=209.16.236.73/255.255.255.0
472 ;language=en            ; Use english as default language
473 ;encryption=yes ; Enable IAX2 encryption.  The default is no.
474 ;keyrotate=off ; This is a compatibility option for older versions of
475 ;              ; IAX2 that do not support key rotation with encryption.
476 ;              ; This option will disable the IAX_COMMAND_RTENC message.
477 ;              ; default is on.
478 ;              ;
479 ;
480 ; Peers may also be specified, with a secret and
481 ; a remote hostname.
482 ;
483 [demo]
484 type=peer
485 username=asterisk
486 secret=supersecret
487 host=216.207.245.47
488 ;sendani=no
489 ;host=asterisk.linux-support.net
490 ;port=5036
491 ;mask=255.255.255.255
492 ;qualify=yes                    ; Make sure this peer is alive
493 ;qualifysmoothing = yes         ; use an average of the last two PONG
494                                 ; results to reduce falsely detected LAGGED hosts
495                                 ; Default: Off
496 ;qualifyfreqok = 60000          ; how frequently to ping the peer when
497                                 ; everything seems to be ok, in milliseconds
498 ;qualifyfreqnotok = 10000       ; how frequently to ping the peer when it's
499                                 ; either LAGGED or UNAVAILABLE, in milliseconds
500 ;jitterbuffer=no                ; Turn off jitter buffer for this peer
501 ;
502 ;encryption=yes ; Enable IAX2 encryption.  The default is no.
503 ;keyrotate=off ; This is a compatibility option for older versions of
504 ;              ; IAX2 that do not support key rotation with encryption.
505 ;              ; This option will disable the IAX_COMMAND_RTENC message.
506 ;              ; default is on.
507 ;              ;
508 ; Peers can remotely register as well, so that they can be mobile.  Default
509 ; IP's can also optionally be given but are not required.  Caller*ID can be
510 ; suggested to the other side as well if it is for example a phone instead of
511 ; another PBX.
512 ;
513
514 ;[dynamichost]
515 ;host=dynamic
516 ;secret=mysecret
517 ;mailbox=1234           ; Notify about mailbox 1234
518 ;inkeys=key1:key2
519 ;peercontext=local      ; Default context to request for calls to peer
520 ;defaultip=216.207.245.34
521 ;callerid="Some Host" <(256) 428-6011>
522 ;
523
524 ;
525 ;[biggateway]
526 ;type=peer
527 ;host=192.168.0.1
528 ;context=*
529 ;secret=myscret
530 ;trunk=yes                      ; Use IAX2 trunking with this host
531 ;timezone=America/New_York      ; Set a timezone for the date/time IE
532 ;
533
534 ;
535 ; Friends are a short cut for creating a user and
536 ; a peer with the same values.
537 ;
538 ;[marko]
539 ;type=friend
540 ;host=dynamic
541 ;regexten=1234
542 ;secret=moofoo   ; Multiple secrets may be specified. For a "user", all
543 ;secret=foomoo   ; specified entries will be accepted as valid. For a "peer",
544 ;secret=shazbot  ; only the last specified secret will be used.
545 ;context=default
546 ;permit=0.0.0.0/0.0.0.0
547
548 ;
549 ; With immediate=yes, an IAX phone or a phone on an IAXy acts as a hot-line
550 ; which goes immediately to the s extension when picked up.  Useful for
551 ; elevator phones, manual service, or other similar applications.
552 ;
553 ;[manual]
554 ;type=friend
555 ;host=dynamic
556 ;immediate=yes  ; go immediately to s extension when picked up
557 ;secret=moofoo  ; when immediate=yes is specified, secret is required
558 ;context=number-please ; we start at the s extension in this context
559 ;