Version 0.1.2 from FTP
[asterisk/asterisk.git] / README
1 The Asterisk Open Source PBX
2 by Mark Spencer <markster@linux-support.net>
3 Copyright (C) 1999, Mark Spencer
4 ================================================================
5 * WHAT IS ASTERISK
6   Asterisk is an Open Source PBX and telephony toolkit.  It is, in a
7 sense, middleware between Internet and telephony channels on the bottom,
8 and Internet and telephony applications at the top.  For more information
9 on the project itself, please visit the Asterisk home page at:
10
11            http://www.asteriskpbx.com
12
13
14 * REQUIRED COMPONENTS
15
16 == Linux ==
17   Currently, the Asterisk Open Source PBX is only known to run on the
18 Linux OS, although it may be portable to other UNIX-like operating systems
19 as well.
20
21 == libaudiofile ==
22
23   If you want to use format_wav module, then you need a very recent
24 version of libaudiofile (at least version 0.2.0, or you can apply the
25 included patch.  RPMS for the patched libaudiofile are available at:
26 ftp://ftp.asteriskpbx.com/pub/asterisk/support
27
28
29 * GETTING STARTED
30
31 First, be sure you've installed the required libaudiofile upgrade if 
32 you want to use the non-GSM WAV format.  Next, be sure you've got
33 supported hardware.  To use Asterisk right now, you will need one of 
34 the following:
35
36         * Adtran Atlas 800 Plus
37         * QuickNet Internet PhoneJack
38         * Full Duplex Sound Card supported by Linux
39
40 Assuming you have one of these (most likely the third) you're ready to 
41 proceed:
42
43 1) Run "make"
44 2) Run "make install"
45
46 If this is your first time working with Asterisk, you may wish to install
47 the sample PBX, with demonstration extensions, etc.  If so, run:
48
49         "make samples"
50
51 Doing so will overwrite any existing config files you have.
52
53 Finally, you can launch Asterisk with:
54
55         ./asterisk -vvvc
56
57 If you get an error about unresolved symbols, install the updated
58 libaudiofile (available at ftp://ftp.asteriskpbx.com/pub/asterisk/support
59
60 You'll see a bunch of verbose messages fly by your screen as Asterisk
61 initializes (that's the "very very verbose" mode).  When it's ready, if
62 you specified the "c" then you'll get a command line console, that looks
63 like this: 
64
65 *CLI>
66
67 You can type "help" at any time to get help with the system.  For help
68 with a specific command, type "help <command>".  To start the PBX using
69 your sound card, you can type "dial" to dial the PBX.  Then you can use
70 "answer", "hangup", and "dial" to simulate the actions of a telephone.
71 Remember that if you don't have a full duplex sound card (And asterisk
72 will tell you somewhere in its verbose messages if you do/don't) than it
73 won't work right (not yet).
74
75 Feel free to look over the configuration files in /etc/asterisk, where
76 you'll find a lot of information about what you can do with Asterisk.
77
78 Finally, you may wish to visit the web site and join the mailing list if
79 you're interested in getting more information.
80
81 Mark