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