afe25538c954d91f85999216678039f1c01cc641
[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 ; You may specify a default account for Call Detail Records in addition
55 ; to specifying on a per-user basis
56 ;
57 ;accountcode=lss0101
58 ;
59 ; You may specify a global default language for users. 
60 ; Can be specified also on a per-user basis
61 ; If omitted, will fallback to english
62 ;
63 ;language=en
64 ;
65 ; This option specifies a preference for which music on hold class this channel
66 ; should listen to when put on hold if the music class has not been set on the
67 ; channel with Set(CHANNEL(musicclass)=whatever) in the dialplan, and the peer
68 ; channel putting this one on hold did not suggest a music class.
69 ;
70 ; If this option is set to "passthrough", then the hold message will always be
71 ; passed through as signalling instead of generating hold music locally.
72 ;
73 ; This option may be specified globally, or on a per-user or per-peer basis.
74 ;
75 ;mohinterpret=default
76 ;
77 ; This option specifies which music on hold class to suggest to the peer channel
78 ; when this channel places the peer on hold. It may be specified globally or on
79 ; a per-user or per-peer basis.
80 ;
81 ;mohsuggest=default
82 ;
83 ; Specify bandwidth of low, medium, or high to control which codecs are used
84 ; in general.
85 ;
86 bandwidth=low
87 ;
88 ; You can also fine tune codecs here using "allow" and "disallow" clauses
89 ; with specific codecs.  Use "all" to represent all formats.
90 ;
91 ;allow=all                      ; same as bandwidth=high
92 ;disallow=g723.1                ; Hm...  Proprietary, don't use it...
93 disallow=lpc10                  ; Icky sound quality...  Mr. Roboto.
94 ;allow=gsm                      ; Always allow GSM, it's cool :)
95 ;
96
97 ; You can adjust several parameters relating to the jitter buffer.
98 ; The jitter buffer's function is to compensate for varying
99 ; network delay.
100 ;
101 ; All the jitter buffer settings except dropcount are in milliseconds.
102 ; The jitter buffer works for INCOMING audio - the outbound audio
103 ; will be dejittered by the jitter buffer at the other end.
104 ;
105 ; jitterbuffer=yes|no: global default as to whether you want
106 ; the jitter buffer at all.
107 ;
108 ; forcejitterbuffer=yes|no: in the ideal world, when we bridge VoIP channels
109 ; we don't want to do jitterbuffering on the switch, since the endpoints
110 ; can each handle this.  However, some endpoints may have poor jitterbuffers 
111 ; themselves, so this option will force * to always jitterbuffer, even in this
112 ; case.
113 ;
114 ; maxjitterbuffer: a maximum size for the jitter buffer.
115 ; Setting a reasonable maximum here will prevent the call delay
116 ; from rising to silly values in extreme situations; you'll hear
117 ; SOMETHING, even though it will be jittery.
118 ;
119 ; resyncthreshold: when the jitterbuffer notices a significant change in delay
120 ; that continues over a few frames, it will resync, assuming that the change in
121 ; delay was caused by a timestamping mix-up. The threshold for noticing a
122 ; change in delay is measured as twice the measured jitter plus this resync
123 ; threshold.
124 ; Resyncing can be disabled by setting this parameter to -1.
125 ;
126 ; maxjitterinterps: the maximum number of interpolation frames the jitterbuffer
127 ; should return in a row. Since some clients do not send CNG/DTX frames to
128 ; indicate silence, the jitterbuffer will assume silence has begun after
129 ; returning this many interpolations. This prevents interpolating throughout
130 ; a long silence.
131 ;
132 ;
133 ; jittertargetextra: number of milliseconds by which the new jitter buffer
134 ; will pad its size. the default is 40, so without modification, the new
135 ; jitter buffer will set its size to the jitter value plus 40 milliseconds.
136 ; increasing this value may help if your network normally has low jitter,
137 ; but occasionally has spikes.
138 ;
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 ;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 = 0
174 ;
175 ; IAX helper threads
176
177 ; Establishes the number of iax helper threads to handle I/O.
178 ; iaxthreadcount = 10
179 ; Establishes the number of extra dynamic threads that may be spawned to handle I/O
180 ; iaxmaxthreadcount = 100
181 ;
182 ; We can register with another IAX server to let him know where we are
183 ; in case we have a dynamic IP address for example
184 ;
185 ; Register with tormenta using username marko and password secretpass
186 ;
187 ;register => marko:secretpass@tormenta.linux-support.net
188 ;
189 ; Register joe at remote host with no password
190 ;
191 ;register => joe@remotehost:5656
192 ;
193 ; Register marko at tormenta.linux-support.net using RSA key "torkey"
194 ;
195 ;register => marko:[torkey]@tormenta.linux-support.net
196 ;
197 ; Sample Registration for iaxtel
198 ;
199 ; Visit http://www.iaxtel.com to register with iaxtel.  Replace "user"
200 ; and "pass" with your username and password for iaxtel.  Incoming 
201 ; calls arrive at the "s" extension of "default" context.
202 ;
203 ;register => user:pass@iaxtel.com
204 ;
205 ; Sample Registration for IAX + FWD
206 ;
207 ; To register using IAX with FWD, it must be enabled by visiting the URL
208 ; http://www.fwdnet.net/index.php?section_id=112
209 ;
210 ; Note that you need an extension in you default context which matches
211 ; your free world dialup number.  Please replace "FWDNumber" with your
212 ; FWD number and "passwd" with your password.
213 ;
214 ;register => FWDNumber:passwd@iax.fwdnet.net
215 ;
216 ;
217 ; You can disable authentication debugging to reduce the amount of 
218 ; debugging traffic.
219 ;
220 ;authdebug=no
221 ;
222 ; See doc/README.tos for a description of the tos parameters.
223 ;tos=ef
224 ;
225 ; If regcontext is specified, Asterisk will dynamically create and destroy
226 ; a NoOp priority 1 extension for a given peer who registers or unregisters
227 ; with us.  The actual extension is the 'regexten' parameter of the registering
228 ; peer or its name if 'regexten' is not provided.  More than one regexten
229 ; may be supplied if they are separated by '&'.  Patterns may be used in
230 ; regexten.
231 ;
232 ;regcontext=iaxregistrations
233 ;
234 ; If we don't get ACK to our NEW within 2000ms, and autokill is set to yes,
235 ; then we cancel the whole thing (that's enough time for one retransmission
236 ; only).  This is used to keep things from stalling for a long time for a host
237 ; that is not available, but would be ill advised for bad connections.  In
238 ; addition to 'yes' or 'no' you can also specify a number of milliseconds.
239 ; See 'qualify' for individual peers to turn on for just a specific peer.
240 ;
241 autokill=yes
242 ;
243 ; codecpriority controls the codec negotiation of an inbound IAX call.
244 ; This option is inherited to all user entities.  It can also be defined 
245 ; in each user entity separately which will override the setting in general.
246 ;
247 ; The valid values are:
248 ;
249 ; caller   - Consider the callers preferred order ahead of the host's.
250 ; host     - Consider the host's preferred order ahead of the caller's.
251 ; disabled - Disable the consideration of codec preference altogether.
252 ;            (this is the original behaviour before preferences were added)
253 ; reqonly  - Same as disabled, only do not consider capabilities if
254 ;            the requested format is not available the call will only
255 ;            be accepted if the requested format is available.
256 ;
257 ; The default value is 'host'
258 ;
259 ;codecpriority=host
260
261 ;rtcachefriends=yes     ; Cache realtime friends by adding them to the internal list
262                         ; just like friends added from the config file only on a
263                         ; as-needed basis? (yes|no)
264
265 ;rtupdate=yes           ; Send registry updates to database using realtime? (yes|no)
266                         ; If set to yes, when a IAX2 peer registers successfully,
267                         ; the ip address, the origination port, the registration period,
268                         ; and the username of the peer will be set to database via realtime.
269                         ; If not present, defaults to 'yes'.
270
271 ;rtautoclear=yes        ; Auto-Expire friends created on the fly on the same schedule
272                         ; as if it had just registered? (yes|no|<seconds>)
273                         ; If set to yes, when the registration expires, the friend will
274                         ; vanish from the configuration until requested again.
275                         ; If set to an integer, friends expire within this number of
276                         ; seconds instead of the registration interval.
277
278 ;rtignoreregexpire=yes  ; When reading a peer from Realtime, if the peer's registration
279                         ; has expired based on its registration interval, used the stored
280                         ; address information regardless. (yes|no)
281
282 ; Guest sections for unauthenticated connection attempts.  Just specify an
283 ; empty secret, or provide no secret section.
284 ;
285 [guest]
286 type=user
287 context=default
288 callerid="Guest IAX User"
289
290 ;
291 ; Trust Caller*ID Coming from iaxtel.com
292 ;
293 [iaxtel]
294 type=user
295 context=default
296 auth=rsa
297 inkeys=iaxtel
298
299 ;
300 ; Trust Caller*ID Coming from iax.fwdnet.net
301 ;
302 [iaxfwd]
303 type=user
304 context=default
305 auth=rsa
306 inkeys=freeworlddialup
307
308 ;
309 ; Trust callerid delivered over DUNDi/e164
310 ;
311 ;
312 ;[dundi]
313 ;type=user
314 ;dbsecret=dundi/secret
315 ;context=dundi-e164-local
316
317 ;
318 ; Further user sections may be added, specifying a context and a secret used
319 ; for connections with that given authentication name.  Limited IP based
320 ; access control is allowed by use of "allow" and "deny" keywords.  Multiple
321 ; rules are permitted.  Multiple permitted contexts may be specified, in
322 ; which case the first will be the default.  You can also override caller*ID
323 ; so that when you receive a call you set the Caller*ID to be what you want
324 ; instead of trusting what the remote user provides
325 ;
326 ; There are three authentication methods that are supported:  md5, plaintext,
327 ; and rsa.  The least secure is "plaintext", which sends passwords cleartext
328 ; across the net.  "md5" uses a challenge/response md5 sum arrangement, but
329 ; still requires both ends have plain text access to the secret.  "rsa" allows
330 ; unidirectional secret knowledge through public/private keys.  If "rsa"
331 ; authentication is used, "inkeys" is a list of acceptable public keys on the 
332 ; local system that can be used to authenticate the remote peer, separated by
333 ; the ":" character.  "outkey" is a single, private key to use to authenticate
334 ; to the other side.  Public keys are named /var/lib/asterisk/keys/<name>.pub
335 ; while private keys are named /var/lib/asterisk/keys/<name>.key.  Private
336 ; keys should always be 3DES encrypted.
337 ;
338 ;
339 ; NOTE: All hostnames and IP addresses in this file are for example purposes
340 ;       only; you should not expect any of them to actually be available for
341 ;       your use.
342 ;
343 ;
344 ;[markster]
345 ;type=user
346 ;context=default
347 ;context=local
348 ;auth=md5,plaintext,rsa
349 ;secret=markpasswd
350 ;setvar=foo=bar
351 ;dbsecret=mysecrets/place       ; Secrets can be stored in astdb, too
352 ;transfer=no            ; Disable IAX native transfer
353 ;transfer=mediaonly     ; When doing IAX native transfers, transfer 
354                         ; only media stream
355 ;jitterbuffer=yes       ; Override global setting an enable jitter buffer
356 ;                       ; for this user
357 ;maxauthreq=10          ; Set maximum number of outstanding AUTHREQs waiting for replies. Any further authentication attempts will be blocked
358 ;                       ; if this limit is reached until they expire or a reply is received.
359 ;callerid="Mark Spencer" <(256) 428-6275>
360 ;deny=0.0.0.0/0.0.0.0
361 ;accountcode=markster0101
362 ;permit=209.16.236.73/255.255.255.0
363 ;language=en            ; Use english as default language
364 ;
365 ; Peers may also be specified, with a secret and
366 ; a remote hostname.
367 ;
368 [demo]
369 type=peer
370 username=asterisk
371 secret=supersecret
372 host=216.207.245.47
373 ;sendani=no
374 ;host=asterisk.linux-support.net
375 ;port=5036
376 ;mask=255.255.255.255
377 ;qualify=yes                    ; Make sure this peer is alive
378 ;qualifysmoothing = yes         ; use an average of the last two PONG
379                                 ; results to reduce falsely detected LAGGED hosts
380                                 ; Default: Off
381 ;qualifyfreqok = 60000          ; how frequently to ping the peer when
382                                 ; everything seems to be ok, in milliseconds
383 ;qualifyfreqnotok = 10000       ; how frequently to ping the peer when it's
384                                 ; either LAGGED or UNAVAILABLE, in milliseconds
385 ;jitterbuffer=no                ; Turn off jitter buffer for this peer
386
387 ;
388 ; Peers can remotely register as well, so that they can be mobile.  Default
389 ; IP's can also optionally be given but are not required.  Caller*ID can be
390 ; suggested to the other side as well if it is for example a phone instead of
391 ; another PBX.
392 ;
393
394 ;[dynamichost]
395 ;host=dynamic
396 ;secret=mysecret
397 ;mailbox=1234           ; Notify about mailbox 1234
398 ;inkeys=key1:key2
399 ;peercontext=local      ; Default context to request for calls to peer
400 ;defaultip=216.207.245.34
401 ;callerid="Some Host" <(256) 428-6011>
402 ;
403
404 ;
405 ;[biggateway]
406 ;type=peer
407 ;host=192.168.0.1
408 ;context=*
409 ;secret=myscret
410 ;trunk=yes                      ; Use IAX2 trunking with this host
411 ;timezone=America/New_York      ; Set a timezone for the date/time IE
412 ;
413
414 ;
415 ; Friends are a short cut for creating a user and
416 ; a peer with the same values.
417 ;
418 ;[marko]
419 ;type=friend
420 ;host=dynamic
421 ;regexten=1234
422 ;secret=moofoo   ; Multiple secrets may be specified. For a "user", all
423 ;secret=foomoo   ; specified entries will be accepted as valid. For a "peer",
424 ;secret=shazbot  ; only the last specified secret will be used.
425 ;context=default
426 ;permit=0.0.0.0/0.0.0.0
427