1 |
Copyright (c) 1999-2001 by Open Source Telecom Corporation. |
2 |
Verbatim copying and distribution of this entire article is permitted |
3 |
in any medium, provided this notice is preserved. |
4 |
|
5 |
INSTALL - Instructions for building and installing Bayonne from source |
6 |
|
7 |
HISTORY |
8 |
Updated for: Bayonne-0.6.4 by: rsb@ostel.com |
9 |
Created By: David Sugar |
10 |
|
11 |
Please help us maintain an up-to-date INSTALL file by sending updates, |
12 |
notes, and suggestions to bayonne-devel@lists.sourceforge.net Thanks! |
13 |
|
14 |
For The Impatient |
15 |
================= |
16 |
|
17 |
There are a lot of dependencies, so if you are patient, it is far |
18 |
better to skip this section and read the rest of this file instead. |
19 |
If you absolutely do not have time to read this file, then the |
20 |
following might work for you: |
21 |
|
22 |
Make sure you have a machine with perl, c++, and libxml (and Lis streams if |
23 |
you are using Dialogic stuff). Then get the latest source for: |
24 |
CommonC++, ccaudio, ccscript, ccrtp, and Bayonne. |
25 |
|
26 |
rm -rf /usr/local/lib/libcc* |
27 |
rm -rf /usr/local/include/cc++ |
28 |
export PATH=$PATH:/usr/local/bin |
29 |
export PATH=$PATH:/usr/local/sbin |
30 |
cd CommonC++-<tab> |
31 |
./configure && make install |
32 |
cd ../ccaudio-<tab> |
33 |
./configure && make install |
34 |
cd ../ccscript-<tab> |
35 |
./configure && make install |
36 |
cd ../ccrtp-<tab> |
37 |
./configure && make install |
38 |
ldconfig |
39 |
cd ../Bayonne-<tab> |
40 |
./configure --without-perl && make install |
41 |
bayonne --trace |
42 |
|
43 |
Before You Start |
44 |
================ |
45 |
|
46 |
This file contains up-to-date instructions for Building the |
47 |
current version of Bayonne. You must read at least the following |
48 |
three sections: Bayonne Prerequisites, Building Bayonne, and |
49 |
Configuring and Testing Bayonne. You may want to read the BAYONNE.FAQ |
50 |
or the manual in the /doc directory if you run into trouble with these |
51 |
instructions. Detailed information on configuring and hacking Bayonne |
52 |
can be found in the manual. If you don't get what you need out of |
53 |
those, you will want to contact bayonne-devel@lists.sourceforge.net to |
54 |
get help. |
55 |
|
56 |
Bayonne Prerequisites |
57 |
===================== |
58 |
|
59 |
Before building Bayonne, make sure you have the following basic |
60 |
necessities installed and working on your development system: |
61 |
|
62 |
C++ build environment |
63 |
Perl interpreter |
64 |
|
65 |
In order to build Bayonne from tarballs, you must download, |
66 |
compile, and install at least the following modules in this order: |
67 |
|
68 |
libxml: |
69 |
ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/libxml2-2.4.1.tar.gz |
70 |
CommonC++: |
71 |
ftp://ftp.voxilla.org/pub/bayonne/CommonC++-1.5.0.tar.gz |
72 |
ccaudio: |
73 |
ftp://ftp.voxilla.org/pub/bayonne/ccaudio-0.4.4.tar.gz |
74 |
ccscript: |
75 |
ftp://ftp.voxilla.org/pub/bayonne/ccscript-1.6.1.tar.gz |
76 |
ccrtp: |
77 |
ftp://ftp.voxilla.org/pub/bayonne/ccrtp-0.5.0.tar.gz |
78 |
Bayonne: |
79 |
ftp://ftp.voxilla.org/pub/bayonne/bayonne-0.6.4.tar.gz |
80 |
|
81 |
Before you can actually do anything with Bayonne, you will |
82 |
need a driver for a supported telephony device installed and tested. |
83 |
The supported telephony devices as of this writing are: |
84 |
|
85 |
Phonedev: any card that uses the /dev/phone interface, i.e. quicknet |
86 |
Pika: www.pika.ca |
87 |
Dialogic: www.dialogic.com |
88 |
Voicetronix: www.voicetronix.com.au |
89 |
|
90 |
There are several cards and protocol stacks with incomplete |
91 |
support as well: |
92 |
|
93 |
EECS: www.eecs-com.net |
94 |
Aculab: www.aculab.com |
95 |
Zapata: www.bsdtelephony.com.mx |
96 |
Voice Modems: any AT+V compatible modem |
97 |
OpenH323: www.openh323.org |
98 |
More being added all the time... |
99 |
|
100 |
Sometimes configuring and testing a device can be tricky. |
101 |
This is not our fault. Any tips or instructions we have on |
102 |
configuring and testing telephony devices we will put in the manual in |
103 |
the /doc subdirectory. |
104 |
|
105 |
Building Bayonne |
106 |
================ |
107 |
|
108 |
Once you have the pre-requisites out of the way, you MUST consider the |
109 |
configure options as described below. |
110 |
|
111 |
By default, Bayonne will attempt to build and install all of |
112 |
the telephony servers supported in the distribution. Since most often |
113 |
only a specific set of servers is required to support the vendor |
114 |
telephony hardware you have available, there are ways to select and |
115 |
remove vendor specific server implementations through configure. The |
116 |
advantage of doing this is a shorter compile time and the elimination |
117 |
of distractions from errors in building uneeded API trees. |
118 |
|
119 |
The "--without-pika" option removes all Pika Monte Carlo related |
120 |
modules and libraries from the build tree. The "--without-phonedev" |
121 |
option removes all GNU/Linux /dev/phone support. |
122 |
|
123 |
If you do not have embedded perl installed, you must use |
124 |
"--without-perl", if you do not have the Voicetronix driver |
125 |
installed, you must use "--without-vpb". |
126 |
|
127 |
A typical configuration command if you just have a quicknet card: |
128 |
./configure --without-vpb --without-perl --without-pika --without-dialogic |
129 |
|
130 |
After Bayonne configures, just run "make" to compile the |
131 |
system. |
132 |
|
133 |
Configuring and Testing Bayonne |
134 |
=============================== |
135 |
|
136 |
After you have compiled bayonne you may immediately test bayonne |
137 |
from the "build" directory. Simply "cd server" and execute |
138 |
"./bayonne --test". Bayonne will immediately load a bunch of DSO |
139 |
modules and perform a complete 3 stage regression test on itself. |
140 |
This should take less than 30 seconds, and should complete with a |
141 |
message indicating all tests have "passed". |
142 |
|
143 |
Bayonne "--test" mode will select the default telephony plugin |
144 |
to use based on the current API's found when Bayonne was |
145 |
"./configure"ed. For instance, if MonteCarlo is found, then it |
146 |
bayonne will select the Pika MonteCarlo in "--test" mode. |
147 |
|
148 |
You configure Bayonne for actual use with "make install". If you |
149 |
have multiple telephony api's installed on your machine, you will need to |
150 |
specify which plugin driver to select in /etc/bayonne.conf. In the |
151 |
[plugins] section simply put a line such as "driver = phonedev" or "driver = |
152 |
pika". |
153 |
|
154 |
You can do more things with "--test" though. Enter "./bayonne --test |
155 |
playrec". This will bring up a Bayonne server with the trace DSO |
156 |
loaded that runs from the "build" directory. Call your telephony |
157 |
device, and it will answer and run the "playrec" script. |
158 |
|
159 |
Once you can call in and use playrec, you are ready to install |
160 |
and/or develop applications. See the Bayonne Manual in the /doc |
161 |
directory for more information on this. Have Fun! |
162 |
|