aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
author(no author) <(no author)@f38db490-d61c-443f-a65b-d21fe96a405b>2005-02-28 00:30:35 +0000
committer(no author) <(no author)@f38db490-d61c-443f-a65b-d21fe96a405b>2005-02-28 00:30:35 +0000
commita3fc10473cb9e3f63ee4b34acef46288eb8eb79c (patch)
tree280c9526748aed9d54b9ea94cdf2976ef90b0802 /doc
parent27a9c96742202c8188b53a0173649de479256b69 (diff)
This commit was manufactured by cvs2svn to create tag 'v1-0-6'.
git-svn-id: http://svn.digium.com/svn/asterisk/tags/v1-0-6@5102 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/README.cdr28
-rwxr-xr-xdoc/README.iax71
-rwxr-xr-xdoc/README.variables7
-rwxr-xr-xdoc/cdr.txt2
4 files changed, 81 insertions, 27 deletions
diff --git a/doc/README.cdr b/doc/README.cdr
index 2b0c8f289..cb71ba03e 100755
--- a/doc/README.cdr
+++ b/doc/README.cdr
@@ -2,25 +2,38 @@ Asterisk billing support - Call Detail Records
----------------------------------------------
Asterisk generates Call Detail Records in a database or in a comma
separated text file.
+
* cdr_csv supports comma separated text file storage, this is the
default driver
+ * cdr_manager supports CDR information via the AMI, The Asterisk Manager
+ interface
* cdr_odbc supports UnixODBC databases, see http://www.unixodbc.org
for an updated list of supported databases, from MySQL to MsSQL
and text files.
+ * cdr_tds supports FreeTDS databases (Among them MS SQL)
+ * cdr_sqlite supports SQlite
+ * cdr_pgsql supports PostgreSQL
+
+In the asterisk-addons cvs archive, there's a cdr_mysql driver for
+MySQL.
Applications
------------
- * Asterisk cmd setaccount: Set account code for billing
- * Asterisk cmd NoCDR: Make sure no CDR is saved for a specific call
- * Asterisk cmd resetCDR: Reset CDR
- * Asterisk cmd authenticate - Authenticates and sets the account code
- * Asterisk cmd SetCDRUserField - Set CDR user field
- * Asterisk cmd AppendCDRUserField - Append data to CDR User field
+ * setaccount Set account code for billing
+ * setAMAflags Sets AMA flags
+ * NoCDR Make sure no CDR is saved for a specific call
+ * resetCDR Reset CDR
+ * forkCDR Save current CDR and start a new CDR for this call
+ * authenticate Authenticates and sets the account code
+ * SetCDRUserField Set CDR user field
+ * AppendCDRUserField Append data to CDR User field
For more information, use the "show application" command.
+You can set default account codes and AMA flags for devices in
+channel configuration files, like sip.conf, iax.conf etc.
Fields of the CDR in Asterisk
@@ -59,5 +72,4 @@ will report a short call time. If you want detailed records you must
turn off IAX transfer, but unless your servers are very close together, you
will definitely get a latency hit from doing so.
-----------------
-2004-01-17/v0.7.1
+
diff --git a/doc/README.iax b/doc/README.iax
index 10f6a8089..1a35d6b15 100755
--- a/doc/README.iax
+++ b/doc/README.iax
@@ -133,10 +133,12 @@ The first line of the "general" section is always:
Following the first line are a number of other possibilities:
-> port = <portnum>
+> bindport = <portnum>
-This sets the port that IAX will bind to. The default IAX port number is
-5036. It is recommended that this value not be altered in general.
+This sets the port that IAX will bind to. The default IAX version 1
+port number is 5036. For IAX version 2, that is now the default in
+Asterisk, the default port is 4569.
+It is recommended that this value not be altered in general.
> bindaddr = <ipaddr>
@@ -170,12 +172,15 @@ disallow the LPC10 codec just because it doesn't sound very good.
These parameters control the operation of the jitter buffer. The
jitterbuffer should always be enabled unless you expect all your
-connections to be over a LAN. The drop count is the maximum number of
-voice packets to allow to drop (out of 100). Useful values are 3-10. The
-maxjitterbuffer is the maximum amount of jitter buffer to permit to be
-used. The "maxexcessbuffer" is the maximum amount of excess jitter buffer
-that is permitted before the jitter buffer is slowly shrunk to eliminate
-latency.
+connections to be over a LAN.
+* drop count is the maximum number of voice packets to allow to drop
+ (out of 100). Useful values are 3-10.
+* maxjitterbuffer is the maximum amount of jitter buffer to permit to be
+ used.
+* maxexcessbuffer is the maximum amount of excess jitter buffer
+ that is permitted before the jitter buffer is slowly shrunk to eliminate
+ latency.
+* minexcessbuffer is the minimum amout of excess jitter buffer
> accountcode = <code>
> amaflags = [default|omit|billing|documentation]
@@ -208,13 +213,20 @@ The name is a required field, and is the remote peer name that we wish to
identify ourselves as. A secret may be provided as well. The secret is
generally a shared password between the local server and the remote
server. However, if the secret is in square brackets ([]'s) then it is
-interpreted as the name of a key to use. In that case, the local Asterisk
+interpreted as the name of a RSA key to use. In that case, the local Asterisk
server must have the *private* key (/var/lib/asterisk/keys/<name>.key) and
the remote server will have to have the corresponding public key.
The "host" is a required field and is the hostname or IP address of the
remote Asterisk server. The port specification is optional and is by
-default 5036 if not specified.
+default 4569 for iax2 if not specified.
+
+> notransfer = yes | no
+
+If an IAX phone calls another IAX phone by using a Asterisk server,
+Asterisk will transfer the call to go peer to peer. If you do not
+want this, turn on notransfer with a "yes". This is also settable
+for peers and users.
-------------
@@ -232,7 +244,7 @@ should be an alphanumeric string.
> type = [user|peer|friend]
This line tells Asterisk how to interpret this entity. Users are things
-that connect to us, while peers are people we connect to, and a friend is
+that connect to us, while peers are phones we connect to, and a friend is
shorthand for creating a user and a peer with identical information
----------------
@@ -262,8 +274,8 @@ the final result being the decision. For example:
would deny anyone in 192.168.0.0 with a netmask of 24 bits (class C),
whereas:
-> deny = 192.168.0.0/255.255.255.0
-> permit = 0.0.0.0/0.0.0.0
+> deny = 192.168.0.0/24
+> permit = 0.0.0.0/0
would not deny anyone since the final rule would permit anyone, thus
overriding the denial.
@@ -281,8 +293,8 @@ perspective of your server.
You may select which authentication methods are permitted to be used by
the user to authenticate to us. Multiple methods may be specified,
-separated by commas. If md5 or plaintext authentication is selected, a
-secret must be provided. If RSA authentication is specified, then one or
+separated by commas. If md5 or plaintext authentication is selected, a
+secret must be provided. If RSA authentication is specified, then one or
more key names must be specified with "inkeys"
If no secret is specified and no authentication method is specified, then
@@ -328,3 +340,30 @@ or has timed out.
Specifies the context name to be passed to the peer for it to use when routing
the call through its dial plan. This entry will be used only if a context
is not included in the IAX2 channel name passed to the Dial command.
+
+> qualify = [yes | no | <value>]
+
+Qualify turns on checking of availability of the remote peer. If the
+peer becomes unavailable, no calls are placed to the peer until
+it is reachable again. This is also helpful in certain NAT situations.
+
+> jitterbuffer = [yes | no]
+
+Turns on or off the jitterbuffer for this peer
+
+> mailbox = <mailbox>[@mailboxcontext]
+
+Specifies a mailbox to check for voicemail notification.
+
+> permit = <ipaddr>/<netmask>
+> deny = <ipaddr>/<netmask>
+
+Permit and deny rules may be applied to users, allowing them to connect
+from certain IP addresses and not others. The permit and deny rules are
+interpreted in sequence and all are evaluated on a given IP address, with
+the final result being the decision. See the user section above
+for examples.
+
+----------------------------------------------------------------------
+For more examples of a configuration, please see the iax.conf.sample in
+your the /configs directory of you source code distribution
diff --git a/doc/README.variables b/doc/README.variables
index dfb6de3d1..d145a2176 100755
--- a/doc/README.variables
+++ b/doc/README.variables
@@ -75,12 +75,15 @@ ${TIMESTAMP} Current date time in the format: YYYYMMDD-HHMMSS
${TXTCIDNAME} Result of application TXTCIDName
${UNIQUEID} Current call unique identifier
+NOTE: Attempting to set any of these "special" variables will not change
+ their value, but will not display any warning either.
+
The dial() application sets the following variables:
${DIALEDPEERNAME} Dialed peer name
${DIALEDPEERNUMBER} Dialed peer number
-${DIALEDTIME} Time for the call (seconds)
-${ANSWEREDTIME} Time from dial to answer (seconds)
+${DIALEDTIME} Total time for the call in seconds (Network time).
+${ANSWEREDTIME} Time from answer to end of call in seconds (Billable time).
${DIALSTATUS} Status of the call, one of:
CHANUNAVAIL | CONGESTION | BUSY | NOANSWER | ANSWER | CANCEL
diff --git a/doc/cdr.txt b/doc/cdr.txt
index 580619737..dac7df30a 100755
--- a/doc/cdr.txt
+++ b/doc/cdr.txt
@@ -88,7 +88,7 @@ MSSQL: Asterisk can currently store CDRs into an MSSQL database in
[lastdata] [varchar] (80) NOT NULL ,
[duration] [int] NOT NULL ,
[billsec] [int] NOT NULL ,
- [disposition] [varchar] (45) NOT NULL ,
+ [disposition] [int] NOT NULL ,
[amaflags] [int] NOT NULL ,
[accountcode] [varchar] (20) NOT NULL ,
[uniqueid] [varchar] (32) NOT NULL ,