IAX codec fixes (bug #3387)
[asterisk/asterisk.git] / configs / iax.conf.sample
1
2 ; Inter-Asterisk eXchange driver definition
3 ;
4 ;
5 ; General settings, like port number to bind to, and
6 ; an option address (the default is to bind to all
7 ; local addresses).
8 ;
9 [general]
10 ;bindport=4569                  ; bindport and bindaddr may be specified
11 ;bindaddr=192.168.0.1           ; more than once to bind to multiple
12 ;                               ; addresses, but the first will be the 
13 ;                               ; default
14 ;
15 ; Set iaxcompat to yes if you plan to use layered 
16 ; switches.  It incurs a small performance hit to enable it
17 ;
18 ;iaxcompat=yes
19 ;
20 ; For increased security against brute force password attacks
21 ; enable "delayreject" which will delay the sending of authentication
22 ; reject for REGREQ or AUTHREP if there is a password.  
23 ;
24 ;delayreject=yes
25 ;
26 ; You may specify a global default AMA flag for iaxtel calls.  It must be
27 ; one of 'default', 'omit', 'billing', or 'documentation'.  These flags
28 ; are used in the generation of call detail records.
29 ;
30 ;amaflags=default
31 ;
32 ; You may specify a default account for Call Detail Records in addition
33 ; to specifying on a per-user basis
34 ;
35 ;accountcode=lss0101
36 ;
37 ; You may specify a global default language for users. 
38 ; Can be specified also on a per-user basis
39 ; If omitted, will fallback to english
40 ;
41 ;language=en
42 ;
43 ; Specify bandwidth of low, medium, or high to control which codecs are used
44 ; in general.
45 ;
46 bandwidth=low
47 ;
48 ; You can also fine tune codecs here using "allow" and "disallow" clauses
49 ; with specific codecs.  Use "all" to represent all formats.
50 ;
51 ;allow=all                      ; same as bandwidth=high
52 ;disallow=g723.1                ; Hm...  Proprietary, don't use it...
53 disallow=lpc10                  ; Icky sound quality...  Mr. Roboto.
54 ;allow=gsm                      ; Always allow GSM, it's cool :)
55 ;
56
57 ; You can adjust several parameters relating to the jitter buffer.
58 ; The jitter buffer's function is to compensate for varying
59 ; network delay.
60 ;
61 ; All the jitter buffer settings except dropcount are in milliseconds.
62 ; The jitter buffer works for INCOMING audio - the outbound audio
63 ; will be dejittered by the jitter buffer at the other end.
64 ;
65 ; jitterbuffer=yes|no: global default as to whether you want
66 ; the jitter buffer at all.
67 ;
68 ; dropcount: the jitter buffer is sized such that no more than "dropcount"
69 ; frames would have been "too late" over the last 2 seconds.
70 ; Set to a small number.  "3" represents 1.5% of frames dropped
71 ;
72 ; maxjitterbuffer: a maximum size for the jitter buffer.
73 ; Setting a reasonable maximum here will prevent the call delay
74 ; from rising to silly values in extreme situations; you'll hear
75 ; SOMETHING, even though it will be jittery.
76 ;
77 ; maxexcessbuffer: If conditions improve after a period of high jitter,
78 ; the jitter buffer can end up bigger than necessary.  If it ends up
79 ; more than "maxexcessbuffer" bigger than needed, Asterisk will start
80 ; gradually decreasing the amount of jitter buffering.
81 ;
82 ; minexcessbuffer: Sets a desired mimimum amount of headroom in 
83 ; the jitter buffer.  If Asterisk has less headroom than this, then
84 ; it will start gradually increasing the amount of jitter buffering.
85 ;
86 ; jittershrinkrate: when the jitter buffer is being gradually shrunk 
87 ; (or enlarged), how many millisecs shall we take off per 20ms frame
88 ; received?  Use a small number, or you will be able to hear it
89 ; changing.  An example: if you set this to 2, then the jitter buffer
90 ; size will change by 100 millisecs per second.
91
92 jitterbuffer=no
93 ;dropcount=2
94 ;maxjitterbuffer=500
95 ;maxexcessbuffer=80
96 ;minexcessbuffer=10
97 ;jittershrinkrate=1
98
99 ;trunkfreq=20                   ; How frequently to send trunk msgs (in ms)
100 ;
101 ;
102 ; We can register with another IAX server to let him know where we are
103 ; in case we have a dynamic IP address for example
104 ;
105 ; Register with tormenta using username marko and password secretpass
106 ;
107 ;register => marko:secretpass@tormenta.linux-support.net
108 ;
109 ; Register joe at remote host with no password
110 ;
111 ;register => joe@remotehost:5656
112 ;
113 ; Register marko at tormenta.linux-support.net using RSA key "torkey"
114 ;
115 ;register => marko:[torkey]@tormenta.linux-support.net
116 ;
117 ; Sample Registration for iaxtel
118 ;
119 ; Visit http://www.iaxtel.com to register with iaxtel.  Replace "user"
120 ; and "pass" with your username and password for iaxtel.  Incoming 
121 ; calls arrive at the "s" extension of "default" context.
122 ;
123 ;register => user:pass@iaxtel.com
124 ;
125 ; Sample Registration for IAX + FWD
126 ;
127 ; To register using IAX with FWD, it must be enabled by visiting the URL
128 ; http://www.fwdnet.net/index.php?section_id=112
129 ;
130 ; Note that you need an extension in you default context which matches
131 ; your free world dialup number.  Please replace "FWDNumber" with your
132 ; FWD number and "passwd" with your password.
133 ;
134 ;register => FWDNumber:passwd@iax.fwdnet.net
135 ;
136 ;
137 ; You can disable authentication debugging to reduce the amount of 
138 ; debugging traffic.
139 ;
140 ;authdebug=no
141 ;
142 ; Finally, you can set values for your TOS bits to help improve 
143 ; performance.  Valid values are:
144 ;   lowdelay            -- Minimize delay
145 ;   throughput          -- Maximize throughput
146 ;   reliability         -- Maximize reliability
147 ;   mincost             -- Minimize cost
148 ;   none                -- No flags
149 ;
150 tos=lowdelay
151 ;
152 ; If mailboxdetail is set to "yes", the user receives
153 ; the actual new/old message counts, not just a yes/no
154 ; as to whether they have messages.  this can be set on
155 ; a per-peer basis as well
156 ;
157 ;mailboxdetail=yes
158 ;
159 ; If regcontext is specified, Asterisk will dynamically 
160 ; create and destroy a NoOp priority 1 extension for a given
161 ; peer who registers or unregisters with us.  The actual extension
162 ; is the 'regexten' parameter of the registering peer or its
163 ; name if 'regexten' is not provided.  More than one regexten may be supplied
164 ; if they are separated by '&'.  Patterns may be used in regexten.
165 ;
166 ;regcontext=iaxregistrations
167 ;
168 ; If we don't get ACK to our NEW within 2000ms, and autokill is set
169 ; to yes, then we cancel the whole thing (that's enough time for one 
170 ; retransmission only).  This is used to keep things from stalling for a long
171 ; time for a host that is not available, but would be ill advised for bad 
172 ; connections.  In addition to 'yes' or 'no' you can also specify a number
173 ; of milliseconds.  See 'qualify' for individual peers to turn on for just
174 ; a specific peer.
175 ;
176 ;codecpriority=host
177 ;
178 ; codecpriority controls the codec negotiation of an inbound IAX call.
179 ; This option is inherited to all user entities.  It can also be defined 
180 ; in each user entity seperately which will override the setting in general.
181 ;
182 ; The valid values are:
183 ;
184 ; caller   - Consider the callers preferred order ahead of the host's.
185 ; host     - Consider the host's preferred order ahead of the caller's.
186 ; disabled - Disable the consideration of codec preference alltogether.
187 ;            (this is the original behaviour before preferences were added)
188 ; reqonly  - Same as disabled, only do not consider capabilities if
189 ;            the requested format is not available the call will only
190 ;            be accepted if the requested format is available.
191 ;
192 ; The default value is 'host'
193 ;
194 autokill=yes
195 ;
196 ; Guest sections for unauthenticated connection attempts.  Just
197 ; specify an empty secret, or provide no secret section.
198 ;
199 [guest]
200 type=user
201 context=default
202 callerid="Guest IAX User"
203
204 ;
205 ; Trust Caller*ID Coming from iaxtel.com
206 ;
207 [iaxtel]
208 type=user
209 context=default
210 auth=rsa
211 inkeys=iaxtel
212
213 ;
214 ; Trust Caller*ID Coming from iax.fwdnet.net
215 ;
216 [iaxfwd]
217 type=user
218 context=default
219 auth=rsa
220 inkeys=freeworlddialup
221
222 ;
223 ; Trust callerid delivered over DUNDi/e164
224 ;
225 ;
226 ;[dundi]
227 ;type=user
228 ;dbsecret=dundi/secret
229 ;context=dundi-e164-local
230
231 ;
232 ; Further user sections may be added, specifying a context and a
233 ; secret used for connections with that given authentication name.
234 ; Limited IP based access control is allowed by use of "allow" and
235 ; "deny" keywords.  Multiple rules are permitted.  Multiple permitted
236 ; contexts may be specified, in which case the first will be the default.
237 ; You can also override caller*ID so that when you receive a call you
238 ; set the Caller*ID to be what you want instead of trusting what
239 ; the remote user provides
240 ;
241 ; There are three authentication methods that are supported:  md5, plaintext,
242 ; and rsa.  The least secure is "plaintext", which sends passwords cleartext
243 ; across the net.  "md5" uses a challenge/response md5 sum arrangement, but
244 ; still requires both ends have plain text access to the secret.  "rsa" allows
245 ; unidirectional secret knowledge through public/private keys.  If "rsa"
246 ; authentication is used, "inkeys" is a list of acceptable public keys on the 
247 ; local system that can be used to authenticate the remote peer, separated by
248 ; the ":" character.  "outkey" is a single, private key to use to authenticate
249 ; to the other side.  Public keys are named /var/lib/asterisk/keys/<name>.pub
250 ; while private keys are named /var/lib/asterisk/keys/<name>.key.  Private
251 ; keys should always be 3DES encrypted.
252 ;
253 ;
254 ;[markster]
255 ;type=user
256 ;context=default
257 ;context=local
258 ;auth=md5,plaintext,rsa
259 ;secret=markpasswd
260 ;setvar=foo=bar
261 ;dbsecret=mysecrets/place       ; Secrets can be stored in astdb, too
262 ;notransfer=yes         ; Disable IAX native transfer
263 ;jitterbuffer=yes       ; Override global setting an enable jitter buffer
264 ;                       ; for this user
265 ;callerid="Mark Spencer" <(256) 428-6275>
266 ;deny=0.0.0.0/0.0.0.0
267 ;accountcode=markster0101
268 ;permit=209.16.236.73/255.255.255.0
269 ;language=en            ; Use english as default language
270 ;
271 ; Peers may also be specified, with a secret and
272 ; a remote hostname.
273 ;
274 [demo]
275 type=peer
276 username=asterisk
277 secret=supersecret
278 host=216.207.245.47
279 ;sendani=no
280 ;host=asterisk.linux-support.net
281 ;port=5036
282 ;mask=255.255.255.255
283 ;qualify=yes    ; Make sure this peer is alive
284 ;jitterbuffer=no        ; Turn off jitter buffer for this peer
285
286 ;
287 ; Peers can remotely register as well, so that they can be
288 ; mobile.  Default IP's can also optionally be given but
289 ; are not required.  Caller*ID can be suggested to the other
290 ; side as well if it is for example a phone instead of another
291 ; PBX.
292 ;
293
294 ;[dynamichost]
295 ;host=dynamic
296 ;secret=mysecret
297 ;mailbox=1234           ; Notify about mailbox 1234
298 ;inkeys=key1:key2
299 ;peercontext=local      ; Default context to request for calls to peer
300 ;defaultip=216.207.245.34
301 ;callerid="Some Host" <(256) 428-6011>
302 ;
303
304 ;
305 ;[biggateway]
306 ;type=peer
307 ;host=192.168.0.1
308 ;context=*
309 ;secret=myscret
310 ;trunk=yes                      ; Use IAX2 trunking with this host
311 ;timezone=America/New_York      ; Set a timezone for the date/time IE
312 ;
313
314 ;
315 ; Friends are a short cut for creating a user and
316 ; a peer with the same values.
317 ;
318 ;[marko]
319 ;type=friend
320 ;host=dynamic
321 ;regexten=1234
322 ;secret=moofoo
323 ;context=default
324 ;permit=0.0.0.0/0.0.0.0