httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From max...@apache.org
Subject svn commit: r357191 - in /httpd/site/trunk/xdocs: mod_mbox/index.xml mod_mbox/install.xml mod_mbox/ref.xml modules/index.xml
Date Fri, 16 Dec 2005 17:44:09 GMT
Author: maxime
Date: Fri Dec 16 09:44:00 2005
New Revision: 357191

URL: http://svn.apache.org/viewcvs?rev=357191&view=rev
Log:
Some mod_mbox website improvements :

  * mod_mbox/ref.xml, mod_mbox/install.xml
     Added mod_mbox documentation : setup guide and directives
reference.

  * mod_mbox/index.xml
     Typo fix. Added documentation section.

  * modules/index.xml
     Improve readability. Three 'mod_mbox' links were not very
intuitive.



Added:
    httpd/site/trunk/xdocs/mod_mbox/install.xml   (with props)
    httpd/site/trunk/xdocs/mod_mbox/ref.xml   (with props)
Modified:
    httpd/site/trunk/xdocs/mod_mbox/index.xml
    httpd/site/trunk/xdocs/modules/index.xml

Modified: httpd/site/trunk/xdocs/mod_mbox/index.xml
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/mod_mbox/index.xml?rev=357191&r1=357190&r2=357191&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/mod_mbox/index.xml (original)
+++ httpd/site/trunk/xdocs/mod_mbox/index.xml Fri Dec 16 09:44:00 2005
@@ -31,6 +31,14 @@
 </section>
 
 <section>
+  <title>Documentation</title>
+  <ul>
+    <li><a href="install.html">Installation instructions</a></li>
+    <li>Configuration directives <a href="ref.html">reference</a></li>
+  </ul>
+</section>
+
+<section>
   <title>Mailing Lists</title>
   <p>
     Discussions on mod_mbox take place on the main HTTPd development mailing
@@ -65,13 +73,13 @@
 </section>
 
 <section>
-  <title>Histroy</title>
+  <title>History</title>
   <p>
     <tt>mod_mbox</tt> was originally written by <strong>Justin
     Erenkrantz</strong> in 2001, and <strong>Paul Querna</strong> also
     worked on the module from time to time. More recently,
     <strong>Maxime Petazzoni</strong> and <strong>Russell
-    Johnson</strong> joined the "team" as a Summer Of Code
+    Johnson</strong> joined the "team" as Summer Of Code
     students. Russell implemented the full text search in
     <tt>mod_mbox</tt>, while Maxime worked on improving the module's
     user interface.

