[srm-cvs] CVS Update: - Merge HOWTO into installation documentation

Date: Sun Mar 3 17:38:45 CET 2002
User: Derick Rethans
Directory: srmdoc/admin

Log Message:
 [1.00]
 - Merge HOWTO into installation documentation
 
Modified files:
           srmdoc/admin/installation.xml (version: 1.3)

[FILE: /srmdoc/admin/installation.xml]

--- srmdoc/admin/installation.xml:1.2 Tue Feb 05 09:34:38 2002 GMT
+++ srmdoc/admin/installation.xml Sun Mar 03 15:38:44 2002 GMT
@@ -1,19 +1,359 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.85 $ -->
 <chapter id="admin.installation">
  <title>Installation</title>
  <para>
- This is a dummy document for the introduction to the vlsrm platform appendix
+ This section of the manual is designed to help you with installing
+ Vulcan-Logic SRM. To show better examples, the configuration used in this
+ installation chapter is not identical to the default SRM configuration.
+ There will be a note where there is a deviation from the default
+ configuration. While using this document it is assumed that you have
+ compiled PHP and Apache before, and tha this is not your first installation
+ of a software program on a Unix/Linux system.
  </para>
 
- <section id="admin.compilation">
- <title>Compilation</title>
+ <section id="admin.files">
+ <title>Files</title>
   <para>
+ This example uses a very basic install of PHP and SRM, requiring only the
+ two files distributed from the <ulink
+ url="http://www.vl-srm.net/download.php">download site</ulink> and the
+ latest <ulink url="http://www.php.net/anoncvs.php">CVS version of
+ PHP</ulink> (after March 1st, 2002).
+ </para>
+ <para>
+ After you downloaded the latest CVS version of PHP (we asume you did this
+ in <literal>/home/user/install</literal>) you need to dowload the following
+ files from the SRM download site:
+ <itemizedlist>
+ <listitem>
+ <para>srm-0.6.0.tar.gz</para>
+ </listitem>
+ <listitem>
+ <para>srm-php-0.6.0.tar.gz</para>
+ </listitem>
+ </itemizedlist>
+ At this moment the directory listing of
+ <literal>/home/user/install</literal> looks like this:
+ </para>
+ <para>
+ <programlisting role="shell">
+ $ ls
+ php4/
+ srm-0.6.0.tar.gz
+ srm-php-0.6.0.tar.gz
+ </programlisting>
+ </para>
+ <para>
+ The tar.gz files need to be extracted in the following way:
+ </para>
+ <para>
+ <programlisting role="shell">
+ $ tar -xzf srm-0.6.0.tar.gz
+ $ mv srm-php-0.6.0.tar.gz php4
+ $ cd php4
+ $ tar -xzf srm-php-0.6.0.tar.gz
+ $ cd ..
+ </programlisting>
+ </para>
+ <para>
+ Now all files are unpacked you are ready to begin to configure and compile
+ SRM and PHP.
   </para>
  </section>
 
- <section id="admin.configuration">
- <title>Configuration</title>
+ <section id="admin.compile">
+ <title>Compiling</title>
   <para>
+ This section discusses all the steps needed to <link
+ linkend='admin.compile.srm'>compile SRM</link>, and PHP as a
+ running machine. You need to compile PHP twice to have a fully working
+ system. You need both an <link linkend='admin.compile.srmmodule'>SRM
+ module</link> and <link linkend='admin.compile.apache'>Apache</link> (or
+ other webserver) module which uses the SRM extension.
   </para>
