Version 0.1.8 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
22 * GETTING STARTED
23
24 First, be sure you've got supported hardware.  To use Asterisk right now,
25 you will need one of the following:
26
27         * Adtran Atlas 800 Plus
28         * QuickNet Internet PhoneJack
29         * Full Duplex Sound Card supported by Linux
30         * ISDN4Linux compatible ISDN card
31         * Tormenta Dual T1 card (www.bsdtelephony.com.mx)
32
33 Assuming you have one of these (most likely the third) you're ready to 
34 proceed:
35
36 1) Run "make"
37 2) Run "make install"
38
39 If this is your first time working with Asterisk, you may wish to install
40 the sample PBX, with demonstration extensions, etc.  If so, run:
41
42         "make samples"
43
44 Doing so will overwrite any existing config files you have.
45
46 Finally, you can launch Asterisk with:
47
48         ./asterisk -vvvc
49
50 You'll see a bunch of verbose messages fly by your screen as Asterisk
51 initializes (that's the "very very verbose" mode).  When it's ready, if
52 you specified the "c" then you'll get a command line console, that looks
53 like this:
54
55 *CLI>
56
57 You can type "help" at any time to get help with the system.  For help
58 with a specific command, type "help <command>".  To start the PBX using
59 your sound card, you can type "dial" to dial the PBX.  Then you can use
60 "answer", "hangup", and "dial" to simulate the actions of a telephone.
61 Remember that if you don't have a full duplex sound card (And asterisk
62 will tell you somewhere in its verbose messages if you do/don't) than it
63 won't work right (not yet).
64
65 Feel free to look over the configuration files in /etc/asterisk, where
66 you'll find a lot of information about what you can do with Asterisk.
67
68 * ABOUT CONFIGURATION FILES
69
70 All Asterisk configuration files share a common format.  Comments are
71 delimited by ';' (since '#' of course, being a DTMF digit, may occur in
72 many places).  A configuration file is divided into sections whose names
73 appear in []'s.  Each section typically contains two types of statements,
74 those of the form 'variable = value', and those of the form 'object =>
75 parameters'.  Internally the use of '=' and '=>' is exactly the same, so 
76 they're used only to help make the configuration file easier to
77 understand, and do not affect how it is actually parsed.
78
79 Entries of the form 'variable=value' set the value of some parameter in
80 asterisk.  For example, in tormenta.conf, one might specify:
81
82         switchtype=national
83
84 In order to indicate to Asterisk that the switch they are connecting to is
85 of the type "national".  In general, the parameter will apply to
86 instantiations which occur below its specification.  For example, if the
87 configuration file read:
88
89         switchtype = national
90         channel => 1-4
91         channel => 10-12
92         switchtype = dms100
93         channel => 25-47
94
95 Then, the "national" switchtype would be applied to channels one through
96 four and channels 10 through 12, whereas the "dms100" switchtype would
97 apply to channels 25 through 47.
98   
99 The "object => parameters" instantiates an object with the given
100 parameters.  For example, the line "channel => 25-47" creates objects for
101 the channels 25 through 47 of the tormenta card, obtaining the settings
102 from the variables specified above.
103
104 * MORE INFORMATION
105
106 Finally, you may wish to visit the web site and join the mailing list if
107 you're interested in getting more information.
108
109 Mark