Added: httpd/site/trunk/xdocs/mod_mbox/install.xml
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/mod_mbox/install.xml?rev=357191&view=auto
==============================================================================
--- httpd/site/trunk/xdocs/mod_mbox/install.xml (added)
+++ httpd/site/trunk/xdocs/mod_mbox/install.xml Fri Dec 16 09:44:00 2005
@@ -0,0 +1,143 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<document>
+  <properties>
+    <author email="dev@httpd.apache.org">HTTPd developers</author>
+    <title>mod_mbox - Mailing list archives browser</title>
+  </properties>
+<body>
+
+<section>
+  <title>Installation instructions</title>
+  <p>
+    <tt>mod_mbox</tt> is very easy to install and setup. First, we
+    need to build the module and make the Apache HTTPd webserver load
+    it. Then, we'll setup our archives repository and complete
+    Apache's configuration.
+  </p>
+
+  <p>
+    <tt>mod_mbox</tt> has, of course, some requirements :
+  </p>
+
+  <ul>
+    <li>Apache HTTPd >= 2.0 (<tt>mod_mbox</tt> has been tested succesfully
with Apache 2.0.55, 2.2.0 and 2.3.0-dev)</li>
+    <li>APR and APR-Util >= 0.9</li>
+    <li>APR-Util with Berkeley DB 4 capability</li>
+  </ul>
+</section>
+
+<section>
+  <title>Download and build</title>
+  <p>
+    You can download a source tarball or checkout sources via Subversion :
+  </p>
+
+  <pre><code>
+    svn checkout https://svn.apache.org/repos/asf/httpd/mod_mbox/trunk mod_mbox
+  </code></pre>
+
+  <p>
+    Then, build <tt>mod_mbox</tt> :
+  </p>
+
+  <pre><code>
+    ./autogen.sh
+    ./configure --enable-experimental-libtool --with-apxs=`which apxs`
+    make clean all
+    su -c 'make install'
+  </code></pre>
+
+  <p>
+    Refer to the configure help (<tt>./configure --help</tt>) if you
+    need a to specify an installation prefix (<tt>--prefix=...</tt>)
+    or any other specific setup.
+  </p>
+</section>
+
+<section>
+  <title>Preliminary Apache setup</title>
+  <p>
+    The next step is to make Apache HTTPd load the <tt>mod_mbox</tt>
+    module at runtime :
+  </p>
+
+  <pre><code>
+    cd /etc/apache2/mods-available/
+    echo "LoadModule mbox_module /usr/lib/apache2/modules/mod_mbox.so" > mbox.load
+    cd ../mods-enabled/
+    ln -s ../mods-available/mbox.load .
+  </code></pre>
+</section>
+
+<section>
+  <title>Repository setup</title>
+  <p>
+    <tt>mod_mbox</tt> is a mail archive browser. Having mail archives
+    to browse would be a good idea. For the following steps, we'll
+    assume that you have a directory (let's call it <tt>foo</tt>) with
+    your <tt>.mbox</tt> files. Indeed, <tt>mod_mbox</tt> needs a
+    static preprocessing of the archives before being able to run. For
+    that, we'll use the tool <tt>mod-mbox-util</tt> that was compiled
+    with the module itself at build time :
+  </p>
+
+  <pre><code>
+    mod-mbox-util -v -c foo/
+  </code></pre>
+
+  <p>
+    <strong>Don't forget to run <tt>mod-mbox-util</tt> each time you
+    update your <tt>.mbox</tt> files !</strong>
+  </p>
+
+  <p>
+    If you haven't done so yet, you must move your archives to a
+    directory in your Apache's <tt>DocumentRoot</tt> (or create a
+    symbolic link to your directory in it) :
+  </p>
+
+  <pre><code>
+    mkdir -p ~www-data/archives
+    mv foo/ $_
+    cp mod_mbox/data/* $_
+    chown -R www-data:www-data $_
+  </code></pre>
+
+  <p>
+    You can host multiple mailing list archives with
+    <tt>mod_mbox</tt>, each stored in a separate directory. If you are
+    doing so, you should consider adding an index file, displaying a
+    list of all hosted archives.
+  </p>
+</section>
+
+<section>
+  <title>mod_mbox configuration</title>
+  <p>
+    The last thing you need to do in order to get your
+    <tt>mod_mbox</tt> up and running is to configure Apache so that it
+    will call <tt>mod_mbox</tt> when trying to read a <tt>.mbox</tt>
+    file. The following configuration snippet is a good start :
+  </p>
+
+  <pre><code>
+    AddHandler mbox-handler .mbox
+    &lt;LocationMatch /archives/([^/]+)&gt;
+        MboxIndex On
+        MboxRootPath "/archives/"
+        MboxStyle "/archives/style.css"
+        MboxScript "/archives/archives.js"
+        MboxHideEmpty On
+        MboxAntispam On
+    &lt;/LocationMatch&gt;
+  </code></pre>
+
+  <p>
+    Please refer to the configuration directives <a
+    href="ref.html">reference</a> for more information on these
+    directives.
+  </p>
+</section>
+
+</body>
+</document>

Propchange: httpd/site/trunk/xdocs/mod_mbox/install.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Added: httpd/site/trunk/xdocs/mod_mbox/ref.xml
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/mod_mbox/ref.xml?rev=357191&view=auto
==============================================================================
--- httpd/site/trunk/xdocs/mod_mbox/ref.xml (added)
+++ httpd/site/trunk/xdocs/mod_mbox/ref.xml Fri Dec 16 09:44:00 2005
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<document>
+  <properties>
+    <author email="dev@httpd.apache.org">HTTPd developers</author>
+    <title>mod_mbox - Mailing list archives browser</title>
+  </properties>
+<body>
+
+<section>
+  <title>Reference documentation</title>
+  <p>
+    In order to run properly, <tt>mod_mbox</tt> needs some
+    configuration. Here follows a list and description of all
+    configuration directives understood by <tt>mod_mbox</tt>.
+  </p>
+</section>
+
+<section>
+  <title>MboxIndex Directive</title>
+
+  <p>Activate <tt>mod_mbox</tt> index.</p>
+
+  <pre><code>
+    MboxIndex On|Off
+  </code></pre>
+
+  <p>
+    Setting this option to <i>On</i> will tell <tt>mod_mbox</tt>
to
+    handle directory listing. This will display a nice web page with
+    mailing list information, links to each month and the message
+    count for each mailbox.
+  </p>
+
+  <p>Default is <i>Off</i></p>
+</section>
+
+<section>
+  <title>MboxRootPath Directive</title>
+
+  <p>Set archives root directory.</p>
+
+  <pre><code>
+    MboxRootPath /archives/
+  </code></pre>
+
+  <p>
+    Specify the mail archives root directory, relative to webserver's
+    <tt>DocumentRoot</tt>. When set, <tt>mod_mbox</tt> will add
+    <i>Site Index</i> link on generated webpages, letting the user
+    fall back to the list of mailing list archives hosted on the
+    server.
+  </p>
+</section>
+
+<section>
+  <title>MboxStyle Directive</title>
+
+  <p>Set archives stylesheet file.</p>
+
+  <pre><code>
+    MboxStyle /archives/style.css
+  </code></pre>
+
+  <p>
+    When set, <tt>mod_mbox</tt> will use this stylesheet file. The
+    path is relative to the webserver's <tt>DocumentRoot</tt>. This is
+    highly recommended since the dynamic browser won't work as
+    expected without a correct stylesheet.
+  </p>
+
+  <p>
+    The ASF's default stylesheet is bundled with <tt>mod_mbox</tt>
+    sources and releases. Using it is generally a good start.
+  </p>
+</section>
+
+<section>
+  <title>MboxScript Directive</title>
+
+  <p>Set <tt>mod_mbox</tt>'s javascript file.</p>
+
+  <pre><code>
+    MboxScript /archives/archives.js
+  </code></pre>
+
+  <p>
+    When set, you will be able to use <tt>mod_mbox</tt>'s dynamic
+    browsing interface, an AJAX (Asynchronous Javascript and XML)
+    application. A working javascript file is bundled with
+    <tt>mod_mbox</tt>, don't forget to copy it if you want to use it !
+  </p>
+</section>
+
+<section>
+  <title>MboxHideEmpty Directive</title>
+
+  <p>Hide empty mailboxes from index listing.</p>
+
+  <pre><code>
+    MboxHideEmpty On|Off
+  </code></pre>
+
+  <p>
+    This directive tells <tt>mod_mbox</tt> to hide empty (with zero
+    message) mailboxes from his index listings.
+  </p>
+
+  <p>Default is <i>On</i></p>
+</section>
+
+<section>
+  <title>MboxAntispam Directive</title>
+
+  <p>Enable email obfuscation.</p>
+
+  <pre><code>
+    MboxAntispam On|Off
+  </code></pre>
+
+  <p>
+    This directive tells <tt>mod_mbox</tt> to enable a
+    content-destructive email obfuscation, thus avoiding spam to
+    mailing list users. For exemple,
+    <tt>localpart@localdomain.com</tt> will be converted to
+    <tt>localp...@localdomain.com</tt>.
+  </p>
+
+  <p>Default is <i>On</i></p>
+</section>
+
+</body>
+</document>

Propchange: httpd/site/trunk/xdocs/mod_mbox/ref.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: httpd/site/trunk/xdocs/modules/index.xml
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/modules/index.xml?rev=357191&r1=357190&r2=357191&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/modules/index.xml (original)
+++ httpd/site/trunk/xdocs/modules/index.xml Fri Dec 16 09:44:00 2005
@@ -43,11 +43,11 @@
 <section id="mod_mbox">
 <title>mod_mbox</title>
 
-<p>Do you want to setup mail archives with Apache httpd-2.0?  Try out
-mod_mbox.</p>
+<p>Do you want to setup mail archives with Apache HTTPd 2.x ?  Try out
+<tt>mod_mbox</tt>.</p>
 
 <ul>
-<li>Website: <a href="http://httpd.apache.org/mod_mbox">mod_mbox</a></li>
+<li><a href="http://httpd.apache.org/mod_mbox">Website</a></li>
 <li>Source: <a href="https://svn.apache.org/repos/asf/httpd/mod_mbox/trunk">mod_mbox</a></li>
 <li>ViewCVS: <a href="http://svn.apache.org/viewcvs.cgi/httpd/mod_mbox/">mod_mbox</a></li>
 <li>Mailing list: <a href="mailto:dev-subscribe@httpd.apache.org">dev@httpd.apache.org</a></li>



Mime
View raw message