[Asterisk-doc] docs installation.xml,1.10,1.11
blitzrage
asterisk-doc@lists.digium.com
Tue, 25 May 2004 22:08:03 +0000
Comments:
Update of /cvsroot/asterisk/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6239
Modified Files:
installation.xml
Log Message:
blitzrage
- some minor changes to the formatting in the installation.xml file
- expanded upon the zaptel compilation, mention ztdummy
- explain that the samples do not give you a working system, and how to compile
Index: installation.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/installation.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** installation.xml 7 May 2004 02:16:56 -0000 1.10
--- installation.xml 25 May 2004 22:07:55 -0000 1.11
***************
*** 11,26 ****
--- 11,30 ----
<para/>
</sect3>
+
<sect3>
<title>Small Business System</title>
<para/>
</sect3>
+
<sect3>
<title>Medium Business/Small Call-center System</title>
<para/>
</sect3>
+
<sect3>
<title>Enterprise System</title>
<para/>
</sect3>
+
<sect3>
<title>VoIP Carrier System</title>
***************
*** 28,31 ****
--- 32,36 ----
</sect3>
</sect2>
+
<sect2>
<title>Linux Requirements</title>
***************
*** 39,49 ****
</para>
</sect3>
<sect3>
<title>Minimal Kernel Version</title>
<para>
! Asterisk is designed to work on any Linux kernel 2.4. However there is some support for kernel
2.6. If you are trying to build a stable system, it is recommended that you use kernel version 2.4.
</para>
</sect3>
<sect3>
<title>Required Packages</title>
--- 44,56 ----
</para>
</sect3>
+
<sect3>
<title>Minimal Kernel Version</title>
<para>
! Asterisk is designed to work on Linux kernel version 2.4, however there is some support for kernel
2.6. If you are trying to build a stable system, it is recommended that you use kernel version 2.4.
</para>
</sect3>
+
<sect3>
<title>Required Packages</title>
***************
*** 51,63 ****
<!-- [OpenSSL and its development libraries, and libnewt for zttool] -->
Previously there were some packages which were requirements to install Asterisk such as
! readline and readline-devel. Also there is no special hardware required such as a soundcard.
! The only required package is Asterisk itself. If you are using Digium hardware, you will need
! the zaptel package. For T1 and E1 interfaces the libpri package is required. Bison is required
! to compile Asterisk and the ncurses and ncurses-devel packages are required if you wish to build
! the newt tools (e.g. astman).
</para>
</sect3>
</sect2>
</sect1>
<sect1>
<title>Hardware Installation</title>
--- 58,71 ----
<!-- [OpenSSL and its development libraries, and libnewt for zttool] -->
Previously there were some packages which were requirements to install Asterisk such as
! readline and readline-devel that are no longer required. As well there is no special hardware
! required such as a soundcard. The only required package is Asterisk itself. If you are using
! Digium hardware, you will need the zaptel package. For T1 and E1 interfaces the libpri package
! is required. Bison is required to compile Asterisk, the ncurses and ncurses-devel packages are
! required if you wish to build the newt tools (e.g. astman).
</para>
</sect3>
</sect2>
</sect1>
+
<sect1>
<title>Hardware Installation</title>
***************
*** 66,70 ****
<para>
Many telephony cards such as the X100P tend to generate a large amount of interupts.
! Servicing themtakes time and drivers may not be able to do it on-time. If another device is
processing the same shared IRQ, the IRQ line connot receive another one. It does
tend to work better on SMP (APIC) systems. On single chip systems you can get
--- 74,78 ----
<para>
Many telephony cards such as the X100P tend to generate a large amount of interupts.
! Servicing them takes time and drivers may not be able to do it on-time. If another device is
processing the same shared IRQ, the IRQ line connot receive another one. It does
tend to work better on SMP (APIC) systems. On single chip systems you can get
***************
*** 76,79 ****
--- 84,88 ----
</para>
</sect2>
+
<sect2>
<title>Digium Cards</title>
***************
*** 83,94 ****
--- 92,106 ----
<para/>
</sect3>
+
<sect3>
<title>TDM400P</title>
<para/>
</sect3>
+
<sect3>
<title>T100P and E100P</title>
<para/>
</sect3>
+
<sect3>
<title>TE410P (and T400P and E400P)</title>
***************
*** 96,101 ****
--- 108,115 ----
</sect3>
</sect2>
+
<sect2>
<title>ISDN Cards</title>
+ <para>[This should probably be moved somewhere else.]</para>
<para>
ISDN hardware in most parts of the world are not very expensive. A basic AVM card
***************
*** 111,115 ****
descriptions on how to get CAPI support for several cards.
</para>
! <para>For a "Eicon Diva" visit:</para>
<para>
<simplelist>
--- 125,133 ----
descriptions on how to get CAPI support for several cards.
</para>
!
! <para>
! For a "Eicon Diva" visit:
! </para>
!
<para>
<simplelist>
***************
*** 119,127 ****
</simplelist>
</para>
! <para>For AVM cards visit:</para>
<para>
<ulink url="http://www.avm.de" type="http">http://www.avm.de</ulink>
</para>
! <para>For AVM-Fritz! cards: </para>
<para>
<ulink url="ftp://ftp.avm.de/cardware/fritzcrd.pci/linux/suse.82/" type="http">ftp://ftp.avm.de/cardware/fritzcrd.pci/linux/suse.82/</ulink> (not only for SuSE)
--- 137,153 ----
</simplelist>
</para>
!
! <para>
! For AVM cards visit:
! </para>
!
<para>
<ulink url="http://www.avm.de" type="http">http://www.avm.de</ulink>
</para>
!
! <para>
! For AVM-Fritz! cards:
! </para>
!
<para>
<ulink url="ftp://ftp.avm.de/cardware/fritzcrd.pci/linux/suse.82/" type="http">ftp://ftp.avm.de/cardware/fritzcrd.pci/linux/suse.82/</ulink> (not only for SuSE)
***************
*** 129,132 ****
--- 155,159 ----
</para>
</sect2>
+
<sect2>
<title>Other Cards (LineJack/PhoneJack/VoiceTronix/Dialogic)</title>
***************
*** 134,137 ****
--- 161,165 ----
</sect2>
</sect1>
+
<sect1>
<title>Downloading Asterisk from CVS</title>
***************
*** 148,151 ****
--- 176,180 ----
</para>
</sect2>
+
<sect2>
<title>The Asterisk "Versioning" Issues</title>
***************
*** 158,161 ****
--- 187,191 ----
</para>
</sect2>
+
<sect2>
<title>Your Initial Download</title>
***************
*** 163,171 ****
Asterisk can be obtained from the Digium CVS server. You will require any packages which your distribution
requires to download the sourcecode and to compile. Most modern Linux distributions have a category at installation
! for development tools, but some may vary. Binaries are available, however they are created on a *non-regular* basis,
so you are best to stick to using the CVS method to obtain and compile the sourcecode.
</para>
<!-- removed distribution specific stuff -->
</sect2>
<sect2>
<title>Getting the files from CVS</title>
--- 193,202 ----
Asterisk can be obtained from the Digium CVS server. You will require any packages which your distribution
requires to download the sourcecode and to compile. Most modern Linux distributions have a category at installation
! for development tools, but some may vary. Binaries are available, however they are created on a non-regular basis,
so you are best to stick to using the CVS method to obtain and compile the sourcecode.
</para>
<!-- removed distribution specific stuff -->
</sect2>
+
<sect2>
<title>Getting the files from CVS</title>
***************
*** 178,182 ****
<sect3>
<title>Development Branch</title>
- <para>
<literallayout>
<command>cd /usr/src</command>
--- 209,212 ----
***************
*** 185,189 ****
<command>cvs checkout zaptel libpri asterisk</command>
</literallayout>
! </para>
<para>
Your server will download all the appropriate files from the CVS server
--- 215,219 ----
<command>cvs checkout zaptel libpri asterisk</command>
</literallayout>
!
<para>
Your server will download all the appropriate files from the CVS server
***************
*** 192,198 ****
</para>
</sect3>
<sect3>
<title>Stable Branch</title>
- <para>
<literallayout>
<command>cd /usr/src</command>
--- 222,228 ----
</para>
</sect3>
+
<sect3>
<title>Stable Branch</title>
<literallayout>
<command>cd /usr/src</command>
***************
*** 201,207 ****
<command>cvs checkout -r v1-0_stable asterisk</command>
</literallayout>
- </para>
</sect3>
</sect2>
<sect2>
<title>Updates</title>
--- 231,237 ----
<command>cvs checkout -r v1-0_stable asterisk</command>
</literallayout>
</sect3>
</sect2>
+
<sect2>
<title>Updates</title>
***************
*** 212,218 ****
so those will need to be done manually.
</para>
<sect3>
<title>Updating zaptel and libpri</title>
- <para>
<literallayout>
<command>cd /usr/src/</command>
--- 242,248 ----
so those will need to be done manually.
</para>
+
<sect3>
<title>Updating zaptel and libpri</title>
<literallayout>
<command>cd /usr/src/</command>
***************
*** 222,227 ****
[say how to unload the modules and recompile]
</literallayout>
- </para>
</sect3>
<sect3>
<title>Updating asterisk with make update</title>
--- 252,257 ----
[say how to unload the modules and recompile]
</literallayout>
</sect3>
+
<sect3>
<title>Updating asterisk with make update</title>
***************
*** 235,238 ****
--- 265,269 ----
</sect2>
</sect1>
+
<sect1>
<title>Compiling Asterisk</title>
***************
*** 241,244 ****
--- 272,276 ----
<para/>
</sect2>
+
<sect2>
<title>Compiling the software</title>
***************
*** 246,250 ****
<sect3>
<title>Zaptel</title>
! <para>
<literallayout>
<command>cd /usr/src/zaptel/</command>
--- 278,287 ----
<sect3>
<title>Zaptel</title>
! <para>
! You will need to compile the Zaptel modules if you plan on using any Digium
! hardware. This will compile and install the modules for any Digium hardware
! which you might have installed in your system:
! </para>
!
<literallayout>
<command>cd /usr/src/zaptel/</command>
***************
*** 252,260 ****
<command>make install</command>
</literallayout>
! </para>
</sect3>
<sect3>
<title>Libpri</title>
- <para>
<literallayout>
<command>cd /usr/src/libpri</command>
--- 289,323 ----
<command>make install</command>
</literallayout>
!
! <para>
! The ztdummy module is used when you do not have any Digium hardware for timing
! but need it - such as for Music On Hold or Conferencing. The ztdummy driver
! requires that you have a UHCI USB controller chip on your motherboard. If you
! are using an OHCI USB controller you will need to use zaprtc. You can check to
! see if your motherboard has the UHCI USB controller by running
! <command>lsmod</command> from the command line. To compile the ztdummy module
! you will have to edit the <filename>Makefile</filename> located in your
! <filename class='directory'>/usr/src/zaptel</filename> directory. Find the
! line containing:
! </para>
!
! <programlisting>
! MODULES=zaptel tor2 torisa wcusb wcfxo wcfxs \
! ztdynamic ztd-eth wct1xxp wct4xxp # ztdummy
! </programlisting>
!
! <para>
! and uncomment the ztdummy module. Perform the compilation as normal. Once you
! have successfully compiled the ztdummy module you can load it into memory by
! using modprobe.
! </para>
!
! <literallayout>
! <command>modprobe ztdummy</command>
! </literallayout>
</sect3>
+
<sect3>
<title>Libpri</title>
<literallayout>
<command>cd /usr/src/libpri</command>
***************
*** 262,270 ****
<command>make install</command>
</literallayout>
- </para>
</sect3>
<sect3>
<title>Asterisk</title>
- <para>
<literallayout>
<command>cd /usr/src/asterisk</command>
--- 325,332 ----
<command>make install</command>
</literallayout>
</sect3>
+
<sect3>
<title>Asterisk</title>
<literallayout>
<command>cd /usr/src/asterisk</command>
***************
*** 272,282 ****
<command>make install</command>
</literallayout>
- </para>
</sect3>
</sect2>
<sect2>
<title>Making the Samples/Demo</title>
! <para/>
</sect2>
<sect2>
<title>Making Code Documentation (Doxygen)</title>
--- 334,355 ----
<command>make install</command>
</literallayout>
</sect3>
</sect2>
+
<sect2>
<title>Making the Samples/Demo</title>
! <para>
! The sample configuration files are for the purpose of learning how to create
! your own configuration files and to give you an idea of the commands you can
! use. These files are <emphasis>not</emphasis> designed to give you a
! working Asterisk system right out of the box. Chapter 4 deals with creating
! a dialplan and writing an extensions.conf file.
! </para>
! <literallayout>
! <command>cd /usr/src/asterisk</command>
! <command>make samples</command>
! </literallayout>
</sect2>
+
<sect2>
<title>Making Code Documentation (Doxygen)</title>
***************
*** 285,296 ****
--- 358,372 ----
<para/>
</sect3>
+
<sect3>
<title>What is Doxygen?</title>
<para/>
</sect3>
+
<sect3>
<title>Requirements for Doxygen</title>
<para/>
</sect3>
+
<sect3>
<title>Code Documentation Layout</title>
***************
*** 298,301 ****
--- 374,378 ----
</sect3>
</sect2>
+
<sect2>
<title>Building additional modules</title>
***************
*** 308,319 ****
--- 385,399 ----
</para>
</sect3>
+
<sect3>
<title>H323 - Manousos</title>
<para/>
</sect3>
+
<sect3>
<title>MySQL CDR</title>
<para/>
</sect3>
+
<sect3>
<title>CAPI/ISDN</title>
***************
*** 321,347 ****
The complete source code is available from Kapejod's website
</para>
<para>
<ulink url="http://www.junghanns.net/asterisk/downloads/chan_capi.0.3.0.tar.gz" type="http">
http://www.junghanns.net/asterisk/downloads/chan_capi.0.3.0.tar.gz</ulink>
</para>
<para>
! copy the sources to a folder of your choice and type the following
commands to untar the source and change into its directory tree.
</para>
! <para>
<literallayout>
<command>tar zxf chan_capi.0.3.0.tar.gz</command>
<command>cd chan_capi-0.3.0/</command>
</literallayout>
! </para>
<para>
Now edit the file Makefile with your favorite editor to set it to your needs.
First set the path to your asterisk include files.
</para>
! <para>
<literallayout>
"ASTERISK_HEADER_DIR=/usr/include/asterisk # standard path"
</literallayout>
! </para>
<para>
Then you can set some build time configuration parameters like early B3
--- 401,429 ----
The complete source code is available from Kapejod's website
</para>
+
<para>
<ulink url="http://www.junghanns.net/asterisk/downloads/chan_capi.0.3.0.tar.gz" type="http">
http://www.junghanns.net/asterisk/downloads/chan_capi.0.3.0.tar.gz</ulink>
</para>
+
<para>
! Copy the sources to a folder of your choice and type the following
commands to untar the source and change into its directory tree.
</para>
!
<literallayout>
<command>tar zxf chan_capi.0.3.0.tar.gz</command>
<command>cd chan_capi-0.3.0/</command>
</literallayout>
!
<para>
Now edit the file Makefile with your favorite editor to set it to your needs.
First set the path to your asterisk include files.
</para>
!
<literallayout>
"ASTERISK_HEADER_DIR=/usr/include/asterisk # standard path"
</literallayout>
!
<para>
Then you can set some build time configuration parameters like early B3
***************
*** 349,376 ****
If everything is done simply save the file.
</para>
! <para>
<literallayout>
! to compile and install the driver type:
<command>make && make install</command>
! </literallayout>
! </para>
! <para>
! <literallayout>
! to install a sample capi.conf in asterisks conf dir:
<command>make config</command>
</literallayout>
! </para>
<para>
After this setup add in /etc/asterisk/modules.conf
</para>
! <para>
<command>load => chan_ca-pi.so</command>
! </para>
<para>
and in the [global] section:
</para>
! <para>
<command>"chan_capi.so=yes"</command>
! </para>
<para>
After these steps your channel module is available in Asterisk but it has to be
--- 431,459 ----
If everything is done simply save the file.
</para>
!
<literallayout>
! To compile and install the driver type:
<command>make && make install</command>
!
! To install a sample capi.conf in asterisks conf dir:
<command>make config</command>
</literallayout>
!
<para>
After this setup add in /etc/asterisk/modules.conf
</para>
!
! <literallayout>
<command>load => chan_ca-pi.so</command>
! </literallayout>
!
<para>
and in the [global] section:
</para>
!
! <literallayout>
<command>"chan_capi.so=yes"</command>
! </literallayout>
!
<para>
After these steps your channel module is available in Asterisk but it has to be
***************
*** 379,382 ****
--- 462,466 ----
</sect3>
</sect2>
+
<sect2>
<title>Common Build Errors / Warnings</title>
***************
*** 385,388 ****
--- 469,473 ----
<para/>
</sect3>
+
<sect3>
<title>Building on a little-endian system</title>
***************
*** 391,394 ****
--- 476,480 ----
</sect2>
</sect1>
+
<sect1>
<title>Loading Drivers</title>
***************
*** 397,404 ****
--- 483,492 ----
<para/>
</sect2>
+
<sect2>
<title>Using "modprobe"</title>
<para/>
</sect2>
+
<sect2>
<title>Adding zaptel modules to your startup file</title>
***************
*** 406,414 ****
</sect2>
</sect1>
<sect1>
<title>Starting Asterisk</title>
<sect2>
<title>Manually starting Asterisk and the CLI</title>
- <para>
<literallayout>
To start asterisk in the background; <command>/usr/sbin/asterisk</command>
--- 494,502 ----
</sect2>
</sect1>
+
<sect1>
<title>Starting Asterisk</title>
<sect2>
<title>Manually starting Asterisk and the CLI</title>
<literallayout>
To start asterisk in the background; <command>/usr/sbin/asterisk</command>
***************
*** 418,423 ****
To start asterisk in console mode, verbose, debug and dump cores: <command>/usr/sbin/asterisk -cvvvgd</command>
</literallayout>
- </para>
</sect2>
<sect2>
<title>Starting Asterisk using safe_asterisk</title>
--- 506,511 ----
To start asterisk in console mode, verbose, debug and dump cores: <command>/usr/sbin/asterisk -cvvvgd</command>
</literallayout>
</sect2>
+
<sect2>
<title>Starting Asterisk using safe_asterisk</title>
***************
*** 425,436 ****
[Explain why you'd want to use safe_asterisk]
</para>
<para>
You can start Asterisk as a daemon using the <filename>safe_asterisk </filename> script located
in <filename class='directory'>/usr/sbin/</filename>
</para>
! <para>
<command>/usr/sbin/safe_asterisk</command>
! </para>
</sect2>
<sect2>
<title>Accessing the CLI when Asterisk is running</title>
--- 513,527 ----
[Explain why you'd want to use safe_asterisk]
</para>
+
<para>
You can start Asterisk as a daemon using the <filename>safe_asterisk </filename> script located
in <filename class='directory'>/usr/sbin/</filename>
</para>
!
! <literallayout>
<command>/usr/sbin/safe_asterisk</command>
! </literallayout>
</sect2>
+
<sect2>
<title>Accessing the CLI when Asterisk is running</title>
***************
*** 447,454 ****
--- 538,547 ----
</example>
</para>
+
<para>
[Please, let's be more specific here. And maybe give an example.]
</para>
</sect2>
+
<sect2>
<title>Logging/Tracing and Verbosity</title>
***************
*** 456,459 ****
--- 549,553 ----
</sect2>
</sect1>
+
<sect1>
<title>Configuring Autostart w/ safe_asterisk</title>
***************
*** 462,465 ****
--- 556,560 ----
<para/>
</sect2>
+
<sect2>
<title>Modifying the startup manually</title>