Merge "CLI: Create ast_cli_completion_add function."
[asterisk/asterisk.git] / README.md
1 # The Asterisk(R) Open Source PBX
2 ```text
3         By Mark Spencer <markster@digium.com> and the Asterisk.org developer community.
4         Copyright (C) 2001-2016 Digium, Inc. and other copyright holders.
5 ```
6 ## SECURITY
7
8   It is imperative that you read and fully understand the contents of
9 the security information document before you attempt to configure and run
10 an Asterisk server.
11
12   If you downloaded Asterisk as a tarball, see the security section in the PDF
13 version of the documentation in doc/tex/asterisk.pdf.  Alternatively, pull up
14 the HTML version of the documentation in doc/tex/asterisk/index.html.  The
15 source for the security document is available in doc/tex/security.tex.
16
17 ## WHAT IS ASTERISK ?
18
19   Asterisk is an Open Source PBX and telephony toolkit.  It is, in a
20 sense, middleware between Internet and telephony channels on the bottom,
21 and Internet and telephony applications at the top.  However, Asterisk supports
22 more telephony interfaces than just Internet telephony.  Asterisk also has a
23 vast amount of support for traditional PSTN telephony, as well.
24
25   For more information on the project itself, please visit the Asterisk
26 [home page] and the official [wiki].  In addition you'll find lots
27 of information compiled by the Asterisk community at [voip-info.org].
28
29   There is a book on Asterisk published by O'Reilly under the Creative Commons
30 License. It is available in book stores as well as in a downloadable version on
31 the [asteriskdocs.org] web site.
32
33 ## SUPPORTED OPERATING SYSTEMS
34
35 ### Linux
36
37   The Asterisk Open Source PBX is developed and tested primarily on the
38 GNU/Linux operating system, and is supported on every major GNU/Linux
39 distribution.
40
41 ### Others
42
43   Asterisk has also been 'ported' and reportedly runs properly on other
44 operating systems as well, including Sun Solaris, Apple's Mac OS X, Cygwin,
45 and the BSD variants.
46
47 ## GETTING STARTED
48
49   First, be sure you've got supported hardware (but note that you don't need
50 ANY special hardware, not even a sound card) to install and run Asterisk.
51
52 Supported telephony hardware includes:
53 * All Analog and Digital Interface cards from [Digium]
54 * QuickNet Internet PhoneJack and LineJack (http://www.quicknet.net)
55 * any full duplex sound card supported by ALSA, OSS, or PortAudio
56 * any ISDN card supported by mISDN on Linux
57 * The Xorcom Astribank channel bank
58 * VoiceTronix OpenLine products
59
60 ### UPGRADING FROM AN EARLIER VERSION
61
62   If you are updating from a previous version of Asterisk, make sure you
63 read the [UPGRADE.txt] file in the source directory. There are some files
64 and configuration options that you will have to change, even though we
65 made every effort possible to maintain backwards compatibility.
66
67   In order to discover new features to use, please check the configuration
68 examples in the [configs] directory of the source code distribution.  For a
69 list of new features in this version of Asterisk, see the [CHANGES] file.
70
71 ### NEW INSTALLATIONS
72
73   Ensure that your system contains a compatible compiler and development
74 libraries.  Asterisk requires either the GNU Compiler Collection (GCC) version
75 3.0 or higher, or a compiler that supports the C99 specification and some of
76 the gcc language extensions.  In addition, your system needs to have the C
77 library headers available, and the headers and libraries for ncurses.
78
79   There are many modules that have additional dependencies.  To see what
80 libraries are being looked for, see `./configure --help`, or run
81 `make menuselect` to view the dependencies for specific modules.
82
83   On many distributions, these dependencies are installed by packages with names
84 like 'glibc-devel', 'ncurses-devel', 'openssl-devel' and 'zlib-devel'
85 or similar.
86
87 So, let's proceed:
88 1. Read this file.
89
90   There are more documents than this one in the [doc] directory.  You may also
91 want to check the configuration files that contain examples and reference
92 guides in the [configs] directory.
93
94 2. Run `./configure`
95
96   Execute the configure script to guess values for system-dependent
97 variables used during compilation.
98
99 3. Run `make menuselect` _\[optional]_
100
101   This is needed if you want to select the modules that will be compiled and to
102 check dependencies for various optional modules.
103
104 4. Run `make`
105
106 Assuming the build completes successfully:
107
108 5. Run `make install`
109
110   If this is your first time working with Asterisk, you may wish to install
111 the sample PBX, with demonstration extensions, etc.  If so, run:
112
113 6. Run `make samples`
114
115   Doing so will overwrite any existing configuration files you have installed.
116
117 7. Finally, you can launch Asterisk in the foreground mode (not a daemon) with:
118 ```
119         # asterisk -vvvc
120 ```
121   You'll see a bunch of verbose messages fly by your screen as Asterisk
122 initializes (that's the "very very verbose" mode).  When it's ready, if
123 you specified the "c" then you'll get a command line console, that looks
124 like this:
125 ```
126         *CLI>
127 ```
128   You can type "core show help" at any time to get help with the system.  For help
129 with a specific command, type "core show help <command>".  To start the PBX using
130 your sound card, you can type "console dial" to dial the PBX.  Then you can use
131 "console answer", "console hangup", and "console dial" to simulate the actions
132 of a telephone.  Remember that if you don't have a full duplex sound card
133 (and Asterisk will tell you somewhere in its verbose messages if you do/don't)
134 then it won't work right (not yet).
135
136   "man asterisk" at the Unix/Linux command prompt will give you detailed
137 information on how to start and stop Asterisk, as well as all the command
138 line options for starting Asterisk.
139
140   Feel free to look over the configuration files in `/etc/asterisk`, where you
141 will find a lot of information about what you can do with Asterisk.
142
143 ### ABOUT CONFIGURATION FILES
144
145   All Asterisk configuration files share a common format.  Comments are
146 delimited by ';' (since '#' of course, being a DTMF digit, may occur in
147 many places).  A configuration file is divided into sections whose names
148 appear in []'s.  Each section typically contains two types of statements,
149 those of the form 'variable = value', and those of the form 'object =>
150 parameters'.  Internally the use of '=' and '=>' is exactly the same, so
151 they're used only to help make the configuration file easier to
152 understand, and do not affect how it is actually parsed.
153
154   Entries of the form 'variable=value' set the value of some parameter in
155 asterisk.  For example, in [chan_dahdi.conf], one might specify:
156 ```
157         switchtype=national
158 ```
159   In order to indicate to Asterisk that the switch they are connecting to is
160 of the type "national".  In general, the parameter will apply to
161 instantiations which occur below its specification.  For example, if the
162 configuration file read:
163 ```
164         switchtype = national
165         channel => 1-4
166         channel => 10-12
167         switchtype = dms100
168         channel => 25-47
169 ```
170
171   The "national" switchtype would be applied to channels one through
172 four and channels 10 through 12, whereas the "dms100" switchtype would
173 apply to channels 25 through 47.
174
175   The "object => parameters" instantiates an object with the given
176 parameters.  For example, the line "channel => 25-47" creates objects for
177 the channels 25 through 47 of the card, obtaining the settings
178 from the variables specified above.
179
180 ### SPECIAL NOTE ON TIME
181
182   Those using SIP phones should be aware that Asterisk is sensitive to
183 large jumps in time.  Manually changing the system time using date(1)
184 (or other similar commands) may cause SIP registrations and other
185 internal processes to fail.  If your system cannot keep accurate time
186 by itself use [NTP] to keep the system clock
187 synchronized to "real time".  NTP is designed to keep the system clock
188 synchronized by speeding up or slowing down the system clock until it
189 is synchronized to "real time" rather than by jumping the time and
190 causing discontinuities. Most Linux distributions include precompiled
191 versions of NTP.  Beware of some time synchronization methods that get
192 the correct real time periodically and then manually set the system
193 clock.
194
195   Apparent time changes due to daylight savings time are just that,
196 apparent.  The use of daylight savings time in a Linux system is
197 purely a user interface issue and does not affect the operation of the
198 Linux kernel or Asterisk.  The system clock on Linux kernels operates
199 on UTC.  UTC does not use daylight savings time.
200
201   Also note that this issue is separate from the clocking of TDM
202 channels, and is known to at least affect SIP registrations.
203
204 ### FILE DESCRIPTORS
205
206   Depending on the size of your system and your configuration,
207 Asterisk can consume a large number of file descriptors.  In UNIX,
208 file descriptors are used for more than just files on disk.  File
209 descriptors are also used for handling network communication
210 (e.g. SIP, IAX2, or H.323 calls) and hardware access (e.g. analog and
211 digital trunk hardware).  Asterisk accesses many on-disk files for
212 everything from configuration information to voicemail storage.
213
214   Most systems limit the number of file descriptors that Asterisk can
215 have open at one time.  This can limit the number of simultaneous
216 calls that your system can handle.  For example, if the limit is set
217 at 1024 (a common default value) Asterisk can handle approximately 150
218 SIP calls simultaneously.  To change the number of file descriptors
219 follow the instructions for your system below:
220
221 #### PAM-BASED LINUX SYSTEM
222
223   If your system uses PAM (Pluggable Authentication Modules) edit
224 `/etc/security/limits.conf`.  Add these lines to the bottom of the file:
225 ```text
226 root            soft    nofile          4096
227 root            hard    nofile          8196
228 asterisk        soft    nofile          4096
229 asterisk        hard    nofile          8196
230 ```
231
232 (adjust the numbers to taste).  You may need to reboot the system for
233 these changes to take effect.
234
235 #### GENERIC UNIX SYSTEM
236
237   If there are no instructions specifically adapted to your system
238 above you can try adding the command `ulimit -n 8192` to the script
239 that starts Asterisk.
240
241 ## MORE INFORMATION
242
243   See the [doc] directory for more documentation on various features.
244 Again, please read all the configuration samples that include documentation
245 on the configuration options.
246
247   Finally, you may wish to visit the [support] site and join the [mailing
248 list] if you're interested in getting more information.
249
250 Welcome to the growing worldwide community of Asterisk users!
251 ```
252         Mark Spencer, and the Asterisk.org development community
253 ```
254
255 ---
256
257 Asterisk is a trademark of Digium, Inc.
258
259 [home page]: https://www.asterisk.org
260 [support]: https://www.asterisk.org/support
261 [wiki]: https://wiki.asterisk.org/
262 [mailing list]: http://lists.digium.com/mailman/listinfo/asterisk-users
263 [chan_dahdi.conf]: configs/samples/chan_dahdi.conf.sample
264 [voip-info.org]: http://www.voip-info.org/wiki-Asterisk
265 [asteriskdocs.org]: http://www.asteriskdocs.org
266 [NTP]: http://www.ntp.org/
267 [Digium]: https://www.digium.com/
268 [UPGRADE.txt]: UPGRADE.txt
269 [CHANGES]: CHANGES
270 [configs]: configs
271 [doc]: doc
272