Version 0.1.9 from FTP
[asterisk/asterisk.git] / 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   If you have any questions, whatsoever, regarding our licensing policy,
36 please contact us.
37   
38 * REQUIRED COMPONENTS
39
40 == Linux ==
41   Currently, the Asterisk Open Source PBX is only known to run on the
42 Linux OS, although it may be portable to other UNIX-like operating systems
43 as well.
44
45
46 * GETTING STARTED
47
48 First, be sure you've got supported hardware.  To use Asterisk right now,
49 you will need one of the following:
50
51         * Adtran Atlas 800 Plus
52         * QuickNet Internet PhoneJack
53         * Full Duplex Sound Card supported by Linux
54         * ISDN4Linux compatible ISDN card
55         * Tormenta Dual T1 card (www.bsdtelephony.com.mx)
56
57 Assuming you have one of these (most likely the third) you're ready to 
58 proceed:
59
60 1) Run "make"
61 2) Run "make install"
62
63 If this is your first time working with Asterisk, you may wish to install
64 the sample PBX, with demonstration extensions, etc.  If so, run:
65
66         "make samples"
67
68 Doing so will overwrite any existing config files you have.
69
70 Finally, you can launch Asterisk with:
71
72         ./asterisk -vvvc
73
74 You'll see a bunch of verbose messages fly by your screen as Asterisk
75 initializes (that's the "very very verbose" mode).  When it's ready, if
76 you specified the "c" then you'll get a command line console, that looks
77 like this:
78
79 *CLI>
80
81 You can type "help" at any time to get help with the system.  For help
82 with a specific command, type "help <command>".  To start the PBX using
83 your sound card, you can type "dial" to dial the PBX.  Then you can use
84 "answer", "hangup", and "dial" to simulate the actions of a telephone.
85 Remember that if you don't have a full duplex sound card (And asterisk
86 will tell you somewhere in its verbose messages if you do/don't) than it
87 won't work right (not yet).
88
89 Feel free to look over the configuration files in /etc/asterisk, where
90 you'll find a lot of information about what you can do with Asterisk.
91
92 * ABOUT CONFIGURATION FILES
93
94 All Asterisk configuration files share a common format.  Comments are
95 delimited by ';' (since '#' of course, being a DTMF digit, may occur in
96 many places).  A configuration file is divided into sections whose names
97 appear in []'s.  Each section typically contains two types of statements,
98 those of the form 'variable = value', and those of the form 'object =>
99 parameters'.  Internally the use of '=' and '=>' is exactly the same, so 
100 they're used only to help make the configuration file easier to
101 understand, and do not affect how it is actually parsed.
102
103 Entries of the form 'variable=value' set the value of some parameter in
104 asterisk.  For example, in tormenta.conf, one might specify:
105
106         switchtype=national
107
108 In order to indicate to Asterisk that the switch they are connecting to is
109 of the type "national".  In general, the parameter will apply to
110 instantiations which occur below its specification.  For example, if the
111 configuration file read:
112
113         switchtype = national
114         channel => 1-4
115         channel => 10-12
116         switchtype = dms100
117         channel => 25-47
118
119 Then, the "national" switchtype would be applied to channels one through
120 four and channels 10 through 12, whereas the "dms100" switchtype would
121 apply to channels 25 through 47.
122   
123 The "object => parameters" instantiates an object with the given
124 parameters.  For example, the line "channel => 25-47" creates objects for
125 the channels 25 through 47 of the tormenta card, obtaining the settings
126 from the variables specified above.
127
128 * MORE INFORMATION
129
130 Finally, you may wish to visit the web site and join the mailing list if
131 you're interested in getting more information.
132
133 Mark