[Asterisk-doc] docs installation.xml,1.11,1.12

blitzrage asterisk-doc@lists.digium.com
Thu, 27 May 2004 13:29:55 +0000


Comments:
Update of /cvsroot/asterisk/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29930/docs

Modified Files:
	installation.xml 
Log Message:
blitzrage
- added some more stuff to the Installation chapter
- I've forgotten what I added to the dialplan chapter....
Index: installation.xml
===================================================================
RCS file: /cvsroot/asterisk/docs/installation.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** installation.xml	25 May 2004 22:07:55 -0000	1.11
--- installation.xml	27 May 2004 13:29:49 -0000	1.12
***************
*** 50,53 ****
--- 50,54 ----
  				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.
+ 				The following sections will assume you are running on a 2.4 kernel based system.
  				</para>
  			</sect3>
***************
*** 204,209 ****
  			Once you've decided which branch you are going to download, you can use the following commands to retrieve 
  			the sources.  Your server will download all the appropriate files from the CVS server
!                         and place them in their respective directories.  If you don't need zaptel or libpri
!                         simply leave them out of the checkout statement.
  			</para>
  			<sect3>
--- 205,210 ----
  			Once you've decided which branch you are going to download, you can use the following commands to retrieve 
  			the sources.  Your server will download all the appropriate files from the CVS server
! 			and place them in their respective directories.  If you don't need zaptel or libpri
! 			simply leave them out of the checkout statement.
  			</para>
  			<sect3>
***************
*** 252,255 ****
--- 253,306 ----
  				[say how to unload the modules and recompile]
  				</literallayout>
+ 				
+ 				<para>
+ 				Now we must unload the modules from memory before we recompile them.  We can
+ 				check to see what modules are currently loaded by using the <command>lsmod
+ 				</command> command.  You should get an output similar to the following:
+ 				</para>
+ 
+ 				<para>
+ 				[Show lsmod output example here]
+ 				</para>
+ 
+ 				<para>
+ 				We are looking to see that the zaptel and libpri modules are loaded.
+ 				The <command>rmmod</command> command can now be used to remove these
+ 				modules from memory.
+ 				</para>
+ 
+ 				<literallayout>
+ 				<command>rmmod zaptel</command>
+ 				<command>rmmod libpri</command>
+ 				</literallayout>
+ 
+ 				<para>
+ 				Now we must recompile the drivers.  We want to change to our zaptel source
+ 				directory (ie. <filename class='directory'>/usr/src/zaptel/</filename>).
+ 				The first command we run will clean out any previously compiled drivers and
+ 				get the directories ready for our new drivers.  The second command will then
+ 				compile the drivers and install them into the appropriate directories for us.
+ 				</para>
+ 
+ 				<literallayout>
+ 				<command>make clean</command>
+ 				<command>make install</command>
+ 				</literallayout>
+ 
+ 				<para>
+ 				Follow the same procedure for libpri if you need to recompile that.  Once the
+ 				drivers are recompiled, you can then load them into memory using the modprobe
+ 				command.
+ 				</para>
+ 
+ 				<literallayout>
+ 				<command>modprobe zaptel</command>
+ 				<command>modprobe libpri</command>
+ 				</literallayout>
+ 
+ 				<para>
+ 				[someone should probably verify this works like this, and document any common
+ 				problems people have with recompiling and installing the modules into memory]
+ 				</para>
  			</sect3>
  			
***************
*** 325,328 ****
--- 376,386 ----
  					<command>make install</command>
  					</literallayout>
