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