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