Date: Wed Mar 6 04:36:43 CET 2002
User: Dan Kalowsky
Directory: srmdoc/admin
Log Message:
[2.97]
- Updates update updates...
Modified files:
srmdoc/admin/compiling.xml (version: 1.3)
srmdoc/admin/installation.xml (version: 1.6)
srmdoc/admin/settings.xml (version: 1.6)
[FILE: /srmdoc/admin/compiling.xml]
--- srmdoc/admin/compiling.xml:1.2 Tue Mar 05 20:31:22 2002 GMT
+++ srmdoc/admin/compiling.xml Wed Mar 06 02:36:42 2002 GMT
@@ -3,12 +3,9 @@
<chapter id="admin.compiling">
<title>Compiling</title>
<para>
- This section of the manual is designed to help you with compiling
- 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
+ This section of the manual is designed to help you with building the
+ Vulcan-Logic SRM. While using this document it is assumed that you have
+ compiled PHP and Apache before, and that this is not your first installation
of a software program on a Unix/Linux system.
</para>
@@ -19,12 +16,12 @@
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).
+ PHP</ulink> (after March 1st, 2002). As of PHP version 4.2, SRM
+ capabilities will be incorporated in the release versions of PHP.
</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:
+ After downloading the appropriate version of PHP, two more files are
+ required from the SRM download site:
<itemizedlist>
<listitem>
<para>srm-0.6.0.tar.gz</para>
@@ -33,8 +30,8 @@
<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:
+ From this point the directory listing of
+ <literal>/home/user/install</literal> should look like this:
</para>
<para>
<programlisting role="shell">
@@ -57,7 +54,7 @@
</programlisting>
</para>
<para>
- Now all files are unpacked you are ready to begin to configure and compile
+ Now all files are unpacked and are ready to begin to configure and compile
SRM and PHP.
</para>
</section>
@@ -67,10 +64,10 @@
<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.
+ running machine. It is necessary to compile PHP twice to have a fully
+ working system. Both an <link linkend='admin.compile.srmmodule'>
+ SRM module</link> and an <link linkend='admin.compile.apache'>Apache</link>
+ (or other webserver) module using the SRM extension are required.
</para>
<section id="admin.compile.srm">
@@ -81,48 +78,34 @@
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:
+ For this example we use the following configure line:
</para>
<para>
<programlisting role="shell">
- ./configure --prefix=/opt/srm --enable-auth
+ ./configure --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>.
+ Please remember that <literal>--prefix</literal> additions here will also
+ need to be manually entered into the srm.ini file once installation is
+ finished.
</para>
<para>
- After you ran configure, it is posisble to make and install SRM by doing:
+ After running configure, it is posisble to make SRM by doing:
</para>
<para>
<programlisting role="shell">
- make
- make install
+ % make
</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:
+ If using a cvs checkout of PHP, the first step is to recreate the PHP
+ configure file. Change into the <literal>php4</literal> directory, remove
+ the existing configure script, and run buildconf like so:
</para>
<para>
<programlisting role="shell">
@@ -130,7 +113,8 @@
</programlisting>
</para>
<para>
- It is now possible configure PHP with a clean configure script. To
+ If using a release version of PHP this step will not be necessary. 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>
@@ -154,9 +138,8 @@
<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:
+ If not already there, change to the PHP source directory, and configure
+ PHP as necessary. This example uses just the essentials srm needs to run:
</para>
<para>
<programlisting role="shell">
@@ -164,16 +147,16 @@
</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
+ You also might want to add <literal>--disable-cli</literal> to the
+ configure line, as 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
+ Now the PHP module for SRM is ready to be built. 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).
+ <literal>/usr/local/srm/lib</literal> directory, or in the
+ <literal>/lib</literal> directory of the install prefix that was specified
+ at configure time.
</para>
<para>
<programlisting role="shell">
@@ -183,20 +166,21 @@
</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.
+ for SRM should be in the proper place. It is now possible to start the
+ SRM Daemon by running the command <literal>/usr/local/srm/bin/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>
+ <title>Compiling the Apache module with the SRM extensions</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>.
+ Compiling PHP with the SRM extension is not difficult. Using any normal
+ mixture of configure options for PHP, add the <literal>--with-srm[=DIR]
+ </literal> option. Replacing the [DIR] with the path to the prefix that
+ was set in the configure options to SRM. In this example the path is
+ <literal>--with-srm=/usr/local/srm</literal>.
</para>
</section>
@@ -205,7 +189,8 @@
<section id="admin.configure">
<title>Configure options for SRM</title>
<para>
- This section lists all available options to <literal>configure</literal>.
+ This section lists all the available options to
+ <literal>configure</literal>.
</para>
<section id="admin.configure.general">
@@ -251,13 +236,12 @@
<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.
+ view statistical data about the daemon, and in the future to tune
+ specific options. At the moment the <link
+ linkend="user.module.http">http module</link> is experimental and is
+ not available in release. If you want to test the http module you will
+ need a CVS version of SRM. This makes it possible to authenticate a
+ session with a password file.
</para>
</listitem>
</varlistentry>
@@ -270,10 +254,10 @@
<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
+ stored as 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
+ is not available in release. If you want to test the http module you
+ need a CVS version of SRM. This makes it possible to authenticate a
session with a password file.
</para>
</listitem>
@@ -285,9 +269,9 @@
</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
+ This module enables the use of challenge-response based authentication,
+ but requires 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>
@@ -301,7 +285,7 @@
<listitem>
<para>
This parameter points the configure script to the base location of
- your OpenSSL installation. This parameter should be used in
+ the local 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
@@ -326,7 +310,8 @@
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.
+ differently and the logging is for more extensive. It also allows
+ for more information during a crash to be given to developers.
</para>
</listitem>
</varlistentry>
[FILE: /srmdoc/admin/installation.xml]
--- srmdoc/admin/installation.xml:1.5 Tue Mar 05 20:31:22 2002 GMT
+++ srmdoc/admin/installation.xml Wed Mar 06 02:36:42 2002 GMT
@@ -28,7 +28,7 @@
</para>
<section id="admin.srm-binary">
- <title>Binary Home On The Range</title>
+ <title>Binary Relocation</title>
<para>
Under the UNIX environment, the <link linkend="admin.configure">configure
script</link> ran at the beginning of this process defines the final
@@ -51,7 +51,7 @@
</section>
<section id="admin.srm-ini">
- <title>The srm.ini</title>
+ <title>The srm.ini locations</title>
<para>
The <literal>srm.ini</literal> is the file used by the SRM system, to
allow configuration changes to the daemon. For example, you can use it to
@@ -97,7 +97,7 @@
<listitem>
<para>
This argument will cause the daemon to display a short description and
- list of all the arguments it is capable of using. The daemon will
+ list of all the arguments srmd is capable of accepting. The daemon will
cease execution once it has finished displaying this information.
</para>
</listitem>
@@ -130,7 +130,7 @@
</section>
<section id="admin.bootstrap">
- <title>Ground Control To Major Tom</title>
+ <title>Starting the SRM daemon at boot time</title>
<para>
The process of having the SRM daemon run at bootstrap is dependent upon the
host machines operating system. Note that the paths may be different on a
[FILE: /srmdoc/admin/settings.xml]
--- srmdoc/admin/settings.xml:1.5 Tue Mar 05 17:18:37 2002 GMT
+++ srmdoc/admin/settings.xml Wed Mar 06 02:36:42 2002 GMT
@@ -37,16 +37,16 @@
</para>
<para>
- The <literal>load</literal> keyword tells SRM to attempt to load the
+ The <literal>load</literal> keyword inform SRM to attempt loading the
specified module into the daemon. If the module cannot be loaded, a
- message is displayed to either screen or logfile. This keyword is only
- valid in the module section of the ini file.
+ message is displayed to either the screen or the logfile. This keyword is
+ only valid in the module section of the ini file.
</para>
<para>
- The second section of the ini file is <emphasis>srm</emphasis> specific
- settings. This controls various settings for the SRM daemon, like which tcp
- port to use and where the logfile is located.
+ The second section of the ini file are <emphasis>srm</emphasis> specific
+ settings. These settings control various aspects of the SRM daemon, like
+ which tcp port to use and where the logfile is located.
</para>
<para>
@@ -67,12 +67,13 @@
an AF_UNIX socket.
</para>
- <para>The socket is configurable with the <literal>sockname</literal>
- directive and defaults to <literal>/tmp/srm.socket</literal>.
+ <para>
+ The socket is configurable with the <literal>sockname</literal> directive
+ and defaults to <literal>/tmp/srm.socket</literal>.
</para>
<para>
The <literal>log_level</literal> directive controls what types of notices,
- warnings and errors must be dumped to the error log. The value for the
+ warnings, and errors will be dumped to the error log. The value for the
logging level is a number between 0 and 100. The higher the number, the
more message are shown. The default and recommended level is 30. The
<literal>log_level</literal> values are shown here:
@@ -147,15 +148,18 @@
</table>
</para>
<para>
- The location of the logfile can be specified with the
- <literal>log_file</literal> directive.
+ The <literal>log_file</literal> directive specifies the location of the
+ logfile within the local file system.
+ </para>
+
+ <para>
+ The third section is the <literal>store</literal> section, which is used to
+ define the size of various internal memory structures for SRM. Typically
+ there is no reason to change these values, as they are optimized for upto
+ 5,000 different application variables.
</para>
<para>
- The third section is the store section, which is used to define the size of
- various internal memory structures for SRM. Typically there should be no
- reason to change these values, as they are optimized for upto 5,000
- different application variables.
<programlisting>
store {
applications_items = 2048;
@@ -174,6 +178,10 @@
SRM needs to be shutdown.
</para>
<para>
+ The <literal>banana</literal> section dictates the various behaviors for
+ <literal>banana</literal> functionality to exist.
+ </para>
+ <para>
<programlisting>
banana {
class_path = "/opt/srm/banana";
@@ -181,9 +189,8 @@
</programlisting>
</para>
<para>
- The <literal>class_path</literal> directive in the
- <literal>banana</literal> section of the configuration file specify where
- the Banana class loader tries to find the Banana classes from.
+ The <literal>class_path</literal> directive specifies where the Banana
+ class loader tries to find the Banana classes from.
</para>
</section>
@@ -198,6 +205,8 @@
<section id="admin.ini-settings.http">
<title>HTTP Module</title>
<para>
+ The HTTP module at this time is not complete, but can be still be
+ configured for operation.
<programlisting>
http {
port = 7780;
@@ -205,8 +214,8 @@
</programlisting>
</para>
<para>
- Although the current HTTP module is totally useless, you can configure the
- port it listens on for HTTP connections with the <literal>port</literal>
+ The <literal>port</literal> directive informs the http module which
+ port it listens for HTTP connections on.
directive.
</para>
</section>
@@ -231,7 +240,7 @@
</para>
<para>
The <literal>login_timeout</literal> value sets the amount of time, in
- seconds, for which responses to a challenge will not be accepted. After
+ seconds, for which a response to a challenge will be accepted. After
this timeout a new challenge must be requested.
</para>
<para>
Received on Wed Mar 6 04:38:20 2002
This archive was generated by hypermail 2.1.8 : Tue Jan 06 2009 - 05:00:03 CET