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