README

   1 The Asterisk Open Source PBX
   2 by Mark Spencer <markster@digium.com>
   3 and the Asterisk.org developer community
   4
   5 Copyright (C) 2001-2005 Digium, Inc.
   6 and other copyright holders.
   7 ================================================================
   8
   9 * SECURITY
  10   It is imperative that you read and fully understand the contents of
  11 the SECURITY file before you attempt to configure and run an Asterisk
  12 server.
  13
  14 * WHAT IS ASTERISK ?
  15   Asterisk is an Open Source PBX and telephony toolkit.  It is, in a
  16 sense, middleware between Internet and telephony channels on the bottom,
  17 and Internet and telephony applications at the top.  For more information
  18 on the project itself, please visit the Asterisk home page at:
  19
  20            http://www.asterisk.org
  21
  22 In addition you'll find lots of information compiled by the Asterisk
  23 community on this Wiki:
  24
  25            http://www.voip-info.org/wiki-Asterisk
  26
  27 There is a book on Asterisk published by O'Reilly under the
  28 Creative Commons License. It is available in book stores as well
  29 as in a downloadable version on the http://www.asteriskdocs.org
  30 web site.
  31
  32 * SUPPORTED OPERATING SYSTEMS
  33
  34 == Linux ==
  35   The Asterisk Open Source PBX is developed and tested primarily on the
  36 GNU/Linux operating system, and is supported on every major GNU/Linux
  37 distribution.
  38
  39 == Others ==
  40   Asterisk has also been 'ported' and reportedly runs properly on other
  41 operating systems as well, including Sun Solaris, Apple's Mac OS X, and
  42 the BSD variants.
  43
  44 * GETTING STARTED
  45
  46   First, be sure you've got supported hardware (but note that you don't need
  47 ANY special hardware, not even a soundcard) to install and run Asterisk.
  48
  49   Supported telephony hardware includes:
  50
  51         * All Wildcard (tm) products from Digium (www.digium.com)
  52         * QuickNet Internet PhoneJack and LineJack (http://www.quicknet.net)
  53         * any full duplex sound card supported by ALSA or OSS
  54         * any ISDN card supported by mISDN on Linux (BRI)
  55         * The Xorcom AstriBank channel bank
  56         * VoiceTronix OpenLine products
  57
  58 The are several drivers for ISDN BRI cards available from third party sources.
  59 Check the voip-info.org wiki for more information on chan_capi and
  60 zaphfc.
  61
  62 * UPGRADING FROM AN EARLIER VERSION
  63
  64   If you are updating from a previous version of Asterisk, make sure you
  65 read the UPGRADE.txt file in the source directory. There are some files
  66 and configuration options that you will have to change, even though we
  67 made every effort possible to maintain backwards compatibility.
  68
  69   In order to discover new features to use, please check the configuration
  70 examples in the /configs directory of the source code distribution.
  71 To discover the major new features of Asterisk 1.2, please visit
  72 http://edvina.net/asterisk1-2/
  73
  74 * NEW INSTALLATIONS
  75
  76   Ensure that your system contains a compatible compiler and development
  77 libraries.  Asterisk requires either the GNU Compiler Collection (GCC) version
  78 3.0 or higher, or a compiler that supports the C99 specification and some of
  79 the gcc language extensions.  In addition, your system needs to have the C
  80 library headers available, and the headers and libraries for OpenSSL,
  81 ncurses and zlib.
  82 On many distributions, these files are installed by packages with names like
  83 'glibc-devel', 'ncurses-devel', 'openssl-devel' and 'zlib-devel' or similar.
  84
  85   So let's proceed:
  86
  87 1) Run "make"
  88
  89   Assuming the build completes successfully:
  90
  91 2) Run "make install"
  92
  93   Each time you update or checkout from the repository, you are strongly
  94 encouraged to ensure all previous object files are removed to avoid internal
  95 inconsistency in Asterisk. Normally, this is automatically done with
  96 the presence of the file .cleancount, which increments each time a 'make clean'
  97 is required, and the file .lastclean, which contains the last .cleancount used.
  98
  99   If this is your first time working with Asterisk, you may wish to install
 100 the sample PBX, with demonstration extensions, etc.  If so, run:
 101
 102 3) "make samples"
 103
 104   Doing so will overwrite any existing config files you have.
 105
 106   Finally, you can launch Asterisk in the foreground mode (not a daemon)
 107 with:
 108
 109 # asterisk -vvvc
 110
 111   You'll see a bunch of verbose messages fly by your screen as Asterisk
 112 initializes (that's the "very very verbose" mode).  When it's ready, if
 113 you specified the "c" then you'll get a command line console, that looks
 114 like this:
 115
 116 *CLI>
 117
 118   You can type "help" at any time to get help with the system.  For help
 119 with a specific command, type "help <command>".  To start the PBX using
 120 your sound card, you can type "dial" to dial the PBX.  Then you can use
 121 "answer", "hangup", and "dial" to simulate the actions of a telephone.
 122 Remember that if you don't have a full duplex sound card (and Asterisk
 123 will tell you somewhere in its verbose messages if you do/don't) then it
 124 won't work right (not yet).
 125
 126   "man asterisk" at the Unix/Linux command prompt will give you detailed
 127 information on how to start and stop Asterisk, as well as all the command
 128 line options for starting Asterisk.
 129
 130   Feel free to look over the configuration files in /etc/asterisk, where
 131 you'll find a lot of information about what you can do with Asterisk.
 132
 133 * ABOUT CONFIGURATION FILES
 134
 135   All Asterisk configuration files share a common format.  Comments are
 136 delimited by ';' (since '#' of course, being a DTMF digit, may occur in
 137 many places).  A configuration file is divided into sections whose names
 138 appear in []'s.  Each section typically contains two types of statements,
 139 those of the form 'variable = value', and those of the form 'object =>
 140 parameters'.  Internally the use of '=' and '=>' is exactly the same, so
 141 they're used only to help make the configuration file easier to
 142 understand, and do not affect how it is actually parsed.
 143
 144   Entries of the form 'variable=value' set the value of some parameter in
 145 asterisk.  For example, in zapata.conf, one might specify:
 146
 147         switchtype=national
 148
 149 in order to indicate to Asterisk that the switch they are connecting to is
 150 of the type "national".  In general, the parameter will apply to
 151 instantiations which occur below its specification.  For example, if the
 152 configuration file read:
 153
 154         switchtype = national
 155         channel => 1-4
 156         channel => 10-12
 157         switchtype = dms100
 158         channel => 25-47
 159
 160 the "national" switchtype would be applied to channels one through
 161 four and channels 10 through 12, whereas the "dms100" switchtype would
 162 apply to channels 25 through 47.
 163
 164   The "object => parameters" instantiates an object with the given
 165 parameters.  For example, the line "channel => 25-47" creates objects for
 166 the channels 25 through 47 of the card, obtaining the settings
 167 from the variables specified above.
 168
 169 * SPECIAL NOTE ON TIME
 170
 171   Those using SIP phones should be aware that Asterisk is sensitive to
 172 large jumps in time.  Manually changing the system time using date(1)
 173 (or other similar commands) may cause SIP registrations and other
 174 internal processes to fail.  If your system cannot keep accurate time
 175 by itself use NTP (http://www.ntp.org/) to keep the system clock
 176 synchronized to "real time".  NTP is designed to keep the system clock
 177 synchronized by speeding up or slowing down the system clock until it
 178 is synchronized to "real time" rather than by jumping the time and
 179 causing discontinuities. Most Linux distributions include precompiled
 180 versions of NTP.  Beware of some time synchronization methods that get
 181 the correct real time periodically and then manually set the system
 182 clock.
 183
 184   Apparent time changes due to daylight savings time are just that,
 185 apparent.  The use of daylight savings time in a Linux system is
 186 purely a user interface issue and does not affect the operation of the
 187 Linux kernel or Asterisk.  The system clock on Linux kernels operates
 188 on UTC.  UTC does not use daylight savings time.
 189
 190   Also note that this issue is separate from the clocking of TDM
 191 channels, and is known to at least affect SIP registrations.
 192
 193 * FILE DESCRIPTORS
 194
 195   Depending on the size of your system and your configuration,
 196 Asterisk can consume a large number of file descriptors.  In UNIX,
 197 file descriptors are used for more than just files on disk.  File
 198 descriptors are also used for handling network communication
 199 (e.g. SIP, IAX2, or H.323 calls) and hardware access (e.g. analog and
 200 digital trunk hardware).  Asterisk accesses many on-disk files for
 201 everything from configuration information to voicemail storage.
 202
 203   Most systems limit the number of file descriptors that Asterisk can
 204 have open at one time.  This can limit the number of simultaneous
 205 calls that your system can handle.  For example, if the limit is set
 206 at 1024 (a common default value) Asterisk can handle approxiately 150
 207 SIP calls simultaneously.  To change the number of file descriptors
 208 follow the instructions for your system below:
 209
 210 == PAM-based Linux System ==
 211
 212   If your system uses PAM (Pluggable Authentication Modules) edit
 213 /etc/security/limits.conf.  Add these lines to the bottom of the file:
 214
 215 root            soft    nofile          4096
 216 root            hard    nofile          8196
 217 asterisk        soft    nofile          4096
 218 asterisk        hard    nofile          8196
 219
 220 (adjust the numbers to taste).  You may need to reboot the system for
 221 these changes to take effect.
 222
 223 == Generic UNIX System ==
 224
 225   If there are no instructions specifically adapted to your system
 226 above you can try adding the command "ulimit -n 8192" to the script
 227 that starts Asterisk.
 228
 229 * MORE INFORMATION
 230
 231   See the doc directory for more documentation on various features. Again,
 232 please read all the configuration samples that include documentation on
 233 the configuration options.
 234
 235   Finally, you may wish to visit the web site and join the mailing list if
 236 you're interested in getting more information.
 237
 238    http://www.asterisk.org/support
 239
 240   Welcome to the growing worldwide community of Asterisk users!
 241
 242 Mark Spencer