~davewalker/ubuntu/maverick/asterisk/lp_705014

« back to all changes in this revision

Viewing changes to doc/README.iax

  • Committer: Bazaar Package Importer
  • Author(s): Kilian Krause
  • Date: 2005-03-09 22:09:05 UTC
  • mto: (1.2.1 upstream) (8.2.1 experimental)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20050309220905-9afy6hcpw96xbr6j
Tags: upstream-1.0.6
ImportĀ upstreamĀ versionĀ 1.0.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
133
133
 
134
134
Following the first line are a number of other possibilities:
135
135
 
136
 
> port = <portnum>
 
136
> bindport = <portnum>
137
137
 
138
 
This sets the port that IAX will bind to.  The default IAX port number is 
139
 
5036.  It is recommended that this value not be altered in general.
 
138
This sets the port that IAX will bind to.  The default IAX version 1 
 
139
port number is 5036.  For IAX version 2, that is now the default in
 
140
Asterisk, the default port is 4569.
 
141
It is recommended that this value not be altered in general.
140
142
 
141
143
> bindaddr = <ipaddr>
142
144
 
170
172
 
171
173
These parameters control the operation of the jitter buffer.  The 
172
174
jitterbuffer should always be enabled unless you expect all your 
173
 
connections to be over a LAN.  The drop count is the maximum number of 
174
 
voice packets to allow to drop (out of 100).  Useful values are 3-10.  The 
175
 
maxjitterbuffer is the maximum amount of jitter buffer to permit to be 
176
 
used.  The "maxexcessbuffer" is the maximum amount of excess jitter buffer 
177
 
that is permitted before the jitter buffer is slowly shrunk to eliminate 
178
 
latency.
 
175
connections to be over a LAN.  
 
176
* drop count is the maximum number of voice packets to allow to drop 
 
177
  (out of 100).  Useful values are 3-10.  
 
178
* maxjitterbuffer is the maximum amount of jitter buffer to permit to be 
 
179
  used.  
 
180
* maxexcessbuffer is the maximum amount of excess jitter buffer 
 
181
  that is permitted before the jitter buffer is slowly shrunk to eliminate 
 
182
  latency.
 
183
* minexcessbuffer is the minimum amout of excess jitter buffer
179
184
 
180
185
> accountcode = <code>
181
186
> amaflags = [default|omit|billing|documentation]
208
213
identify ourselves as.  A secret may be provided as well.  The secret is 
209
214
generally a shared password between the local server and the remote 
210
215
server.  However, if the secret is in square brackets ([]'s) then it is 
211
 
interpreted as the name of a key to use.  In that case, the local Asterisk 
 
216
interpreted as the name of a RSA key to use.  In that case, the local Asterisk 
212
217
server must have the *private* key (/var/lib/asterisk/keys/<name>.key) and 
213
218
the remote server will have to have the corresponding public key.
214
219
 
215
220
The "host" is a required field and is the hostname or IP address of the 
216
221
remote Asterisk server.  The port specification is optional and is by 
217
 
default 5036 if not specified.
 
222
default 4569 for iax2 if not specified.
 
223
 
 
224
> notransfer = yes | no
 
225
 
 
226
If an IAX phone calls another IAX phone by using a Asterisk server, 
 
227
Asterisk will transfer the call to go peer to peer. If you do not
 
228
want this, turn on notransfer with a "yes". This is also settable
 
229
for peers and users.
218
230
 
219
231
-------------
220
232
 
232
244
> type = [user|peer|friend]
233
245
 
234
246
This line tells Asterisk how to interpret this entity.  Users are things 
235
 
that connect to us, while peers are people we connect to, and a friend is 
 
247
that connect to us, while peers are phones we connect to, and a friend is 
236
248
shorthand for creating a user and a peer with identical information
237
249
 
238
250
----------------
262
274
would deny anyone in 192.168.0.0 with a netmask of 24 bits (class C), 
263
275
whereas:
264
276
 
265
 
> deny = 192.168.0.0/255.255.255.0
266
 
> permit = 0.0.0.0/0.0.0.0
 
277
> deny = 192.168.0.0/24
 
278
> permit = 0.0.0.0/0
267
279
 
268
280
would not deny anyone since the final rule would permit anyone, thus 
269
281
overriding the denial.  
281
293
 
282
294
You may select which authentication methods are permitted to be used by 
283
295
the user to authenticate to us.  Multiple methods may be specified, 
284
 
separated by commas.  If md5 or plaintext authentication is selected, a 
285
 
secret must be provided.  If RSA authentication is specified, then one or 
 
296
separated by commas. If md5 or plaintext authentication is selected, a 
 
297
secret must be provided. If RSA authentication is specified, then one or 
286
298
more key names must be specified with "inkeys"
287
299
 
288
300
If no secret is specified and no authentication method is specified, then 
323
335
default IP address to use when dynamic registration has not been performed 
324
336
or has timed out.
325
337
 
326
 
 
 
338
> peercontext = <context>
 
339
 
 
340
Specifies the context name to be passed to the peer for it to use when routing
 
341
the call through its dial plan. This entry will be used only if a context
 
342
is not included in the IAX2 channel name passed to the Dial command.
 
343
 
 
344
> qualify = [yes | no | <value>]
 
345
 
 
346
Qualify turns on checking of availability of the remote peer. If the 
 
347
peer becomes unavailable, no calls are placed to the peer until
 
348
it is reachable again. This is also helpful in certain NAT situations.
 
349
 
 
350
> jitterbuffer = [yes | no]
 
351
 
 
352
Turns on or off the jitterbuffer for this peer
 
353
 
 
354
> mailbox = <mailbox>[@mailboxcontext]
 
355
 
 
356
Specifies a mailbox to check for voicemail notification.
 
357
 
 
358
> permit = <ipaddr>/<netmask>
 
359
> deny = <ipaddr>/<netmask>
 
360
 
 
361
Permit and deny rules may be applied to users, allowing them to connect 
 
362
from certain IP addresses and not others.  The permit and deny rules are 
 
363
interpreted in sequence and all are evaluated on a given IP address, with 
 
364
the final result being the decision.  See the user section above 
 
365
for examples.
 
366
 
 
367
----------------------------------------------------------------------
 
368
For more examples of a configuration, please see the iax.conf.sample in
 
369
your the /configs directory of you source code distribution