move GPL/trademark licensing information into LICENSE file
[asterisk/asterisk.git] / README
1 The Asterisk Open Source PBX
2 by Mark Spencer <markster@digium.com>
3 Copyright (C) 2001-2005 Digium, 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.asterisk.org
16
17 In addition you'll find lots of information compiled by the Asterisk
18 community on this Wiki:
19
20            http://www.voip-info.org/wiki-Asterisk
21
22 * OPERATING SYSTEMS
23
24 == Linux ==
25   The Asterisk Open Source PBX is developed and tested primarily on the
26 GNU/Linux operating system, and is supported on every major GNU/Linux
27 distribution.
28
29 == Others ==
30   Asterisk has also been 'ported' and reportedly runs properly on other
31 operating systems as well, including Sun Solaris, Apple's Mac OS X, and
32 the BSD variants.
33
34 * GETTING STARTED
35
36   First, be sure you've got supported hardware (but note that you don't need
37 ANY special hardware, not even a soundcard) to install and run Asterisk.
38
39   Supported telephony hardware includes:
40
41         * All Wildcard (tm) products from Digium (www.digium.com)
42         * QuickNet Internet PhoneJack and LineJack (http://www.quicknet.net)
43         * any full duplex sound card supported by ALSA or OSS
44         * ISDN4Linux compatible ISDN card
45         * VoiceTronix OpenLine products
46
47 Hint: CAPI compatible ISDN cards can be run using the add-on channel chan_capi.
48
49   Second, ensure that your system contains a compatible compiler and development
50 libraries.  Asterisk requires either the GNU Compiler Collection (GCC) version
51 3.0 or higher, or a compiler that supports the C99 specification and some of
52 the gcc language extensions.  In addition, your system needs to have the C
53 library headers available, and the headers and libraries for OpenSSL and zlib.
54 On many distributions, these files are installed by packages with names like
55 'libc-devel', 'openssl-devel' and 'zlib-devel' or similar.
56
57   So let's proceed:
58
59 1) Run "make"
60
61   Assuming the build completes successfully:
62
63 2) Run "make install"
64
65   Each time you update or checkout from CVS, you are strongly encouraged 
66 to ensure all previous object files are removed to avoid internal 
67 inconsistency in Asterisk. Normally, this is automatically done with 
68 the presence of the file .cleancount, which increments each time a 'make clean'
69 is required, and the file .lastclean, which contains the last .cleancount used. 
70
71   If this is your first time working with Asterisk, you may wish to install
72 the sample PBX, with demonstration extensions, etc.  If so, run:
73
74 3) "make samples"
75
76   Doing so will overwrite any existing config files you have. If you are lacking a
77 soundcard you won't be able to use the DIAL command on the console, though.
78
79   Finally, you can launch Asterisk with:
80
81 # asterisk -vvvc
82
83   You'll see a bunch of verbose messages fly by your screen as Asterisk
84 initializes (that's the "very very verbose" mode).  When it's ready, if
85 you specified the "c" then you'll get a command line console, that looks
86 like this:
87
88 *CLI>
89
90   You can type "help" at any time to get help with the system.  For help
91 with a specific command, type "help <command>".  To start the PBX using
92 your sound card, you can type "dial" to dial the PBX.  Then you can use
93 "answer", "hangup", and "dial" to simulate the actions of a telephone.
94 Remember that if you don't have a full duplex sound card (and Asterisk
95 will tell you somewhere in its verbose messages if you do/don't) then it
96 won't work right (not yet).
97
98   Feel free to look over the configuration files in /etc/asterisk, where
99 you'll find a lot of information about what you can do with Asterisk.
100
101 * ABOUT CONFIGURATION FILES
102
103   All Asterisk configuration files share a common format.  Comments are
104 delimited by ';' (since '#' of course, being a DTMF digit, may occur in
105 many places).  A configuration file is divided into sections whose names
106 appear in []'s.  Each section typically contains two types of statements,
107 those of the form 'variable = value', and those of the form 'object =>
108 parameters'.  Internally the use of '=' and '=>' is exactly the same, so 
109 they're used only to help make the configuration file easier to
110 understand, and do not affect how it is actually parsed.
111
112   Entries of the form 'variable=value' set the value of some parameter in
113 asterisk.  For example, in zapata.conf, one might specify:
114
115         switchtype=national
116
117 in order to indicate to Asterisk that the switch they are connecting to is
118 of the type "national".  In general, the parameter will apply to
119 instantiations which occur below its specification.  For example, if the
120 configuration file read:
121
122         switchtype = national
123         channel => 1-4
124         channel => 10-12
125         switchtype = dms100
126         channel => 25-47
127
128 the "national" switchtype would be applied to channels one through
129 four and channels 10 through 12, whereas the "dms100" switchtype would
130 apply to channels 25 through 47.
131   
132   The "object => parameters" instantiates an object with the given
133 parameters.  For example, the line "channel => 25-47" creates objects for
134 the channels 25 through 47 of the card, obtaining the settings
135 from the variables specified above.
136
137 * SPECIAL NOTE ON TIME
138   
139   Those using SIP phones should be aware that Asterisk is sensitive to
140 large jumps in time.  Manually changing the system time using date(1)
141 (or other similar commands) may cause SIP registrations and other
142 internal processes to fail.  If your system cannot keep accurate time
143 by itself use NTP (http://www.ntp.org/) to keep the system clock
144 synchronized to "real time".  NTP is designed to keep the system clock
145 synchronized by speeding up or slowing down the system clock until it
146 is synchronized to "real time" rather than by jumping the time and
147 causing discontinuities. Most Linux distributions include precompiled
148 versions of NTP.  Beware of some time synchronization methods that get
149 the correct real time periodically and then manually set the system
150 clock.
151
152   Apparent time changes due to daylight savings time are just that,
153 apparent.  The use of daylight savings time in a Linux system is
154 purely a user interface issue and does not affect the operation of the
155 Linux kernel or Asterisk.  The system clock on Linux kernels operates
156 on UTC.  UTC does not use daylight savings time.
157
158   Also note that this issue is separate from the clocking of TDM
159 channels, and is known to at least affect SIP registrations.
160
161 * FILE DESCRIPTORS
162
163   Depending on the size of your system and your configuration,
164 Asterisk can consume a large number of file descriptors.  In UNIX,
165 file descriptors are used for more than just files on disk.  File
166 descriptors are also used for handling network communication
167 (e.g. SIP, IAX2, or H.323 calls) and hardware access (e.g. analog and
168 digital trunk hardware).  Asterisk accesses many on-disk files for
169 everything from configuration information to voicemail storage.
170
171   Most systems limit the number of file descriptors that Asterisk can
172 have open at one time.  This can limit the number of simultaneous
173 calls that your system can handle.  For example, if the limit is set
174 at 1024 (a common default value) Asterisk can handle approxiately 150
175 SIP calls simultaneously.  To change the number of file descriptors
176 follow the instructions for your system below:
177
178 == PAM-based Linux System ==
179
180   If your system uses PAM (Pluggable Authentication Modules) edit
181 /etc/security/limits.conf.  Add these lines to the bottom of the file:
182
183 root            soft    nofile          4096
184 root            hard    nofile          8196
185 asterisk        soft    nofile          4096
186 asterisk        hard    nofile          8196
187
188 (adjust the numbers to taste).  You may need to reboot the system for
189 these changes to take effect.
190
191 == Generic UNIX System ==
192
193   If there are no instructions specifically adapted to your system
194 above you can try adding the command "ulimit -n 8192" to the script
195 that starts Asterisk.
196
197 * MORE INFORMATION
198
199   See the doc directory for more documentation.
200
201   Finally, you may wish to visit the web site and join the mailing list if
202 you're interested in getting more information.
203
204    http://www.asterisk.org/index.php?menu=support
205
206   Welcome to the growing worldwide community of Asterisk users!
207
208 Mark Spencer