Update of /cvsroot/mhonarc/mharc/doc
In directory subversions:/tmp/cvs-serv750/doc
Modified Files:
install.html
Log Message:
* ScriptAlias directive added in apache.conf for cgi-bin directory.
* Installation doc fixes can cleanup.
* doc_file creates a Makefile.txt in doc/file for use by documentation.
Index: install.html
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/install.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -r1.5 -r1.6
*** install.html 28 Sep 2002 05:06:31 -0000 1.5
--- install.html 29 Sep 2002 04:22:14 -0000 1.6
***************
*** 16,20 ****
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
! <td width="100%"><p>If performing an upgrade, make sure to read
<a href="../NEWS"><tt>NEWS</tt></a> document for any important release
notes.
--- 16,20 ----
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
! <td width="100%"><p>If performing an upgrade, make sure to read the
<a href="../NEWS"><tt>NEWS</tt></a> document for any important release
notes.
***************
*** 99,104 ****
</li>
<li>Experienced using any one of the myriad of text editors available
! on your system. <tt>Vi</tt> and <tt>emacs</tt> tend to be the most
! common, but some of the GUI environments provide text editors.
</p>
</li>
--- 99,104 ----
</li>
<li>Experienced using any one of the myriad of text editors available
! on your system. <tt>Vi</tt> and <tt>emacs</tt> are the most
! common, but some of the GUI environments provide additional text editors.
</p>
</li>
***************
*** 117,121 ****
<p>mharc is designed to be independent of the mailing list management
software. If changes are made to list management software, mharc
! is unaffected. It also allows a division of labor on who manages
the lists and who manages the archives. </p>
--- 117,121 ----
<p>mharc is designed to be independent of the mailing list management
software. If changes are made to list management software, mharc
! is unaffected. The design also allows a division of labor on who manages
the lists and who manages the archives. </p>
***************
*** 123,130 ****
account to perform all mharc-related duties. The account is
subscribed to all mailing lists you want archived. For example,
! say the account you will use is "<tt>mailarch</tt>" and the
mail address for the account is "<tt>mailarch(_at_)example(_dot_)com</tt>".
! For each list you want archived, you will subscribe the address
! "<tt>mailarch(_at_)example(_dot_)com</tt>" to each list. </p>
<table class="note">
--- 123,130 ----
account to perform all mharc-related duties. The account is
subscribed to all mailing lists you want archived. For example,
! say the account you use is "<tt>mailarch</tt>" and the
mail address for the account is "<tt>mailarch(_at_)example(_dot_)com</tt>".
! For each list you archive, the address
! "<tt>mailarch(_at_)example(_dot_)com</tt>" must be subscribed to each list. </p>
<table class="note">
***************
*** 150,154 ****
<p>mharc runs on any Unix-like operating system.
If using a Win32 system, you will may need to install <a
! href="http://www.cygwin.com/";>Cygwin</a>.
</p>
--- 150,155 ----
<p>mharc runs on any Unix-like operating system.
If using a Win32 system, you will may need to install <a
! href="http://www.cygwin.com/";>Cygwin</a> or equivalent software package
! providing the Unix tool set.
</p>
***************
*** 170,174 ****
<a href="http://www.procmail.org/";><http://www.procmail.org/></a>:
<p>Procmail pre-filters incoming mail into
! the raw mail archives. Note, the programs <tt>formail</tt> and
<tt>lockfile</tt> are needed and they are part of the standard
Procmail distribution, but some Unix distributions may include these
--- 171,175 ----
<a href="http://www.procmail.org/";><http://www.procmail.org/></a>:
<p>Procmail pre-filters incoming mail into
! the raw mail archives. <b>Note:</b> The programs <tt>formail</tt> and
<tt>lockfile</tt> are needed and they are part of the standard
Procmail distribution, but some Unix distributions may include these
***************
*** 181,185 ****
<p>Namazu provides searching. mharc takes advantage
of Namazu's awareness of MHonArc message pages to provide
! useful archive navigational aids. Note, the program
<tt>namazu.cgi</tt> is needed and is part of the standard
Namazu distribution, but some Unix distribtions may include it
--- 182,186 ----
<p>Namazu provides searching. mharc takes advantage
of Namazu's awareness of MHonArc message pages to provide
! useful archive navigational aids. <b>Note:</b> The program
<tt>namazu.cgi</tt> is needed and is part of the standard
Namazu distribution, but some Unix distribtions may include it
***************
*** 210,214 ****
<td><p>The <a href="#install"><tt>install.pl</tt></a> installation
script checks for programs required by mharc. If it
! cannot locate a program, it will generate a warning message.
</p>
</td></tr></table>
--- 211,215 ----
<td><p>The <a href="#install"><tt>install.pl</tt></a> installation
script checks for programs required by mharc. If it
! cannot locate a program, it generates a warning message.
</p>
</td></tr></table>
***************
*** 344,349 ****
<td><strong>NOTE:</strong></td>
<td width="100%"><p>The MHonArc version shown may
! be different than what is shown above. The version shown will be
! the version of MHonArc found on your system.
</p>
</td></tr></table>
--- 345,350 ----
<td><strong>NOTE:</strong></td>
<td width="100%"><p>The MHonArc version shown may
! be different than what is shown above. The version shown should
! reflect the version of MHonArc found on your system.
</p>
</td></tr></table>
***************
*** 408,412 ****
edit <a href="file/lists.def.txt"><tt>lib/lists.def</tt></a>.
The syntax of the file is documented in the
! <a href="bin/mk-procmailrc.html#list%20definition%20file"><tt>mk-procmailrc</tt></a>
manpage.
After editing, run the following command: </p>
--- 409,413 ----
edit <a href="file/lists.def.txt"><tt>lib/lists.def</tt></a>.
The syntax of the file is documented in the
! <a href="bin/mk-procmailrc.html#list_definition_file"><tt>mk-procmailrc</tt></a>
manpage.
After editing, run the following command: </p>
***************
*** 428,433 ****
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="crontab">Defining your <tt>crontab</tt></a></h2>
! <p>The final step is to edit the account's crontab
! in order to get automatic processing of your archives. The file
<a href="file/crontab.txt"><tt>etc/crontab</tt></a>
serves as a template of the crontab entries needed.
--- 429,434 ----
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="crontab">Defining your <tt>crontab</tt></a></h2>
! <p>To get automatic processing of your archives, you must
! edit the account's crontab. The file
<a href="file/crontab.txt"><tt>etc/crontab</tt></a>
serves as a template of the crontab entries needed.
***************
*** 482,486 ****
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
! <td width="100%"><p>This information provided in the section is specifed
to the <a href="http://httpd.apache.org/";>Apache httpd server</a>.
</p>
--- 483,487 ----
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
! <td width="100%"><p>This information provided in the section is specific
to the <a href="http://httpd.apache.org/";>Apache httpd server</a>.
</p>
***************
*** 497,502 ****
prompt> <b>make configure</b></pre></td></tr></table>
<p>to generate a new
! <tt>etc/apache.conf</tt> that can be used in your Apache server configuration
! files.
</p>
--- 498,502 ----
prompt> <b>make configure</b></pre></td></tr></table>
<p>to generate a new
! <tt>etc/apache.conf</tt> that can be used in your Apache server configuration.
</p>
***************
*** 511,515 ****
root of the installation when
<tt class="ishell"><b>make configure</b></tt>
! is done, or create a symlink to it by
executing the following command from the installation root:
</p>
--- 511,515 ----
root of the installation when
<tt class="ishell"><b>make configure</b></tt>
! is done, or even better, create a symlink to it by
executing the following command from the installation root:
</p>
***************
*** 521,526 ****
<p>Make sure Apache allows the execution of CGI
! programs denoted with the filename extension "<tt>.cgi</tt>",
! or specify that mharc's cgi-bin directory is a CGI executable directory.
</p>
--- 521,533 ----
<p>Make sure Apache allows the execution of CGI
! programs in the <a href="../cgi-bin/"><tt>cgi-bin</tt></a> directory.
! The
! <a href="file/apache.conf.txt"><tt>etc/apache.conf</tt></a>
! template should allows this via a <tt>ScriptAlias</tt> directive.
!
! <p>An alternative is to have filenames with the extension "<tt>.cgi</tt>"
! handled by the <tt>cgi-script</tt> handler as follows:
! </p>
! <pre class="code">AddHandler cgi-script .cgi</pre>
</p>
***************
*** 540,545 ****
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="maintenance">Maintenance Operations</a></h2>
! <p>Manual maintenance can be done via the Makefile provided. If you
! run the command,
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
--- 547,553 ----
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="maintenance">Maintenance Operations</a></h2>
! <p>Manual maintenance can be done via the
! <a href="file/Makefile.txt">Makefile</a>
! provided. If you run the command,
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
***************
*** 621,625 ****
<a href="file/common.mrc.txt"><tt>lib/common.mrc</tt></a>.
To make changes, edit
! <tt>lib/common.mrc.in</tt>
and run</p>
<table border=1 width="100%"><tr><td><pre class="shell">
--- 629,633 ----
<a href="file/common.mrc.txt"><tt>lib/common.mrc</tt></a>.
To make changes, edit
! <b><tt>lib/common.mrc.in</tt></b>
and run</p>
<table border=1 width="100%"><tr><td><pre class="shell">
***************
*** 762,773 ****
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="listsadmin">Managing List Administration Messages</a></h2>
! <p>Most mailing list management software sends out administration message
! users. Examples are subscribe confirmations and subscribe reminders.
! This could be a potential problem since there is a risk that such messages
! could show up in the regular archives, exposing sensitive information like
! subscription passwords.
! </p>
! <p>Two possible solution to this problem are provided:
</p>
--- 770,780 ----
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="listsadmin">Managing List Administration Messages</a></h2>
! <p>Most mailing list management software send out administration
! message to subscribers. Examples are subscribe confirmations and
! subscribed reminders. A risk exists that these messages can
! show up in public archives, exposing sensitive information like
! subscription passwords. </p>
! <p>Two possible solution to the problem are provided:
</p>
***************
*** 789,793 ****
<p>This method is better than the
<a href="#mharclistsadmin">mharc-based solution</a> since it eliminates
! the need to poll the archive for any messages. It is more secure
since any list administration messages are never in a web accessible
location.
--- 796,800 ----
<p>This method is better than the
<a href="#mharclistsadmin">mharc-based solution</a> since it eliminates
! the need to poll the archive for any messages and is more secure
since any list administration messages are never in a web accessible
location.
***************
*** 817,827 ****
<p>Since <tt class="icode">.listsadmin</tt> starts with a dot, it will
be hidden from the all-archives list. But since it is possible to for
! someone to backdoor to it manually, it is best to restrict access to
it via HTTP server configuration (remember to restrict both the raw
and html archives). </p>
<p>Now, all you have to do is check the <tt class="icode">.listsadmin</tt>
! occasionally to see if anything important has been received, like
! subscription confirmations that need to be responded to. </p>
--- 824,834 ----
<p>Since <tt class="icode">.listsadmin</tt> starts with a dot, it will
be hidden from the all-archives list. But since it is possible to for
! someone to access it directly, it is best to restrict access to
it via HTTP server configuration (remember to restrict both the raw
and html archives). </p>
<p>Now, all you have to do is check the <tt class="icode">.listsadmin</tt>
! occasionally to see if anything important has been received.
! </p>
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV