README

   1 The Asterisk(R) Open Source PBX
   2 by Mark Spencer <markster@digium.com>
   3 and the Asterisk.org developer community
   4
   5 Copyright (C) 2001-2006 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 information file (doc/security.txt) before you attempt
  12 to configure and run an Asterisk 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) Read the README files.
  88    There are more README files than this one in the doc/ directory.
  89    Start with doc/00README.1st
  90    You may also want to check the configuration files that contain
  91    examples and reference guides. They are all in the configs/
  92    directory.
  93
  94 2) Run "make"
  95
  96   Assuming the build completes successfully:
  97
  98 3) Run "make install"
  99
 100   Each time you update or checkout from the repository, you are strongly
 101 encouraged to ensure all previous object files are removed to avoid internal
 102 inconsistency in Asterisk. Normally, this is automatically done with
 103 the presence of the file .cleancount, which increments each time a 'make clean'
 104 is required, and the file .lastclean, which contains the last .cleancount used.
 105
 106   If this is your first time working with Asterisk, you may wish to install
 107 the sample PBX, with demonstration extensions, etc.  If so, run:
 108
 109 4) "make samples"
 110
 111   Doing so will overwrite any existing config files you have.
 112
 113   Finally, you can launch Asterisk in the foreground mode (not a daemon)
 114 with:
 115
 116 # asterisk -vvvc
 117
 118   You'll see a bunch of verbose messages fly by your screen as Asterisk
 119 initializes (that's the "very very verbose" mode).  When it's ready, if
 120 you specified the "c" then you'll get a command line console, that looks
 121 like this:
 122
 123 *CLI>
 124
 125   You can type "help" at any time to get help with the system.  For help
 126 with a specific command, type "help <command>".  To start the PBX using
 127 your sound card, you can type "dial" to dial the PBX.  Then you can use
 128 "answer", "hangup", and "dial" to simulate the actions of a telephone.
 129 Remember that if you don't have a full duplex sound card (and Asterisk
 130 will tell you somewhere in its verbose messages if you do/don't) then it
 131 won't work right (not yet).
 132
 133   "man asterisk" at the Unix/Linux command prompt will give you detailed
 134 information on how to start and stop Asterisk, as well as all the command
 135 line options for starting Asterisk.
 136
 137   Feel free to look over the configuration files in /etc/asterisk, where
 138 you'll find a lot of information about what you can do with Asterisk.
 139
 140 * ABOUT CONFIGURATION FILES
 141
 142   All Asterisk configuration files share a common format.  Comments are
 143 delimited by ';' (since '#' of course, being a DTMF digit, may occur in
 144 many places).  A configuration file is divided into sections whose names
 145 appear in []'s.  Each section typically contains two types of statements,
 146 those of the form 'variable = value', and those of the form 'object =>
 147 parameters'.  Internally the use of '=' and '=>' is exactly the same, so
 148 they're used only to help make the configuration file easier to
 149 understand, and do not affect how it is actually parsed.
 150
 151   Entries of the form 'variable=value' set the value of some parameter in
 152 asterisk.  For example, in zapata.conf, one might specify:
 153
 154         switchtype=national
 155
 156 in order to indicate to Asterisk that the switch they are connecting to is
 157 of the type "national".  In general, the parameter will apply to
 158 instantiations which occur below its specification.  For example, if the
 159 configuration file read:
 160
 161         switchtype = national
 162         channel => 1-4
 163         channel => 10-12
 164         switchtype = dms100
 165         channel => 25-47
 166
 167 the "national" switchtype would be applied to channels one through
 168 four and channels 10 through 12, whereas the "dms100" switchtype would
 169 apply to channels 25 through 47.
 170
 171   The "object => parameters" instantiates an object with the given
 172 parameters.  For example, the line "channel => 25-47" creates objects for
 173 the channels 25 through 47 of the card, obtaining the settings
 174 from the variables specified above.
 175
 176 * SPECIAL NOTE ON TIME
 177
 178   Those using SIP phones should be aware that Asterisk is sensitive to
 179 large jumps in time.  Manually changing the system time using date(1)
 180 (or other similar commands) may cause SIP registrations and other
 181 internal processes to fail.  If your system cannot keep accurate time
 182 by itself use NTP (http://www.ntp.org/) to keep the system clock
 183 synchronized to "real time".  NTP is designed to keep the system clock
 184 synchronized by speeding up or slowing down the system clock until it
 185 is synchronized to "real time" rather than by jumping the time and
 186 causing discontinuities. Most Linux distributions include precompiled
 187 versions of NTP.  Beware of some time synchronization methods that get
 188 the correct real time periodically and then manually set the system
 189 clock.
 190
 191   Apparent time changes due to daylight savings time are just that,
 192 apparent.  The use of daylight savings time in a Linux system is
 193 purely a user interface issue and does not affect the operation of the
 194 Linux kernel or Asterisk.  The system clock on Linux kernels operates
 195 on UTC.  UTC does not use daylight savings time.
 196
 197   Also note that this issue is separate from the clocking of TDM
 198 channels, and is known to at least affect SIP registrations.
 199
 200 * FILE DESCRIPTORS
 201
 202   Depending on the size of your system and your configuration,
 203 Asterisk can consume a large number of file descriptors.  In UNIX,
 204 file descriptors are used for more than just files on disk.  File
 205 descriptors are also used for handling network communication
 206 (e.g. SIP, IAX2, or H.323 calls) and hardware access (e.g. analog and
 207 digital trunk hardware).  Asterisk accesses many on-disk files for
 208 everything from configuration information to voicemail storage.
 209
 210   Most systems limit the number of file descriptors that Asterisk can
 211 have open at one time.  This can limit the number of simultaneous
 212 calls that your system can handle.  For example, if the limit is set
 213 at 1024 (a common default value) Asterisk can handle approxiately 150
 214 SIP calls simultaneously.  To change the number of file descriptors
 215 follow the instructions for your system below:
 216
 217 == PAM-based Linux System ==
 218
 219   If your system uses PAM (Pluggable Authentication Modules) edit
 220 /etc/security/limits.conf.  Add these lines to the bottom of the file:
 221
 222 root            soft    nofile          4096
 223 root            hard    nofile          8196
 224 asterisk        soft    nofile          4096
 225 asterisk        hard    nofile          8196
 226
 227 (adjust the numbers to taste).  You may need to reboot the system for
 228 these changes to take effect.
 229
 230 == Generic UNIX System ==
 231
 232   If there are no instructions specifically adapted to your system
 233 above you can try adding the command "ulimit -n 8192" to the script
 234 that starts Asterisk.
 235
 236 * MORE INFORMATION
 237
 238   See the doc directory for more documentation on various features. Again,
 239 please read all the configuration samples that include documentation on
 240 the configuration options.
 241
 242   Finally, you may wish to visit the web site and join the mailing list if
 243 you're interested in getting more information.
 244
 245    http://www.asterisk.org/support
 246
 247   Welcome to the growing worldwide community of Asterisk users!
 248
 249 Mark Spencer
 250
 251 ----
 252 Asterisk is a trademark belonging to Digium, inc