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