+ 
+ 					<para>
+ 					[Lets document problems that people have with libpri, how to setup any
+ 					options in the Makefile, and maybe we can explain a bit why you would
+ 					even need or want libpri.  It's mentioned briefly above, but maybe they
+ 					didn't read it...]
+ 					</para>
  			</sect3>
  			
***************
*** 334,337 ****
--- 392,402 ----
  					<command>make install</command>
  					</literallayout>
+ 
+ 					<para>
+ 					[Lets document problems that people have with compiling Asterisk, how to
+ 					setup options in the Makefile.  We should mention some of the things you 
+ 					have to change when setting up on a Linux 2.6 kernel at some point (and
+ 					should probably do that for all sections]
+ 					</para>
  			</sect3>
  		</sect2>
***************
*** 378,386 ****
  			<title>Building additional modules</title>
  			<para>
! 			[Should this be here, or somewhere else?]
  			</para>
  			<sect3>
  				<title>H323 - McNamara</title>
  				<para>
  				</para>
  			</sect3>
--- 443,463 ----
  			<title>Building additional modules</title>
  			<para>
! 			Beyond the base install and drivers, Asterisk contains many additional
! 			modules which are not compiled by default.  This is to help simplify the
! 			installation of Asterisk and not to cause the system to be bloated with
! 			extra code that a user may not have a use for.
! 			</para>
! 
! 			<para>
! 			[This is just a rough introduction, however we should expand upon it.
! 			Mention things that your system already needs to have running, what
! 			extra software or hardware you need for this to work, and any other
! 			issues that should be mentioned briefly before we get in too deep]
  			</para>
  			<sect3>
  				<title>H323 - McNamara</title>
  				<para>
+ 				[Not sure what the difference is between McNamara and Manousos, but either
+ 				way lets try and be as detailed as possible]
  				</para>
  			</sect3>
***************
*** 393,397 ****
  			<sect3>
  				<title>MySQL CDR</title>
! 				<para/>
  			</sect3>
  			
--- 470,486 ----
  			<sect3>
  				<title>MySQL CDR</title>
! 				<para>
! 				[Lets explain that MySQL support has not been removed from Asterisk but
! 				that it has been moved to a different section of CVS due to licensing
! 				issues.  This might be a good section to explain them a little bit.
! 				Instructions should include how to get MySQL support put back into Asterisk
! 				plus how to setup any CDR recording as opposed to simply using CSV.  Tell
! 				them how to compile, what they will need, and common problems people face
! 				when trying to get this to work.  We may be able to mention about adding
! 				extensions and dialplans and other configuration files into MySQL, but
! 				maybe that should be a little bit later on, either in the cookbook, or
! 				in some advanced configuration sections.  This chapter is for installation,
! 				and not configuration.]
! 				</para>
  			</sect3>
  			
***************
*** 399,402 ****
--- 488,496 ----
  				<title>CAPI/ISDN</title>
  				<para>
+ 				[We should give some introduction and clean this up a bit so it flows
+ 				better in our book here]
+ 				</para>
+ 
+ 				<para>
  					The complete source code is available from Kapejod's website
  				</para>
***************
*** 467,476 ****
  			<sect3>
  				<title>Via C3 is *NOT* an i686 processor</title>
! 				<para/>
  			</sect3>
  			
  			<sect3>
  				<title>Building on a little-endian system</title>
! 				<para/>
  			</sect3>
  		</sect2>
--- 561,575 ----
  			<sect3>
  				<title>Via C3 is *NOT* an i686 processor</title>
! 				<para>
! 				[Is this really relevant, and do we need this stuff in the book?  I don't hear
! 				too many people talking about this, but perhaps I'm wrong - blitzrage]
! 				</para>
  			</sect3>
  			
  			<sect3>
  				<title>Building on a little-endian system</title>
! 				<para>
! 				[Same thing here as above, comments wise]
! 				</para>
  			</sect3>
  		</sect2>
***************
*** 481,485 ****
  		<sect2>
  			<title>Linux Kernel Loadable Modules</title>
! 			<para/>
  		</sect2>
  		
--- 580,589 ----
  		<sect2>
  			<title>Linux Kernel Loadable Modules</title>
! 			<para>
! 			[I think we have a lot of good stuff in this chapter, but things seem be in
! 			a bit of an illogical order.  Also, we seem to be saying how to load modules in
! 			other sections of this chapter.  Should they be moved to this section, or should
! 			we forget about this and just build it into the previous sections? ]
! 			</para>
  		</sect2>
  		
***************
*** 491,495 ****
  		<sect2>
  			<title>Adding zaptel modules to your startup file</title>
! 			<para/>
  		</sect2>
  	</sect1>
--- 595,606 ----
  		<sect2>
  			<title>Adding zaptel modules to your startup file</title>
! 			<para>
! 			[ This might have to be a bit distribution specific to actually be
! 			useful.  Either that, or we can leave it to the users own device to learn
! 			how to load modules at startup on their own systems.  Asterisk comes with
! 			a bunch of information for RedHat based systems, we might have to talk 
! 			about it, but we should probably not get too distribution specific or we
! 			are going to have to document the same thing multiple times... ]
! 			</para>
  		</sect2>
  	</sect1>
***************
*** 499,502 ****
--- 610,616 ----
  		<sect2>
  			<title>Manually starting Asterisk and the CLI</title>
+ 				<para>
+ 				[Lets fix this up a little bit and make things a bit more clear]
+ 				</para>
  				<literallayout>
  				To start asterisk in the background; <command>/usr/sbin/asterisk</command>
***************
*** 554,558 ****
  		<sect2>
  			<title>Linux Run-levels (the init sequence)</title>
! 			<para/>
  		</sect2>
  		
--- 668,678 ----
  		<sect2>
  			<title>Linux Run-levels (the init sequence)</title>
! 			<para>
! 			[I know with RedHat / Fedora systems that you can copy the startup script
! 			in the /usr/src/asterisk/redhat/ directory to /etc/rc.d/init.d/ and then run
! 			the chkconfig command to easily add Asterisk to your startup sequence. Maybe
! 			we can explain how to do that.  We could also explain how to do it manually
! 			by creating symlinks in the rcX.d directories ]
! 			</para>
  		</sect2>