path: root/README
diff options
authormarkster <markster@f38db490-d61c-443f-a65b-d21fe96a405b>2005-10-18 19:21:16 +0000
committermarkster <markster@f38db490-d61c-443f-a65b-d21fe96a405b>2005-10-18 19:21:16 +0000
commit411e4b1362196d9a4d4ea8abba20752ee8659568 (patch)
treefe83fc66e7c0105c0bf6b2294fdb38566625f8a6 /README
parentadd0106fc48313fe3a9d95d96d48a9376d558647 (diff)
Update README documentation (bug #5463, with mods)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@6822 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'README')
1 files changed, 45 insertions, 13 deletions
diff --git a/README b/README
index e52ca4d2e..99aeec3e1 100755
--- a/README
+++ b/README
@@ -1,12 +1,17 @@
The Asterisk Open Source PBX
by Mark Spencer <markster@digium.com>
+and the Asterisk.org developer community
Copyright (C) 2001-2005 Digium, Inc.
+and other copyright holders.
It is imperative that you read and fully understand the contents of
- the SECURITY file before you attempt to configure an Asterisk server.
+the SECURITY file before you attempt to configure and run an Asterisk
Asterisk is an Open Source PBX and telephony toolkit. It is, in a
sense, middleware between Internet and telephony channels on the bottom,
and Internet and telephony applications at the top. For more information
@@ -19,7 +24,12 @@ community on this Wiki:
+There is a book on Asterisk published by O'Reilly under the
+Creative Commons License. It is available in book stores as well
+as in a downloadable version on the http://www.asteriskdocs.org
+web site.
== Linux ==
The Asterisk Open Source PBX is developed and tested primarily on the
@@ -41,18 +51,34 @@ ANY special hardware, not even a soundcard) to install and run Asterisk.
* All Wildcard (tm) products from Digium (www.digium.com)
* QuickNet Internet PhoneJack and LineJack (http://www.quicknet.net)
* any full duplex sound card supported by ALSA or OSS
- * ISDN4Linux compatible ISDN card
* VoiceTronix OpenLine products
-Hint: CAPI compatible ISDN cards can be run using the add-on channel chan_capi.
+The are several drivers for ISDN BRI cards available from third party sources.
+Check the voip-info.org wiki for more information on chan_capi, chan_misdn and
- Second, ensure that your system contains a compatible compiler and development
+ If you are updating from a previous version of Asterisk, make sure you
+read the UPGRADE.txt file in the source directory. There are some files
+and configuration options that you will have to change, even though we
+made every effort possible to maintain backwards compatibility.
+ In order to discover new features to use, please check the configuration
+examples in the /configs directory of the source code distribution.
+To discover the major new features of Asterisk 1.2, please visit
+ Ensure that your system contains a compatible compiler and development
libraries. Asterisk requires either the GNU Compiler Collection (GCC) version
3.0 or higher, or a compiler that supports the C99 specification and some of
the gcc language extensions. In addition, your system needs to have the C
-library headers available, and the headers and libraries for OpenSSL and zlib.
+library headers available, and the headers and libraries for OpenSSL,
+ncurses and zlib.
On many distributions, these files are installed by packages with names like
-'libc-devel', 'openssl-devel' and 'zlib-devel' or similar.
+'glibc-devel', 'ncurses-devel', 'openssl-devel' and 'zlib-devel' or similar.
So let's proceed:
@@ -73,10 +99,10 @@ the sample PBX, with demonstration extensions, etc. If so, run:
3) "make samples"
- 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.
+ Doing so will overwrite any existing config files you have.
- Finally, you can launch Asterisk with:
+ Finally, you can launch Asterisk in the foreground mode (not a daemon)
# asterisk -vvvc
@@ -95,6 +121,10 @@ Remember that if you don't have a full duplex sound card (and Asterisk
will tell you somewhere in its verbose messages if you do/don't) then it
won't work right (not yet).
+ "man asterisk" at the Unix/Linux command prompt will give you detailed
+information on how to start and stop Asterisk, as well as all the command
+line options for starting Asterisk.
Feel free to look over the configuration files in /etc/asterisk, where
you'll find a lot of information about what you can do with Asterisk.
@@ -196,12 +226,14 @@ that starts Asterisk.
- See the doc directory for more documentation.
+ See the doc directory for more documentation on various features. Again,
+please read all the configuration samples that include documentation on
+the configuration options.
Finally, you may wish to visit the web site and join the mailing list if
you're interested in getting more information.
- http://www.asterisk.org/index.php?menu=support
+ http://www.asterisk.org/support
Welcome to the growing worldwide community of Asterisk users!