6.20. iax.conf
1. IAX channel
2. iax.conf (CVS-HEAD-07/30/05)
3. Sample configuration
The file is located in the /etc/asterisk/ directory.
There are two ways of displaying IAX (Inter-Asterisk eXchange) channels in Asterisk. The first one is when you make ougoing call (Outgoing). The second one is for incominng calls (Incoming).
1.1 Outgoing
1.2 Incoming
There are two ways of displaying IAX (Inter-Asterisk eXchange) channels in Asterisk. The first one is when you make ougoing call (Outgoing). The second one is for incominng calls (Incoming).
1.1 Outgoing
IAX2/[<user>[:<secret>]@]<peer>[:<port_number>][/<extension>[@<context>][/<option>]]
<user> and <secret> are used for username and the password on the server represented by <peer> at port <port_number>. <extension> is used to request a specific extension number, which exist in <context> context. You can define optionally special connection option (<option>) – at this time you can use only a for “request auto answer”.
<user> and <secret> are used for username and the password on the server represented by <peer> at port <port_number>. <extension> is used to request a specific extension number, which exist in <context> context. You can define optionally special connection option (<option>) – at this time you can use only a for “request auto answer”.
1.2 Incoming
IAX2/[[<username>@]<host>]/<call_number>
If the username (<username>) is known, it will be displayed. <host> is the address from which is coming the call. <call_number> is the number of local call.
If the username (<username>) is known, it will be displayed. <host> is the address from which is coming the call. <call_number> is the number of local call.
2. iax.conf (CVS-HEAD-07/30/05)
Inter-Asterisk eXchange (IAX) configuration file is divided in contexts. The context [general] contains general settings for the IAX protocol, like on which port Asterisk will listen, to use jitterbuffer, which audio codecs are allowed and which are disallowed, etc ...
Every other context is consider for user account configuration. But what is context?
Context is the group of context name and all of the following after that name lines (the end is the begining of new context):
Example:
2.1 context [general]
All possible options that can be find in this context:
bindport <port_number> Port number to bind to (default 4569).
example: bindport=4569
bindaddr <ip_address> IP address to bind to (default is to bind to local address)
example: bindaddr=192.168.0.1
iaxcompact yes | no If you are using layered switches, set this option to ‘yes’ to get a small performance hit.
example: iaxcompact=no
nochecksumYes | no Disable UDP checksums (if nochecksums is set, then no checkums will be calculated/checked on systems supporting this feature)
example: nochecksum=no
delayreject yes | no To increase security against brute force attacks, enable this option. It will delay the sending of authentication reject for REGREQ or AUTHREP.
amaflags default | omit | billing | documentation This flags are used for generation of iaxtel call detailed records.
accountcode <some_code> To use default account code except the per-user accounting.
example: accountcode=12test45
language <country_code> You can set a default language for all users. Of course you can set per-users basis.
example: language=en
bandwidth low | medium | high With this option you can control which codecs to be used
example: bandwidth=low
allow <codec_name> | all To allow all codecs or specified one. If you are going to enable specific codec/codecs first you must use ‘disallow=all’.
example: allow=lpc10
disallow <codec_name> | all To disallow specific or all codecs.
example: disallow=all
Codecs that can be used in allow/disallow options:
jitterbuffer yes | no If you want to use jitter buffer, set this option to ‘yes’.
example: jitterbuffer=yes
forcejitterbuffer yes | no This option is used when we have endpoints with poor jitterbuffers, so this option will force Asterisk to jitterbuffer always.
example: forcejitterbuffer=no
dropcount <number> It represents what maximum number of frames can be ‘too late’ for the last 2 seconds. It is advised to set to lower number (3 represents 1,5% of frames dropped).
example: dropcount=3
maxjitterbuffer <number> The size of the jitter buffer. Set to reasonable number.
example: maxjitterbuffer=500
maxexcessbuffer <number> If the network delay improves after a period of high jitter, it is possible that the buffer is to bigger than necessary. So if the buffer is above than maxexcessbuffer, Asterisk will start to decrease the amount of the jitter buffer
example: maxexcessbuffer=80
minexcessbuffer <number> This represents the minimum space reserved for the jitter buffer. If the jitter buffer is below this amount, Asterisk will start to increase the amount of the jitter buffer.
example: minexcessbuffer=10
jittershrinkrate <number> This is the milliseconds that are required to shrunk/enlarged the jitter buffer. Use small number, or else you will hear it changing.
example: jittershrinkrate=1
trunkfreq <number> How frequently to send trunk messages (in milliseconds).
example: trunkfreq=20
trunktimestamps yes | no If this option is set, we are going to send timestamps for the individual sub-frames within trunk frames. NOTE: The receiver must also support this feature.
example: trunktimestamps=yes
register <user>[:<password>] @ <remote_host> [:<port>] To register with another IAX server.
example: register => jo:pass@example.net:5506
authdebug yes | no Disable the authentication debuggin to reduce the amount of the debugging traffic.
example: authdebug=no
tos lowdelay | throughput | reliability | mincost | none Setting the TOS bits to improve the performance. (For description look at the table below).
example: tos=lowdelay
Possible TOS settings:
mailboxdetail yes | no If set to ‘yes’ user receives the actual new/old messages counts. This can e set per-peer basis.
example: mailboxdetail=yes
regcontext <string> If regcontext is specified, Asterisk will dynamically create and destroy a NoOp priority 1 extension for a given peer who registers or unregisters with Asterisk PBX.
example: regexten=iaxregistrations
autokill yes | no | <milliseconds> If we don't get acknowedge packet (ACK) in 2000ms and this option is set to 'yes', then we cancel the whole thing. Except yes and no, we can specify the timeout in milliseconds.
example: autokill=yes
codecpriority caller | host | disabled | reqonly This option controls the codec negotiation of inbound IAX call. If this option is set in the user individual context, it will override the setting in the context general. There is explanation of all possible options for this settings below.
example: codecpriority=host
Codecpriority options:
rtcachefriends yes | no Cache realtime friends by adding them to the internal list just like friends added from the config file only on a as-needed basis.
example: rtcachefriends=yes
rtnoupdate yes | no Do not send the update request over realtime.
example: rtnoupdate=yes
rtautoclear yes | no | <seconds> Auto-Expire friends created on the fly on the same schedule as if it had just registered when the registration expires the friend will vanish from the configuration until requested again. If set to an integer, friends expire within this number of seconds instead of the same as the registration interval.
example: rtautoclear=yes
2.2 context [some_user]
All possible optoins that can be set for individual user:
type user | peer | friend To set the type of the user: friend (allow user to make calls and to be called), peer (user can be only called) or user (user can call only).
context <string> Sets the incoming context fot his user.
auth plaintext | md5 | rsa IAX supports three methods for authentication. Plaintext - is the least secure.Md5 - it uses md5 algorithm to confirm the authentication. RSA - is the most secure one. It uses public/private encryption key, that can be generated by astgenkey application (public key must be manually transferred to the server need put in /var/lib/asterisk/keys/<name>.pub, the private keys are placed in /var/lib/asterisk/keys/<name>.key)
secret <password> This is the authentication password for that user.
disallow <codec_name> | all Same as the option in context general.
allow <codec_name> | all Same as the option in context general.
setvar <some_var>=<some_value> We can set some variable.
dbsecret <familiy>/<key> The authentication password can be stored also in the Asterisk database (astdb).
callerid <string> Specify the Caller ID string that will be used for this user.
inkeys <key> The public keys used to decrypt authentication for the incoming client requests.
outkeys <key> The private key used to encrypt the outgoing requests for this user.
permit <ip_addr> | <network_addr> Permit IP address/network for incoming calls.
deny <ip_addr> | <network_addr> Deny IP address/network for incoming calls.
host <ip_addr> | dynamic You can set static IP which will be associated with this account or to use dynamic one (dynamic).
mask <network_mask> Subnet mask for the host.
defaultip <ip_addr> IP address to be used before registration.
accountcode <string> Billing account code.
qualify yes | no| <value> Check this user for availability. The <value> is in milliseconds.
mailbox <mailbox>@<context> Voicemail box for this account.
trunk yes | no If set to yes,it will be used IAX2 trunking for this context.
notransfer yes | no To disable IAX native transfer, set this option to no.
peercontext <string> Default context to request for calls to peer.
regexten <extension> After registration what extensions to be added.
jitterbuffer yes | no We can turn on/off jitterbuffer individually for every user.
Every other context is consider for user account configuration. But what is context?
Context is the group of context name and all of the following after that name lines (the end is the begining of new context):
Example:
start-->[my_first_context]
option1=something
......
end--->
[my_second_context]
option1=something
.....
2.1 context [general]
All possible options that can be find in this context:
bindport <port_number> Port number to bind to (default 4569).
example: bindport=4569
bindaddr <ip_address> IP address to bind to (default is to bind to local address)
example: bindaddr=192.168.0.1
iaxcompact yes | no If you are using layered switches, set this option to ‘yes’ to get a small performance hit.
example: iaxcompact=no
nochecksumYes | no Disable UDP checksums (if nochecksums is set, then no checkums will be calculated/checked on systems supporting this feature)
example: nochecksum=no
delayreject yes | no To increase security against brute force attacks, enable this option. It will delay the sending of authentication reject for REGREQ or AUTHREP.
example: delayreject=yes
amaflags default | omit | billing | documentation This flags are used for generation of iaxtel call detailed records.
example: amaflags=default
accountcode <some_code> To use default account code except the per-user accounting.
example: accountcode=12test45
language <country_code> You can set a default language for all users. Of course you can set per-users basis.
example: language=en
bandwidth low | medium | high With this option you can control which codecs to be used
example: bandwidth=low
allow <codec_name> | all To allow all codecs or specified one. If you are going to enable specific codec/codecs first you must use ‘disallow=all’.
example: allow=lpc10
disallow <codec_name> | all To disallow specific or all codecs.
example: disallow=all
Codecs that can be used in allow/disallow options:
g723.1 g729 h263 slinear gsm alaw adpcm g726 h261 lpc10 speex ilbc ulaw
jitterbuffer yes | no If you want to use jitter buffer, set this option to ‘yes’.
example: jitterbuffer=yes
forcejitterbuffer yes | no This option is used when we have endpoints with poor jitterbuffers, so this option will force Asterisk to jitterbuffer always.
example: forcejitterbuffer=no
dropcount <number> It represents what maximum number of frames can be ‘too late’ for the last 2 seconds. It is advised to set to lower number (3 represents 1,5% of frames dropped).
example: dropcount=3
maxjitterbuffer <number> The size of the jitter buffer. Set to reasonable number.
example: maxjitterbuffer=500
maxexcessbuffer <number> If the network delay improves after a period of high jitter, it is possible that the buffer is to bigger than necessary. So if the buffer is above than maxexcessbuffer, Asterisk will start to decrease the amount of the jitter buffer
example: maxexcessbuffer=80
minexcessbuffer <number> This represents the minimum space reserved for the jitter buffer. If the jitter buffer is below this amount, Asterisk will start to increase the amount of the jitter buffer.
example: minexcessbuffer=10
jittershrinkrate <number> This is the milliseconds that are required to shrunk/enlarged the jitter buffer. Use small number, or else you will hear it changing.
example: jittershrinkrate=1
trunkfreq <number> How frequently to send trunk messages (in milliseconds).
example: trunkfreq=20
trunktimestamps yes | no If this option is set, we are going to send timestamps for the individual sub-frames within trunk frames. NOTE: The receiver must also support this feature.
example: trunktimestamps=yes
register <user>[:<password>] @ <remote_host> [:<port>] To register with another IAX server.
example: register => jo:pass@example.net:5506
authdebug yes | no Disable the authentication debuggin to reduce the amount of the debugging traffic.
example: authdebug=no
tos lowdelay | throughput | reliability | mincost | none Setting the TOS bits to improve the performance. (For description look at the table below).
example: tos=lowdelay
Possible TOS settings:
lowdelay: Minimize delay throughput: Maximize throughput reliability: Maximize reliability mincost: Minimize cost
mailboxdetail yes | no If set to ‘yes’ user receives the actual new/old messages counts. This can e set per-peer basis.
example: mailboxdetail=yes
regcontext <string> If regcontext is specified, Asterisk will dynamically create and destroy a NoOp priority 1 extension for a given peer who registers or unregisters with Asterisk PBX.
example: regexten=iaxregistrations
autokill yes | no | <milliseconds> If we don't get acknowedge packet (ACK) in 2000ms and this option is set to 'yes', then we cancel the whole thing. Except yes and no, we can specify the timeout in milliseconds.
example: autokill=yes
codecpriority caller | host | disabled | reqonly This option controls the codec negotiation of inbound IAX call. If this option is set in the user individual context, it will override the setting in the context general. There is explanation of all possible options for this settings below.
example: codecpriority=host
Codecpriority options:
caller: Consider the callers preferred order ahead of the host's.
host: Consider the host's preferred order ahead of the caller's.
disabled: Disable the consideration of codec preference alltogether.
(this is the original behaviour before preferences were added)
reqonly: Same as disabled, only do not consider capabilities if
the requested format is not available the call will only
be accepted if the requested format is available.rtcachefriends yes | no Cache realtime friends by adding them to the internal list just like friends added from the config file only on a as-needed basis.
example: rtcachefriends=yes
rtnoupdate yes | no Do not send the update request over realtime.
example: rtnoupdate=yes
rtautoclear yes | no | <seconds> Auto-Expire friends created on the fly on the same schedule as if it had just registered when the registration expires the friend will vanish from the configuration until requested again. If set to an integer, friends expire within this number of seconds instead of the same as the registration interval.
example: rtautoclear=yes
2.2 context [some_user]
All possible optoins that can be set for individual user:
type user | peer | friend To set the type of the user: friend (allow user to make calls and to be called), peer (user can be only called) or user (user can call only).
context <string> Sets the incoming context fot his user.
auth plaintext | md5 | rsa IAX supports three methods for authentication. Plaintext - is the least secure.Md5 - it uses md5 algorithm to confirm the authentication. RSA - is the most secure one. It uses public/private encryption key, that can be generated by astgenkey application (public key must be manually transferred to the server need put in /var/lib/asterisk/keys/<name>.pub, the private keys are placed in /var/lib/asterisk/keys/<name>.key)
secret <password> This is the authentication password for that user.
disallow <codec_name> | all Same as the option in context general.
allow <codec_name> | all Same as the option in context general.
setvar <some_var>=<some_value> We can set some variable.
dbsecret <familiy>/<key> The authentication password can be stored also in the Asterisk database (astdb).
callerid <string> Specify the Caller ID string that will be used for this user.
inkeys <key> The public keys used to decrypt authentication for the incoming client requests.
outkeys <key> The private key used to encrypt the outgoing requests for this user.
permit <ip_addr> | <network_addr> Permit IP address/network for incoming calls.
deny <ip_addr> | <network_addr> Deny IP address/network for incoming calls.
host <ip_addr> | dynamic You can set static IP which will be associated with this account or to use dynamic one (dynamic).
mask <network_mask> Subnet mask for the host.
defaultip <ip_addr> IP address to be used before registration.
accountcode <string> Billing account code.
qualify yes | no| <value> Check this user for availability. The <value> is in milliseconds.
mailbox <mailbox>@<context> Voicemail box for this account.
trunk yes | no If set to yes,it will be used IAX2 trunking for this context.
notransfer yes | no To disable IAX native transfer, set this option to no.
peercontext <string> Default context to request for calls to peer.
regexten <extension> After registration what extensions to be added.
jitterbuffer yes | no We can turn on/off jitterbuffer individually for every user.
3. Sample configuration
To test the below IAX configuration, we need a softphone that supports IAX - like Idefisk (download | manual). Also we need some extenesion numbers, if you are unfamiliar with extensions.conf please take a look at this tutorial.
iax.conf:
[general]
bandwidth=low
disallow=lpc10
jitterbuffer=no
forcejitterbuffer=no
tos=lowdelay
autokill=yes
[guest]
type=user
context=test
callerid="Guest IAX User"
[anatoliy]
callerid=Anatoliy K.
username=anatoliy
secret=anatoliy
type=friend
host=dynamic
context=test
disallow=all
allow=ulaw
allow=alaw
allow=gsm
[ivan]
callerid=Ivan T.
username=ivan
;secret=ivan
dbsecret=Password/ivan_iax
type=friend
host=dynamic
context=test
[iax-test]
type=peer
username=iax-test
host=dynamic
trunk=yes
context=test
extensions.conf:
[general]
static=yes
writeprotect=no
autofallthrough=yes
[globals]
;none
[test]
exten => ivan,1,Dial(IAX2/ivan)
exten => ivan,2,HangUp()
exten => 100,1,Goto(ivan,1)
exten => anatoliy,1,Dial(IAX2/anatoliy)
exten => anatoliy,2,HangUp()
exten => 101,1,Goto(anatoliy,1)
exten => iaxtest,1,Dial(IAX2/iax-test)
exten => iaxtest,2,HangUp()
exten => 102,1,Goto(iaxtest,1)
Download the sample configuration files for this tutorial from here: iax_conf.tar.gz
To install them, just make backup copy of your extensions.conf and iax.conf, and then unpack.
iax.conf:
[general]
bandwidth=low
disallow=lpc10
jitterbuffer=no
forcejitterbuffer=no
tos=lowdelay
autokill=yes
[guest]
type=user
context=test
callerid="Guest IAX User"
[anatoliy]
callerid=Anatoliy K.
username=anatoliy
secret=anatoliy
type=friend
host=dynamic
context=test
disallow=all
allow=ulaw
allow=alaw
allow=gsm
[ivan]
callerid=Ivan T.
username=ivan
;secret=ivan
dbsecret=Password/ivan_iax
type=friend
host=dynamic
context=test
[iax-test]
type=peer
username=iax-test
host=dynamic
trunk=yes
context=test
extensions.conf:
[general]
static=yes
writeprotect=no
autofallthrough=yes
[globals]
;none
[test]
exten => ivan,1,Dial(IAX2/ivan)
exten => ivan,2,HangUp()
exten => 100,1,Goto(ivan,1)
exten => anatoliy,1,Dial(IAX2/anatoliy)
exten => anatoliy,2,HangUp()
exten => 101,1,Goto(anatoliy,1)
exten => iaxtest,1,Dial(IAX2/iax-test)
exten => iaxtest,2,HangUp()
exten => 102,1,Goto(iaxtest,1)
To install them, just make backup copy of your extensions.conf and iax.conf, and then unpack.
| Add Comment |
Latest Headlines:
-
T.38 faxing with Zoiper 2.15 is now easier than ever
section: voip software
-
Asterisk 1.4.21 Released
section: Asterisk
-
Asterisk 1.4.20 Released
section: Asterisk
-
Asterisk 1.4.20-rc2 Released
section: Asterisk
-
Asterisk 1.4.20-rc1 Now Available
section: Asterisk
- News Archives (older news)
Latest Tutorials:
-
Sending Fax from Zoiper to Zoiper using T.38
added 08/Dec/2008 18:16
-
VMAuthenticate (dialplan application)
added 01/Mar/2008 15:57
-
Siptronic ST-530
added 06/Nov/2007 17:57
-
Siemens C455 IP hardphone
added 05/Nov/2007 10:24
-
Zoiper
added 22/Oct/2007 17:53
Latest Comments:
-
[url=http://ketodietecrt.com/#]keto diet...
tutorial: X-Lite - SIP softphone
-
Thank you! An abundance of content!
...
tutorial: Voicemail Example 2
-
Lovely information, Kudos.
http://c...
tutorial: Voicemail Example 2
-
Very good material. Regards!
http:/...
tutorial: Voicemail Example 2
-
[url=http://viagraoahvfn.com/#]canadian ...
tutorial: Asterisk 1.4.0 CLI commands