Formatting fixes
[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, 
127 ;       and ignored by the new jitterbuffer implementation
128 ;
129 ; minexcessbuffer: Sets a desired mimimum amount of headroom in 
130 ; the jitter buffer.  If Asterisk has less headroom than this, then
131 ; it will start gradually increasing the amount of jitter buffering.
132 ;       This option is not applicable to, 
133 ;       and ignored by the new jitterbuffer implementation
134 ;
135 ; jittershrinkrate: when the jitter buffer is being gradually shrunk 
136 ; (or enlarged), how many millisecs shall we take off per 20ms frame
137 ; received?  Use a small number, or you will be able to hear it
138 ; changing.  An example: if you set this to 2, then the jitter buffer
139 ; size will change by 100 millisecs per second.
140 ;       This option is not applicable to, 
141 ;       and ignored by the new jitterbuffer implementation
142
143 jitterbuffer=no
144 forcejitterbuffer=no
145 ;dropcount=2
146 ;maxjitterbuffer=1000
147 ;maxjitterinterps=10
148 ;resyncthreshold=1000
149 ;maxexcessbuffer=80
150 ;minexcessbuffer=10
151 ;jittershrinkrate=1
152
153 ;trunkfreq=20                   ; How frequently to send trunk msgs (in ms)
154
155 ; Should we send timestamps for the individual sub-frames within trunk frames?
156 ; There is a small bandwidth use for these (less than 1kbps/call), but they
157 ; ensure that frame timestamps get sent end-to-end properly.  If both ends of
158 ; all your trunks go directly to TDM, _and_ your trunkfreq equals the frame
159 ; length for your codecs, you can probably suppress these.  The receiver must
160 ; also support this feature, although they do not also need to have it enabled.
161 ;
162 ; trunktimestamps=yes
163 ;
164 ; Minimum and maximum amounts of time that IAX peers can request as
165 ; a registration expiration interval (in seconds).
166 ; minregexpire = 60
167 ; maxregexpire = 60
168 ;
169 ; IAX helper threads
170 ; Establishes the number of iax helper threads to handle I/O.
171 ; iaxthreadcount = 10
172 ;
173 ; We can register with another IAX server to let him know where we are
174 ; in case we have a dynamic IP address for example
175 ;
176 ; Register with tormenta using username marko and password secretpass
177 ;
178 ;register => marko:secretpass@tormenta.linux-support.net
179 ;
180 ; Register joe at remote host with no password
181 ;
182 ;register => joe@remotehost:5656
183 ;
184 ; Register marko at tormenta.linux-support.net using RSA key "torkey"
185 ;
186 ;register => marko:[torkey]@tormenta.linux-support.net
187 ;
188 ; Sample Registration for iaxtel
189 ;
190 ; Visit http://www.iaxtel.com to register with iaxtel.  Replace "user"
191 ; and "pass" with your username and password for iaxtel.  Incoming 
192 ; calls arrive at the "s" extension of "default" context.
193 ;
194 ;register => user:pass@iaxtel.com
195 ;
196 ; Sample Registration for IAX + FWD
197 ;
198 ; To register using IAX with FWD, it must be enabled by visiting the URL
199 ; http://www.fwdnet.net/index.php?section_id=112
200 ;
201 ; Note that you need an extension in you default context which matches
202 ; your free world dialup number.  Please replace "FWDNumber" with your
203 ; FWD number and "passwd" with your password.
204 ;
205 ;register => FWDNumber:passwd@iax.fwdnet.net
206 ;
207 ;
208 ; You can disable authentication debugging to reduce the amount of 
209 ; debugging traffic.
210 ;
211 ;authdebug=no
212 ;
213 ; See doc/README.tos for a description of the tos parameters.
214 ;tos=ef
215 ;
216 ; If regcontext is specified, Asterisk will dynamically create and destroy
217 ; a NoOp priority 1 extension for a given peer who registers or unregisters
218 ; with us.  The actual extension is the 'regexten' parameter of the registering
219 ; peer or its name if 'regexten' is not provided.  More than one regexten
220 ; may be supplied if they are separated by '&'.  Patterns may be used in
221 ; regexten.
222 ;
223 ;regcontext=iaxregistrations
224 ;
225 ; If we don't get ACK to our NEW within 2000ms, and autokill is set to yes,
226 ; then we cancel the whole thing (that's enough time for one retransmission
227 ; only).  This is used to keep things from stalling for a long time for a host
228 ; that is not available, but would be ill advised for bad connections.  In
229 ; addition to 'yes' or 'no' you can also specify a number of milliseconds.
230 ; See 'qualify' for individual peers to turn on for just a specific peer.
231 ;
232 autokill=yes
233 ;
234 ; codecpriority controls the codec negotiation of an inbound IAX call.
235 ; This option is inherited to all user entities.  It can also be defined 
236 ; in each user entity separately which will override the setting in general.
237 ;
238 ; The valid values are:
239 ;
240 ; caller   - Consider the callers preferred order ahead of the host's.
241 ; host     - Consider the host's preferred order ahead of the caller's.
242 ; disabled - Disable the consideration of codec preference alltogether.
243 ;            (this is the original behaviour before preferences were added)
244 ; reqonly  - Same as disabled, only do not consider capabilities if
245 ;            the requested format is not available the call will only
246 ;            be accepted if the requested format is available.
247 ;
248 ; The default value is 'host'
249 ;
250 ;codecpriority=host
251
252 ;rtcachefriends=yes     ; Cache realtime friends by adding them to the internal list
253                         ; just like friends added from the config file only on a
254                         ; as-needed basis? (yes|no)
255
256 ;rtupdate=yes           ; Send registry updates to database using realtime? (yes|no)
257                         ; If set to yes, when a IAX2 peer registers successfully,
258                         ; the ip address, the origination port, the registration period,
259                         ; and the username of the peer will be set to database via realtime.
260                         ; If not present, defaults to 'yes'.
261
262 ;rtautoclear=yes        ; Auto-Expire friends created on the fly on the same schedule
263                         ; as if it had just registered? (yes|no|<seconds>)
264                         ; If set to yes, when the registration expires, the friend will
265                         ; vanish from the configuration until requested again.
266                         ; If set to an integer, friends expire within this number of
267                         ; seconds instead of the registration interval.
268
269 ;rtignoreexpire=yes     ; When reading a peer from Realtime, if the peer's registration
270                         ; has expired based on its registration interval, used the stored
271                         ; address information regardless. (yes|no)
272
273 ; Guest sections for unauthenticated connection attempts.  Just specify an
274 ; empty secret, or provide no secret section.
275 ;
276 [guest]
277 type=user
278 context=default
279 callerid="Guest IAX User"
280
281 ;
282 ; Trust Caller*ID Coming from iaxtel.com
283 ;
284 [iaxtel]
285 type=user
286 context=default
287 auth=rsa
288 inkeys=iaxtel
289
290 ;
291 ; Trust Caller*ID Coming from iax.fwdnet.net
292 ;
293 [iaxfwd]
294 type=user
295 context=default
296 auth=rsa
297 inkeys=freeworlddialup
298
299 ;
300 ; Trust callerid delivered over DUNDi/e164
301 ;
302 ;
303 ;[dundi]
304 ;type=user
305 ;dbsecret=dundi/secret
306 ;context=dundi-e164-local
307
308 ;
309 ; Further user sections may be added, specifying a context and a secret used
310 ; for connections with that given authentication name.  Limited IP based
311 ; access control is allowed by use of "allow" and "deny" keywords.  Multiple
312 ; rules are permitted.  Multiple permitted contexts may be specified, in
313 ; which case the first will be the default.  You can also override caller*ID
314 ; so that when you receive a call you set the Caller*ID to be what you want
315 ; instead of trusting what the remote user provides
316 ;
317 ; There are three authentication methods that are supported:  md5, plaintext,
318 ; and rsa.  The least secure is "plaintext", which sends passwords cleartext
319 ; across the net.  "md5" uses a challenge/response md5 sum arrangement, but
320 ; still requires both ends have plain text access to the secret.  "rsa" allows
321 ; unidirectional secret knowledge through public/private keys.  If "rsa"
322 ; authentication is used, "inkeys" is a list of acceptable public keys on the 
323 ; local system that can be used to authenticate the remote peer, separated by
324 ; the ":" character.  "outkey" is a single, private key to use to authenticate
325 ; to the other side.  Public keys are named /var/lib/asterisk/keys/<name>.pub
326 ; while private keys are named /var/lib/asterisk/keys/<name>.key.  Private
327 ; keys should always be 3DES encrypted.
328 ;
329 ;
330 ; NOTE: All hostnames and IP addresses in this file are for example purposes
331 ;       only; you should not expect any of them to actually be available for
332 ;       your use.
333 ;
334 ;
335 ;[markster]
336 ;type=user
337 ;context=default
338 ;context=local
339 ;auth=md5,plaintext,rsa
340 ;secret=markpasswd
341 ;setvar=foo=bar
342 ;dbsecret=mysecrets/place       ; Secrets can be stored in astdb, too
343 ;notransfer=yes         ; Disable IAX native transfer
344 ;jitterbuffer=yes       ; Override global setting an enable jitter buffer
345 ;                       ; for this user
346 ;callerid="Mark Spencer" <(256) 428-6275>
347 ;deny=0.0.0.0/0.0.0.0
348 ;accountcode=markster0101
349 ;permit=209.16.236.73/255.255.255.0
350 ;language=en            ; Use english as default language
351 ;
352 ; Peers may also be specified, with a secret and
353 ; a remote hostname.
354 ;
355 [demo]
356 type=peer
357 username=asterisk
358 secret=supersecret
359 host=216.207.245.47
360 ;sendani=no
361 ;host=asterisk.linux-support.net
362 ;port=5036
363 ;mask=255.255.255.255
364 ;qualify=yes                    ; Make sure this peer is alive
365 ;qualifysmoothing = yes         ; use an average of the last two PONG
366                                 ; results to reduce falsly detected LAGGED hosts
367                                 ; Default: Off
368 ;qualifyfreqok = 60000          ; how frequently to ping the peer when
369                                 ; everything seems to be ok, in milliseconds
370 ;qualifyfreqnotok = 10000       ; how frequently to ping the peer when it's
371                                 ; either LAGGED or UNAVAILABLE, in milliseconds
372 ;jitterbuffer=no                ; Turn off jitter buffer for this peer
373
374 ;
375 ; Peers can remotely register as well, so that they can be mobile.  Default
376 ; IP's can also optionally be given but are not required.  Caller*ID can be
377 ; suggested to the other side as well if it is for example a phone instead of
378 ; another PBX.
379 ;
380
381 ;[dynamichost]
382 ;host=dynamic
383 ;secret=mysecret
384 ;mailbox=1234           ; Notify about mailbox 1234
385 ;inkeys=key1:key2
386 ;peercontext=local      ; Default context to request for calls to peer
387 ;defaultip=216.207.245.34
388 ;callerid="Some Host" <(256) 428-6011>
389 ;
390
391 ;
392 ;[biggateway]
393 ;type=peer
394 ;host=192.168.0.1
395 ;context=*
396 ;secret=myscret
397 ;trunk=yes                      ; Use IAX2 trunking with this host
398 ;timezone=America/New_York      ; Set a timezone for the date/time IE
399 ;
400
401 ;
402 ; Friends are a short cut for creating a user and
403 ; a peer with the same values.
404 ;
405 ;[marko]
406 ;type=friend
407 ;host=dynamic
408 ;regexten=1234
409 ;secret=moofoo
410 ;context=default
411 ;permit=0.0.0.0/0.0.0.0
412