doh!
[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 * and chan_iax2;
78 ; the classic and the new, channel/application independent implementation.  These
79 ; are controlled at compile-time.  The new jitterbuffer additionally has support for PLC
80 ; which greatly improves quality as the jitterbuffer adapts size, and in compensating for lost
81 ; 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 case.
94 ; [This option presently applies only to the new jitterbuffer implementation]
95 ;
96 ; dropcount: the jitter buffer is sized such that no more than "dropcount"
97 ; frames would have been "too late" over the last 2 seconds.
98 ; Set to a small number.  "3" represents 1.5% of frames dropped
99 ; [This option is not applicable to, and ignored by the new jitterbuffer implementation]
100 ;
101 ; maxjitterbuffer: a maximum size for the jitter buffer.
102 ; Setting a reasonable maximum here will prevent the call delay
103 ; from rising to silly values in extreme situations; you'll hear
104 ; SOMETHING, even though it will be jittery.
105 ;
106 ; resyncthreshold: when the jitterbuffer notices a significant change in delay
107 ; that continues over a few frames, it will resync, assuming that the change in
108 ; delay was caused by a timestamping mix-up. The threshold for noticing a change
109 ; in delay is measured as twice the measured jitter plus this resync threshold.
110 ; Resycning can be disabled by setting this parameter to -1.
111 ; [This option presently applies only to the new jitterbuffer implementation]
112 ;
113 ; maxjitterinterps: the maximum number of interpolation frames the jitterbuffer should
114 ; return in a row. Since some clients do not send CNG/DTX frames to indicate
115 ; silence, the jitterbuffer will assume silence has begun after returning this
116 ; many interpolations. This prevents interpolating throughout a long silence.
117 ; [This option presently applies only to the new jitterbuffer implementation]
118 ;
119 ; maxexcessbuffer: If conditions improve after a period of high jitter,
120 ; the jitter buffer can end up bigger than necessary.  If it ends up
121 ; more than "maxexcessbuffer" bigger than needed, Asterisk will start
122 ; gradually decreasing the amount of jitter buffering.
123 ; [This option is not applicable to, and ignored by the new jitterbuffer implementation]
124 ;
125 ; minexcessbuffer: Sets a desired mimimum amount of headroom in 
126 ; the jitter buffer.  If Asterisk has less headroom than this, then
127 ; it will start gradually increasing the amount of jitter buffering.
128 ; [This option is not applicable to, and ignored by the new jitterbuffer implementation]
129 ;
130 ; jittershrinkrate: when the jitter buffer is being gradually shrunk 
131 ; (or enlarged), how many millisecs shall we take off per 20ms frame
132 ; received?  Use a small number, or you will be able to hear it
133 ; changing.  An example: if you set this to 2, then the jitter buffer
134 ; size will change by 100 millisecs per second.
135 ; [This option is not applicable to, and ignored by the new jitterbuffer implementation]
136
137 jitterbuffer=no
138 forcejitterbuffer=no
139 ;dropcount=2
140 ;maxjitterbuffer=1000
141 ;maxjitterinterps=10
142 ;resyncthreshold=1000
143 ;maxexcessbuffer=80
144 ;minexcessbuffer=10
145 ;jittershrinkrate=1
146
147 ;trunkfreq=20                   ; How frequently to send trunk msgs (in ms)
148
149 ; Should we send timestamps for the individual sub-frames within trunk frames?
150 ; There is a small bandwidth use for these (less than 1kbps/call), but they ensure
151 ; that frame timestamps get sent end-to-end properly.  If both ends of all your trunks
152 ; go directly to TDM, _and_ your trunkfreq equals the frame length for your codecs, you 
153 ; can probably suppress these.  The receiver must also support this feature, although
154 ; they do not also need to have it enabled.
155 ;
156 ; trunktimestamps=yes
157
158 ;
159 ;
160 ; We can register with another IAX server to let him know where we are
161 ; in case we have a dynamic IP address for example
162 ;
163 ; Register with tormenta using username marko and password secretpass
164 ;
165 ;register => marko:secretpass@tormenta.linux-support.net
166 ;
167 ; Register joe at remote host with no password
168 ;
169 ;register => joe@remotehost:5656
170 ;
171 ; Register marko at tormenta.linux-support.net using RSA key "torkey"
172 ;
173 ;register => marko:[torkey]@tormenta.linux-support.net
174 ;
175 ; Sample Registration for iaxtel
176 ;
177 ; Visit http://www.iaxtel.com to register with iaxtel.  Replace "user"
178 ; and "pass" with your username and password for iaxtel.  Incoming 
179 ; calls arrive at the "s" extension of "default" context.
180 ;
181 ;register => user:pass@iaxtel.com
182 ;
183 ; Sample Registration for IAX + FWD
184 ;
185 ; To register using IAX with FWD, it must be enabled by visiting the URL
186 ; http://www.fwdnet.net/index.php?section_id=112
187 ;
188 ; Note that you need an extension in you default context which matches
189 ; your free world dialup number.  Please replace "FWDNumber" with your
190 ; FWD number and "passwd" with your password.
191 ;
192 ;register => FWDNumber:passwd@iax.fwdnet.net
193 ;
194 ;
195 ; You can disable authentication debugging to reduce the amount of 
196 ; debugging traffic.
197 ;
198 ;authdebug=no
199 ;
200 ; Finally, you can set values for your TOS bits to help improve 
201 ; performance.  Valid values are:
202 ;   lowdelay            -- Minimize delay
203 ;   throughput          -- Maximize throughput
204 ;   reliability         -- Maximize reliability
205 ;   mincost             -- Minimize cost
206 ;   none                -- No flags
207 ;
208 tos=lowdelay
209 ;
210 ; If mailboxdetail is set to "yes", the user receives
211 ; the actual new/old message counts, not just a yes/no
212 ; as to whether they have messages.  this can be set on
213 ; a per-peer basis as well
214 ;
215 ;mailboxdetail=yes
216 ;
217 ; If regcontext is specified, Asterisk will dynamically 
218 ; create and destroy a NoOp priority 1 extension for a given
219 ; peer who registers or unregisters with us.  The actual extension
220 ; is the 'regexten' parameter of the registering peer or its
221 ; name if 'regexten' is not provided.  More than one regexten may be supplied
222 ; if they are separated by '&'.  Patterns may be used in regexten.
223 ;
224 ;regcontext=iaxregistrations
225 ;
226 ; If we don't get ACK to our NEW within 2000ms, and autokill is set
227 ; to yes, then we cancel the whole thing (that's enough time for one 
228 ; retransmission only).  This is used to keep things from stalling for a long
229 ; time for a host that is not available, but would be ill advised for bad 
230 ; connections.  In addition to 'yes' or 'no' you can also specify a number
231 ; of milliseconds.  See 'qualify' for individual peers to turn on for just
232 ; a specific peer.
233 ;
234 autokill=yes
235 ;
236 ; codecpriority controls the codec negotiation of an inbound IAX call.
237 ; This option is inherited to all user entities.  It can also be defined 
238 ; in each user entity separately which will override the setting in general.
239 ;
240 ; The valid values are:
241 ;
242 ; caller   - Consider the callers preferred order ahead of the host's.
243 ; host     - Consider the host's preferred order ahead of the caller's.
244 ; disabled - Disable the consideration of codec preference alltogether.
245 ;            (this is the original behaviour before preferences were added)
246 ; reqonly  - Same as disabled, only do not consider capabilities if
247 ;            the requested format is not available the call will only
248 ;            be accepted if the requested format is available.
249 ;
250 ; The default value is 'host'
251 ;
252 ;codecpriority=host
253
254 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
255                                 ; just like friends added from the config file only on a
256                                 ; as-needed basis? (yes|no)
257
258 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
259                                 ; If set to yes, when a IAX2 peer registers successfully, the ip address,
260                                 ; the origination port, the registration period, and the username of
261                                 ; the peer will be set to database via realtime. 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 vanish from
266                                 ; the configuration until requested again. If set to an integer,
267                                 ; friends expire within this number of seconds instead of the
268                                 ; 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
275 ; specify an 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
311 ; secret used for connections with that given authentication name.
312 ; Limited IP based access control is allowed by use of "allow" and
313 ; "deny" keywords.  Multiple rules are permitted.  Multiple permitted
314 ; contexts may be specified, in which case the first will be the default.
315 ; You can also override caller*ID so that when you receive a call you
316 ; set the Caller*ID to be what you want instead of trusting what
317 ; the remote user provides
318 ;
319 ; There are three authentication methods that are supported:  md5, plaintext,
320 ; and rsa.  The least secure is "plaintext", which sends passwords cleartext
321 ; across the net.  "md5" uses a challenge/response md5 sum arrangement, but
322 ; still requires both ends have plain text access to the secret.  "rsa" allows
323 ; unidirectional secret knowledge through public/private keys.  If "rsa"
324 ; authentication is used, "inkeys" is a list of acceptable public keys on the 
325 ; local system that can be used to authenticate the remote peer, separated by
326 ; the ":" character.  "outkey" is a single, private key to use to authenticate
327 ; to the other side.  Public keys are named /var/lib/asterisk/keys/<name>.pub
328 ; while private keys are named /var/lib/asterisk/keys/<name>.key.  Private
329 ; keys should always be 3DES encrypted.
330 ;
331 ;
332 ;[markster]
333 ;type=user
334 ;context=default
335 ;context=local
336 ;auth=md5,plaintext,rsa
337 ;secret=markpasswd
338 ;setvar=foo=bar
339 ;dbsecret=mysecrets/place       ; Secrets can be stored in astdb, too
340 ;notransfer=yes         ; Disable IAX native transfer
341 ;jitterbuffer=yes       ; Override global setting an enable jitter buffer
342 ;                       ; for this user
343 ;callerid="Mark Spencer" <(256) 428-6275>
344 ;deny=0.0.0.0/0.0.0.0
345 ;accountcode=markster0101
346 ;permit=209.16.236.73/255.255.255.0
347 ;language=en            ; Use english as default language
348 ;
349 ; Peers may also be specified, with a secret and
350 ; a remote hostname.
351 ;
352 [demo]
353 type=peer
354 username=asterisk
355 secret=supersecret
356 host=216.207.245.47
357 ;sendani=no
358 ;host=asterisk.linux-support.net
359 ;port=5036
360 ;mask=255.255.255.255
361 ;qualify=yes                    ; Make sure this peer is alive
362 ;qualifysmoothing = yes         ; use an average of the last two PONG
363                                 ; results to reduce falsly detected LAGGED hosts
364                                 ; Default: Off
365 ;qualifyfreqok = 60000          ; how frequently to ping the peer when
366                                 ; everything seems to be ok, in milliseconds
367 ;qualifyfreqnotok = 10000       ; how frequently to ping the peer when it's
368                                 ; either LAGGED or UNAVAILABLE, in milliseconds
369 ;jitterbuffer=no                ; Turn off jitter buffer for this peer
370
371 ;
372 ; Peers can remotely register as well, so that they can be
373 ; mobile.  Default IP's can also optionally be given but
374 ; are not required.  Caller*ID can be suggested to the other
375 ; side as well if it is for example a phone instead of another
376 ; PBX.
377 ;
378
379 ;[dynamichost]
380 ;host=dynamic
381 ;secret=mysecret
382 ;mailbox=1234           ; Notify about mailbox 1234
383 ;inkeys=key1:key2
384 ;peercontext=local      ; Default context to request for calls to peer
385 ;defaultip=216.207.245.34
386 ;callerid="Some Host" <(256) 428-6011>
387 ;
388
389 ;
390 ;[biggateway]
391 ;type=peer
392 ;host=192.168.0.1
393 ;context=*
394 ;secret=myscret
395 ;trunk=yes                      ; Use IAX2 trunking with this host
396 ;timezone=America/New_York      ; Set a timezone for the date/time IE
397 ;
398
399 ;
400 ; Friends are a short cut for creating a user and
401 ; a peer with the same values.
402 ;
403 ;[marko]
404 ;type=friend
405 ;host=dynamic
406 ;regexten=1234
407 ;secret=moofoo
408 ;context=default
409 ;permit=0.0.0.0/0.0.0.0