+
+ <section id="admin.compile.srm">
+ <title>Compiling SRM</title>
+ <para>
+ First change to the SRM source directory (in our example: <literal>cd
+ /home/user/install/srm</literal>), then select the configure
+ options you want to compile. The full list with options to
+ <literal>configure</literal> can be found <link
+ linkend="admin.configure">here</link>.
+ In this example we use the following configure line:
+ </para>
+ <para>
+ <programlisting role="shell">
+ ./configure --prefix=/opt/srm --enable-auth
+ </programlisting>
+ </para>
+ <para>
+ Please remember that <literal>/opt/srm</literal> is not the default path
+ for SRM, the default path is <literal>/usr/local/srm</literal>.
+ </para>
+ <para>
+ After you ran configure, it is posisble to make and install SRM by doing:
+ </para>
+ <para>
+ <programlisting role="shell">
+ make
+ make install
+ </programlisting>
+ </para>
+ <para>
+ After SRM is compiled and installed, you need to copy
+ <literal>srm.ini</literal> to the <literal>/etc</literal> directory and
+ adjust the paths in this file to reflect the different install path
+ (<literal>/opt/srm</literal> in our example). For information on how to
+ configure SRM, see the section in this manual on <link
+ linkend="admin.ini-settings">configuring SRM</link>.
+ </para>
+ <para>
+ If you want to testdrive SRM at this point, comment the
+ <literal>php4</literal>
+ module out. You will re-enable this module later if you want to use
+ <classname>Bananas</classname>.
+ </para>
+ </section>
+
+ <section id="admin.compile.php">
+ <title>Compiling the PHP module for SRM</title>
+ <para>
+ First you should recreate the PHP configure file. Change into
+ the <literal>php4</literal> directory, remove the existing configure
+ script, and run buildconf:
+ </para>
+ <para>
+ <programlisting role="shell">
+ cd php4; rm -f configure; ./buildconf
+ </programlisting>
+ </para>
+ <para>
+ It is now possible configure PHP with a clean configure script. To
+ find out what options are needed for compiling with SRM, type:
+ </para>
+ <para>
+ <programlisting role="shell">
+ ./configure --help | grep srm
+ </programlisting>
+ </para>
+ <para>
+ If the lines below are shown everything is fine, otherwise have a look
+ at the <link linkend="admin.trouble">troubleshooting</link>
+ section of this file.
+ </para>
+ <para>
+ <programlisting role="shell">
+ --with-srm-sapi[=DIR] Include SRM-SAPI support
+ --with-srm[=DIR] Include SRM: Script Running Magic
+ (http://www.vl-srm.net/) support
+ </programlisting>
+ </para>
+
+ <section id="admin.compile.srmmodule">
+ <title>Compiling the PHP module for SRM</title>
+ <para>
+ First change to the PHP source directory (you should be already here),
+ and configure PHP as necessary. This example uses just the essentials
+ srm needs to run:
+ </para>
+ <para>
+ <programlisting role="shell">
+ ./configure --with-srm-sapi=/srm --with-srm=/srm
+ </programlisting>
+ </para>
+ <para>
+ You also might want to add <literal>--disable-cli</literal> to your
+ configure line, because compiling a CLI version with the module does not
+ make much sense.
+ </para>
+ <para>
+ Now the PHP module for SRM is ready to be compiled. The following lines
+ will compile the PHP module for SRM and place the module in the
+ <literal>/opt/srm/lib</literal> directory, or in the
+ <literal>/lib</literal> directory of the install prefix that you
+ specified (with <literal>/usr/local/srm/lib</literal> being the default).
+ </para>
+ <para>
+ <programlisting role="shell">
+ make
+ make install
+ </programlisting>
+ </para>
+ <para>
+ After the <literal>make install</literal> is completed, the PHP module
+ for SRM should be in the proper place. Now you may start the SRM Daemon by
+ running the command <literal>/opt/srm/sbin/srmd</literal> (see the
+ section on <link linkend="admin.commandline">command line</link> options.
+ </para>
+ </section>
+
+ <section id="admin.compile.apache">
+ <title>Compiling the apache module with the SRM extension</title>
+ <para>
+ Compiling PHP with SRM extension is not any more difficult. Just use your
+ normal configure options to PHP, but add the
+ <literal>--with-srm[=DIR]</literal> option. Replace [DIR] with the path
+ to which the prefix was set in the configure options to SRM. In our
+ example this is <literal>--with-srm=/opt/srm</literal>.
+ </para>
+ </section>
+
+ </section>
+
+ <section id="admin.configure">
+ <title>Configure options for SRM</title>
+ <para>
+ This section lists all available options to <literal>configure</literal>.
+ </para>
+
+ <section id="admin.configure.general">
+ <title>General configure options</title>
+ <para>
+ <variablelist>
+ <varlistentry id="admin.compile.configure-prefix">
+ <term>
+ <parameter>--prefix</parameter>
+ </term>
+ <listitem>
+ <para>
+ The install path of SRM. This defaults to
+ <literal>/usr/local/srm</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+
+ <section id="admin.configure.modules">
+ <title>Configure options for modules</title>
+ <para>
+ <variablelist>
+ <varlistentry id="admin.compile.configure-enable-auth">
+ <term>
+ <parameter>--enable-auth</parameter>
+ </term>
+ <listitem>
+ <para>
+ This enables the <link linkend="user.module.auth">auth</link> module
+ which makes it possible to authenticate a session with a password
+ file.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="admin.compile.configure-enable-http">
+ <term>
+ <parameter>--enable-http</parameter>
+ </term>
+ <listitem>
+ <para>
+ The <link linkend="user.module.http">http module</link> can be used to
+ view statistical data about the Daemon and in the future to tune
+ specific options. At this moment the <link
+ linkend="user.module.http">http module</link> is experimental and not
+ available in release. If you want to test the http module you need a
+ CVS version of SRM. which makes it possible to authenticate a session
+ with a password
+ file.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="admin.compile.configure-enable-mhttp">
+ <term>
+ <parameter>--enable-mhttp</parameter>
+ </term>
+ <listitem>
+ <para>
+ The <link linkend="user.module.mhttp">mhttp module</link> implements
+ a simple multi threaded http server which is able to access data
+ stored in application level variables. At this moment the <link
+ linkend="user.module.mhttp">mhttp module</link> is experimental and
+ not available in release. If you want to test the http module you need
+ a CVS version of SRM. which makes it possible to authenticate a
+ session with a password file.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="admin.compile.configure-enable-smxs">
+ <term>
+ <parameter>--enable-smxs</parameter>
+ </term>
+ <listitem>
+ <para>
+ If you want to use challenge-response based authentication you need
+ the <link linkend="user.module.smxs">Secure Media XS module</link>.
+ This module will be merged into the <link
+ linkend="user.module.auth">auth module</link> and is currently not
+ available from either releases or CVS.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="admin.compile.configure-with-ssl-dir">
+ <term>
+ <parameter>--with-ssl-dir[=DIR]</parameter>
+ </term>
+ <listitem>
+ <para>
+ This parameter points the configure script to the base location of
+ your OpenSSL installation. This parameter should be used in
+ combination with the <link
+ linkend="admin.compile.configure-enable-auth">auth</link> or <link
+ linkend="admin.compile.configure-enable-smxs">smxs</link> modules. It
+ defaults to <literal>/usr/local</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+
+ <section id="admin.configure.debug">
+ <title>Debugging related options</title>
+ <para>
+ <variablelist>
+ <varlistentry id="admin.compile.configure-enable-debug">
+ <term>
+ <parameter>--enable-debug</parameter>
+ </term>
+ <listitem>
+ <para>
+ The <literal>--enable-debug</literal> configuration parameter compiles
+ SRM in debug mode. In debug mode some <link
+ linkend="admin.commandline">command line</link> parameters behave
+ differently and the logging is for more extensive.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="admin.compile.configure-enable-dmalloc">
+ <term>
+ <parameter>--enable-dmalloc</parameter>
+ </term>
+ <listitem>
+ <para>
+ This module makes the SRM Daemon link with the dmalloc memory
+ allocation library for easier debugging of memory leaks.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </para>
+ </section>
+ </section>
+
  </section>
 
 </chapter>
+<!-- keep this comment at the end of the file
+vim600: syn=xml fen fdm=syntax fdl=4 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Received on Sun Mar 3 17:39:59 2002