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