README

   1 The Asterisk Open Source PBX
   2 by Mark Spencer <markster@linux-support.net>
   3 Copyright (C) 2001, Linux Support Services, Inc.
   4 ================================================================
   5 * SECURITY
   6   It is imperative that you read and fully understand the contents of
   7   the SECURITY file before you attempt to configure an Asterisk server.
   8
   9 * WHAT IS ASTERISK
  10   Asterisk is an Open Source PBX and telephony toolkit.  It is, in a
  11 sense, middleware between Internet and telephony channels on the bottom,
  12 and Internet and telephony applications at the top.  For more information
  13 on the project itself, please visit the Asterisk home page at:
  14
  15            http://www.asteriskpbx.com
  16
  17 * LICENSING
  18   Asterisk is distributed under GNU General Public License.  The GPL also
  19 must apply to all loadable modules as well, except as defined below.
  20
  21   Linux Support Services, Inc. retains copyright to all of the core
  22 Asterisk system, and therefore can grant, at its sole discression, the
  23 ability for companies, individuals, or organizations to create proprietary
  24 or Open Source (but non-GPL'd) modules which may be dynamically linked at
  25 runtime with the portions of Asterisk which fall under our copyright
  26 umbrella, or are distributed under more flexible licenses than GPL.  At
  27 this time (5/21/2001) the only component of Asterisk which is covered
  28 under GPL and not under our Copyright is the Xing MP3 decoder.
  29
  30   If you wish to use our code in other GPL programs, don't worry -- there
  31 is no requirement that you provide the same exemption in your GPL'd
  32 products (although if you've written a module for Asterisk we would
  33 strongly encourage you to make the same excemption that we do).
  34
  35   Specific permission is also granted to OpenSSL and OpenH323 to link to
  36 Asterisk.
  37
  38   If you have any questions, whatsoever, regarding our licensing policy,
  39 please contact us.
  40
  41 * REQUIRED COMPONENTS
  42
  43 == Linux ==
  44   Currently, the Asterisk Open Source PBX is only known to run on the
  45 Linux OS, although it may be portable to other UNIX-like operating systems
  46 as well.
  47
  48
  49 * GETTING STARTED
  50
  51 First, be sure you've got supported hardware.  To use Asterisk right now,
  52 you will need one of the following:
  53
  54         * All Wildcard (tm) products from LSS (www.linux-support.net)
  55         * QuickNet Internet PhoneJack and LineJack (http://www.quicknet.net)
  56         * Full Duplex Sound Card supported by Linux
  57         * Adtran Atlas 800 Plus
  58         * ISDN4Linux compatible ISDN card
  59         * Tormenta Dual T1 card (www.bsdtelephony.com.mx)
  60
  61 Assuming you have one of these (most likely the third) you're ready to
  62 proceed:
  63
  64 1) Run "make"
  65 2) Run "make install"
  66
  67 If this is your first time working with Asterisk, you may wish to install
  68 the sample PBX, with demonstration extensions, etc.  If so, run:
  69
  70         "make samples"
  71
  72 Doing so will overwrite any existing config files you have.
  73
  74 Finally, you can launch Asterisk with:
  75
  76         ./asterisk -vvvc
  77
  78 You'll see a bunch of verbose messages fly by your screen as Asterisk
  79 initializes (that's the "very very verbose" mode).  When it's ready, if
  80 you specified the "c" then you'll get a command line console, that looks
  81 like this:
  82
  83 *CLI>
  84
  85 You can type "help" at any time to get help with the system.  For help
  86 with a specific command, type "help <command>".  To start the PBX using
  87 your sound card, you can type "dial" to dial the PBX.  Then you can use
  88 "answer", "hangup", and "dial" to simulate the actions of a telephone.
  89 Remember that if you don't have a full duplex sound card (And asterisk
  90 will tell you somewhere in its verbose messages if you do/don't) than it
  91 won't work right (not yet).
  92
  93 Feel free to look over the configuration files in /etc/asterisk, where
  94 you'll find a lot of information about what you can do with Asterisk.
  95
  96 * ABOUT CONFIGURATION FILES
  97
  98 All Asterisk configuration files share a common format.  Comments are
  99 delimited by ';' (since '#' of course, being a DTMF digit, may occur in
 100 many places).  A configuration file is divided into sections whose names
 101 appear in []'s.  Each section typically contains two types of statements,
 102 those of the form 'variable = value', and those of the form 'object =>
 103 parameters'.  Internally the use of '=' and '=>' is exactly the same, so
 104 they're used only to help make the configuration file easier to
 105 understand, and do not affect how it is actually parsed.
 106
 107 Entries of the form 'variable=value' set the value of some parameter in
 108 asterisk.  For example, in tormenta.conf, one might specify:
 109
 110         switchtype=national
 111
 112 In order to indicate to Asterisk that the switch they are connecting to is
 113 of the type "national".  In general, the parameter will apply to
 114 instantiations which occur below its specification.  For example, if the
 115 configuration file read:
 116
 117         switchtype = national
 118         channel => 1-4
 119         channel => 10-12
 120         switchtype = dms100
 121         channel => 25-47
 122
 123 Then, the "national" switchtype would be applied to channels one through
 124 four and channels 10 through 12, whereas the "dms100" switchtype would
 125 apply to channels 25 through 47.
 126
 127 The "object => parameters" instantiates an object with the given
 128 parameters.  For example, the line "channel => 25-47" creates objects for
 129 the channels 25 through 47 of the tormenta card, obtaining the settings
 130 from the variables specified above.
 131
 132 * MORE INFORMATION
 133
 134 See the doc directory for more documentation.
 135
 136 Finally, you may wish to visit the web site and join the mailing list if
 137 you're interested in getting more information.
 138
 139 Mark