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