562a4e6c861d6267c68cedfde19f35f3901de53c
[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 ;trunkfreq=20                   ; How frequently to send trunk msgs (in ms)
152
153 ; Should we send timestamps for the individual sub-frames within trunk frames?
154 ; There is a small bandwidth use for these (less than 1kbps/call), but they
155 ; ensure that frame timestamps get sent end-to-end properly.  If both ends of
156 ; all your trunks go directly to TDM, _and_ your trunkfreq equals the frame
157 ; length for your codecs, you can probably suppress these.  The receiver must
158 ; also support this feature, although they do not also need to have it enabled.
159 ;
160 ; trunktimestamps=yes
161 ;
162 ; Minimum and maximum amounts of time that IAX peers can request as
163 ; a registration expiration interval (in seconds).
164 ; minregexpire = 60
165 ; maxregexpire = 60
166 ;
167 ; With a large amount of traffic on IAX2 trunks, there is a risk of bad voice quality due to
168 ; the fact that the IAX2 trunking scheme depends on the Linux system to handle fragmentation of
169 ; UDP packets. This may not be very efficient.
170 ; This setting sets the maximum transmission unit for IAX2 UDP trunking.
171 ; default is 1240 bytes. Zero disables this functionality and let's the O/S handle fragmentation.
172 ;
173 ; trunkmtu = 1240
174 ;
175 ; Enable IAX2 encryption.  The default is no.
176 ;
177 ; encryption = yes
178 ;
179 ; Force encryption insures no connection is established unless both sides support
180 ; encryption.  By turning this option on, encryption is automatically turned on as well.
181 ;
182 ; forceencryption = yes
183
184 ; This option defines the maximum size an IAX2 trunk can grow to. The default value is 128000 bytes which
185 ; represents 40ms uncompressed linear with 200 channels. Depending on different things though
186 ; (codec in use and channels) you may need to make this value larger.
187 ; trunkmaxsize = 128000
188
189 ; IAX helper threads
190
191 ; Establishes the number of iax helper threads to handle I/O.
192 ; iaxthreadcount = 10
193 ; Establishes the number of extra dynamic threads that may be spawned to handle I/O
194 ; iaxmaxthreadcount = 100
195 ;
196 ; We can register with another IAX server to let him know where we are
197 ; in case we have a dynamic IP address for example
198 ;
199 ; Register with tormenta using username marko and password secretpass
200 ;
201 ;register => marko:secretpass@tormenta.linux-support.net
202 ;
203 ; Register joe at remote host with no password
204 ;
205 ;register => joe@remotehost:5656
206 ;
207 ; Register marko at tormenta.linux-support.net using RSA key "torkey"
208 ;
209 ;register => marko:[torkey]@tormenta.linux-support.net
210 ;
211 ; Sample Registration for iaxtel
212 ;
213 ; Visit http://www.iaxtel.com to register with iaxtel.  Replace "user"
214 ; and "pass" with your username and password for iaxtel.  Incoming
215 ; calls arrive at the "s" extension of "default" context.
216 ;
217 ;register => user:pass@iaxtel.com
218 ;
219 ; Sample Registration for IAX + FWD
220 ;
221 ; To register using IAX with FWD, it must be enabled by visiting the URL
222 ; http://www.fwdnet.net/index.php?section_id=112
223 ;
224 ; Note that you need an extension in you default context which matches
225 ; your free world dialup number.  Please replace "FWDNumber" with your
226 ; FWD number and "passwd" with your password.
227 ;
228 ;register => FWDNumber:passwd@iax.fwdnet.net
229 ;
230 ;
231 ; You can disable authentication debugging to reduce the amount of
232 ; debugging traffic.
233 ;
234 ;authdebug=no
235 ;
236 ; See qos.tex or Quality of Service section of asterisk.pdf for a description of these parameters.
237 ;tos=ef
238 ;cos=5
239 ;
240 ; If regcontext is specified, Asterisk will dynamically create and destroy
241 ; a NoOp priority 1 extension for a given peer who registers or unregisters
242 ; with us.  The actual extension is the 'regexten' parameter of the registering
243 ; peer or its name if 'regexten' is not provided.  More than one regexten
244 ; may be supplied if they are separated by '&'.  Patterns may be used in
245 ; regexten.
246 ;
247 ;regcontext=iaxregistrations
248 ;
249 ; If we don't get ACK to our NEW within 2000ms, and autokill is set to yes,
250 ; then we cancel the whole thing (that's enough time for one retransmission
251 ; only).  This is used to keep things from stalling for a long time for a host
252 ; that is not available, but would be ill advised for bad connections.  In
253 ; addition to 'yes' or 'no' you can also specify a number of milliseconds.
254 ; See 'qualify' for individual peers to turn on for just a specific peer.
255 ;
256 autokill=yes
257 ;
258 ; codecpriority controls the codec negotiation of an inbound IAX call.
259 ; This option is inherited to all user entities.  It can also be defined
260 ; in each user entity separately which will override the setting in general.
261 ;
262 ; The valid values are:
263 ;
264 ; caller   - Consider the callers preferred order ahead of the host's.
265 ; host     - Consider the host's preferred order ahead of the caller's.
266 ; disabled - Disable the consideration of codec preference altogether.
267 ;            (this is the original behaviour before preferences were added)
268 ; reqonly  - Same as disabled, only do not consider capabilities if
269 ;            the requested format is not available the call will only
270 ;            be accepted if the requested format is available.
271 ;
272 ; The default value is 'host'
273 ;
274 ;codecpriority=host
275 ;
276 ; allowfwdownload controls whether this host will serve out firmware to
277 ; IAX clients which request it.  This has only been used for the IAXy,
278 ; and it has been recently proven that this firmware distribution method
279 ; can be used as a source of traffic amplification attacks.  Also, the
280 ; IAXy firmware has not been updated for at least 18 months, so unless
281 ; you are provisioning IAXys in a secure network, we recommend that you
282 ; leave this option to the default, off.
283 ;
284 ;allowfwdownload=yes
285
286 ;rtcachefriends=yes     ; Cache realtime friends by adding them to the internal list
287                         ; just like friends added from the config file only on a
288                         ; as-needed basis? (yes|no)
289
290 ;rtupdate=yes           ; Send registry updates to database using realtime? (yes|no)
291                         ; If set to yes, when a IAX2 peer registers successfully,
292                         ; the ip address, the origination port, the registration period,
293                         ; and the username of the peer will be set to database via realtime.
294                         ; If not present, defaults to 'yes'.
295
296 ;rtautoclear=yes        ; Auto-Expire friends created on the fly on the same schedule
297                         ; as if it had just registered? (yes|no|<seconds>)
298                         ; If set to yes, when the registration expires, the friend will
299                         ; vanish from the configuration until requested again.
300                         ; If set to an integer, friends expire within this number of
301                         ; seconds instead of the registration interval.
302
303 ;rtignoreregexpire=yes  ; When reading a peer from Realtime, if the peer's registration
304                         ; has expired based on its registration interval, used the stored
305                         ; address information regardless. (yes|no)
306
307 ;parkinglot=edvina              ; Default parkinglot for IAX peers and users
308                                 ; This can also be configured per device
309                                 ; Parkinglots are defined in features.conf
310
311 ; Guest sections for unauthenticated connection attempts.  Just specify an
312 ; empty secret, or provide no secret section.
313 ;
314 [guest]
315 type=user
316 context=default
317 callerid="Guest IAX User"
318
319 ;
320 ; Trust Caller*ID Coming from iaxtel.com
321 ;
322 [iaxtel]
323 type=user
324 context=default
325 auth=rsa
326 inkeys=iaxtel
327
328 ;
329 ; Trust Caller*ID Coming from iax.fwdnet.net
330 ;
331 [iaxfwd]
332 type=user
333 context=default
334 auth=rsa
335 inkeys=freeworlddialup
336
337 ;
338 ; Trust callerid delivered over DUNDi/e164
339 ;
340 ;
341 ;[dundi]
342 ;type=user
343 ;dbsecret=dundi/secret
344 ;context=dundi-e164-local
345
346 ;
347 ; Further user sections may be added, specifying a context and a secret used
348 ; for connections with that given authentication name.  Limited IP based
349 ; access control is allowed by use of "allow" and "deny" keywords.  Multiple
350 ; rules are permitted.  Multiple permitted contexts may be specified, in
351 ; which case the first will be the default.  You can also override caller*ID
352 ; so that when you receive a call you set the Caller*ID to be what you want
353 ; instead of trusting what the remote user provides
354 ;
355 ; There are three authentication methods that are supported:  md5, plaintext,
356 ; and rsa.  The least secure is "plaintext", which sends passwords cleartext
357 ; across the net.  "md5" uses a challenge/response md5 sum arrangement, but
358 ; still requires both ends have plain text access to the secret.  "rsa" allows
359 ; unidirectional secret knowledge through public/private keys.  If "rsa"
360 ; authentication is used, "inkeys" is a list of acceptable public keys on the
361 ; local system that can be used to authenticate the remote peer, separated by
362 ; the ":" character.  "outkey" is a single, private key to use to authenticate
363 ; to the other side.  Public keys are named /var/lib/asterisk/keys/<name>.pub
364 ; while private keys are named /var/lib/asterisk/keys/<name>.key.  Private
365 ; keys should always be 3DES encrypted.
366 ;
367 ;
368 ; NOTE: All hostnames and IP addresses in this file are for example purposes
369 ;       only; you should not expect any of them to actually be available for
370 ;       your use.
371 ;
372 ;
373 ;[markster]
374 ;type=user
375 ;context=default
376 ;context=local
377 ;auth=md5,plaintext,rsa
378 ;secret=markpasswd
379 ;setvar=ATTENDED_TRANSFER_COMPLETE_SOUND=beep   ; This channel variable will
380                                                 ; cause the given audio file to
381                                                 ; be played upon completion of
382                                                 ; an attended transfer.
383 ;dbsecret=mysecrets/place       ; Secrets can be stored in astdb, too
384 ;transfer=no            ; Disable IAX native transfer
385 ;transfer=mediaonly     ; When doing IAX native transfers, transfer
386                         ; only media stream
387 ;jitterbuffer=yes       ; Override global setting an enable jitter buffer
388 ;                       ; for this user
389 ;maxauthreq=10          ; Set maximum number of outstanding AUTHREQs waiting for replies. Any further authentication attempts will be blocked
390 ;                       ; if this limit is reached until they expire or a reply is received.
391 ;callerid="Mark Spencer" <(256) 428-6275>
392 ;deny=0.0.0.0/0.0.0.0
393 ;accountcode=markster0101
394 ;permit=209.16.236.73/255.255.255.0
395 ;language=en            ; Use english as default language
396 ;encryption=yes ; Enable IAX2 encryption.  The default is no.
397 ;keyrotate=off ; This is a compatibility option for older versions of
398 ;              ; IAX2 that do not support key rotation with encryption.
399 ;              ; This option will disable the IAX_COMMAND_RTENC message.
400 ;              ; default is on.
401 ;              ;
402 ;
403 ; Peers may also be specified, with a secret and
404 ; a remote hostname.
405 ;
406 [demo]
407 type=peer
408 username=asterisk
409 secret=supersecret
410 host=216.207.245.47
411 ;sendani=no
412 ;host=asterisk.linux-support.net
413 ;port=5036
414 ;mask=255.255.255.255
415 ;qualify=yes                    ; Make sure this peer is alive
416 ;qualifysmoothing = yes         ; use an average of the last two PONG
417                                 ; results to reduce falsely detected LAGGED hosts
418                                 ; Default: Off
419 ;qualifyfreqok = 60000          ; how frequently to ping the peer when
420                                 ; everything seems to be ok, in milliseconds
421 ;qualifyfreqnotok = 10000       ; how frequently to ping the peer when it's
422                                 ; either LAGGED or UNAVAILABLE, in milliseconds
423 ;jitterbuffer=no                ; Turn off jitter buffer for this peer
424 ;
425 ;encryption=yes ; Enable IAX2 encryption.  The default is no.
426 ;keyrotate=off ; This is a compatibility option for older versions of
427 ;              ; IAX2 that do not support key rotation with encryption.
428 ;              ; This option will disable the IAX_COMMAND_RTENC message.
429 ;              ; default is on.
430 ;              ;
431 ; Peers can remotely register as well, so that they can be mobile.  Default
432 ; IP's can also optionally be given but are not required.  Caller*ID can be
433 ; suggested to the other side as well if it is for example a phone instead of
434 ; another PBX.
435 ;
436
437 ;[dynamichost]
438 ;host=dynamic
439 ;secret=mysecret
440 ;mailbox=1234           ; Notify about mailbox 1234
441 ;inkeys=key1:key2
442 ;peercontext=local      ; Default context to request for calls to peer
443 ;defaultip=216.207.245.34
444 ;callerid="Some Host" <(256) 428-6011>
445 ;
446
447 ;
448 ;[biggateway]
449 ;type=peer
450 ;host=192.168.0.1
451 ;context=*
452 ;secret=myscret
453 ;trunk=yes                      ; Use IAX2 trunking with this host
454 ;timezone=America/New_York      ; Set a timezone for the date/time IE
455 ;
456
457 ;
458 ; Friends are a short cut for creating a user and
459 ; a peer with the same values.
460 ;
461 ;[marko]
462 ;type=friend
463 ;host=dynamic
464 ;regexten=1234
465 ;secret=moofoo   ; Multiple secrets may be specified. For a "user", all
466 ;secret=foomoo   ; specified entries will be accepted as valid. For a "peer",
467 ;secret=shazbot  ; only the last specified secret will be used.
468 ;context=default
469 ;permit=0.0.0.0/0.0.0.0
470
471 ;
472 ; With immediate=yes, an IAX phone or a phone on an IAXy acts as a hot-line
473 ; which goes immediately to the s extension when picked up.  Useful for
474 ; elevator phones, manual service, or other similar applications.
475 ;
476 ;[manual]
477 ;type=friend
478 ;host=dynamic
479 ;immediate=yes  ; go immediately to s extension when picked up
480 ;secret=moofoo  ; when immediate=yes is specified, secret is required
481 ;context=number-please ; we start at the s extension in this context
482 ;