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