Still working to resolve this...
[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 If this is your first time working with Asterisk, you may wish to install
75 the sample PBX, with demonstration extensions, etc.  If so, run:
76
77         "make samples"
78
79 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.
80
81 Finally, you can launch Asterisk with:
82
83         ./asterisk -vvvc
84
85 You'll see a bunch of verbose messages fly by your screen as Asterisk
86 initializes (that's the "very very verbose" mode).  When it's ready, if
87 you specified the "c" then you'll get a command line console, that looks
88 like this:
89
90 *CLI>
91
92 You can type "help" at any time to get help with the system.  For help
93 with a specific command, type "help <command>".  To start the PBX using
94 your sound card, you can type "dial" to dial the PBX.  Then you can use
95 "answer", "hangup", and "dial" to simulate the actions of a telephone.
96 Remember that if you don't have a full duplex sound card (And asterisk
97 will tell you somewhere in its verbose messages if you do/don't) than it
98 won't work right (not yet).
99
100 Feel free to look over the configuration files in /etc/asterisk, where
101 you'll find a lot of information about what you can do with Asterisk.
102
103 * ABOUT CONFIGURATION FILES
104
105 All Asterisk configuration files share a common format.  Comments are
106 delimited by ';' (since '#' of course, being a DTMF digit, may occur in
107 many places).  A configuration file is divided into sections whose names
108 appear in []'s.  Each section typically contains two types of statements,
109 those of the form 'variable = value', and those of the form 'object =>
110 parameters'.  Internally the use of '=' and '=>' is exactly the same, so 
111 they're used only to help make the configuration file easier to
112 understand, and do not affect how it is actually parsed.
113
114 Entries of the form 'variable=value' set the value of some parameter in
115 asterisk.  For example, in tormenta.conf, one might specify:
116
117         switchtype=national
118
119 In order to indicate to Asterisk that the switch they are connecting to is
120 of the type "national".  In general, the parameter will apply to
121 instantiations which occur below its specification.  For example, if the
122 configuration file read:
123
124         switchtype = national
125         channel => 1-4
126         channel => 10-12
127         switchtype = dms100
128         channel => 25-47
129
130 Then, the "national" switchtype would be applied to channels one through
131 four and channels 10 through 12, whereas the "dms100" switchtype would
132 apply to channels 25 through 47.
133   
134 The "object => parameters" instantiates an object with the given
135 parameters.  For example, the line "channel => 25-47" creates objects for
136 the channels 25 through 47 of the tormenta card, obtaining the settings
137 from the variables specified above.
138
139 * MORE INFORMATION
140
141 See the doc directory for more documentation.
142
143 Finally, you may wish to visit the web site and join the mailing list if
144 you're interested in getting more information.
145
146    http://www.asterisk.org/index.php?menu=support
147
148 Welcome to the growing worldwide community of Asterisk users!
149
150 Mark Spencer
151
152