Documentation

- Histroy + History

mod_mbox was originally written by Justin Erenkrantz in 2001, and Paul Querna also worked on the module from time to time. More recently, Maxime Petazzoni and Russell - Johnson joined the "team" as a Summer Of Code + Johnson joined the "team" as Summer Of Code students. Russell implemented the full text search in mod_mbox, 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 @@ + + + + HTTPd developers + mod_mbox - Mailing list archives browser + + + +

+ Installation instructions +

+ mod_mbox 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. +

+ +

+ mod_mbox has, of course, some requirements : +

+ +

Apache HTTPd >= 2.0 (mod_mbox has been tested succesfully with Apache 2.0.55, 2.2.0 and 2.3.0-dev)
APR and APR-Util >= 0.9
APR-Util with Berkeley DB 4 capability

+ +

+ Download and build +

+ You can download a source tarball or checkout sources via Subversion : +

+ +


+    svn checkout https://svn.apache.org/repos/asf/httpd/mod_mbox/trunk mod_mbox
+

+ +

+ Then, build mod_mbox : +

+ +


+    ./autogen.sh
+    ./configure --enable-experimental-libtool --with-apxs=`which apxs`
+    make clean all
+    su -c 'make install'
+

+ +

+ Refer to the configure help (./configure --help) if you + need a to specify an installation prefix (--prefix=...) + or any other specific setup. +

+ +

+ Preliminary Apache setup +

+ The next step is to make Apache HTTPd load the mod_mbox + module at runtime : +

+ +


+    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 .
+

+ +

+ Repository setup +

+ mod_mbox 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 foo) with + your .mbox files. Indeed, mod_mbox needs a + static preprocessing of the archives before being able to run. For + that, we'll use the tool mod-mbox-util that was compiled + with the module itself at build time : +

+ +


+    mod-mbox-util -v -c foo/
+

+ +

+ Don't forget to run mod-mbox-util each time you + update your .mbox files ! +

+ +

+ If you haven't done so yet, you must move your archives to a + directory in your Apache's DocumentRoot (or create a + symbolic link to your directory in it) : +

+ +


+    mkdir -p ~www-data/archives
+    mv foo/ $_
+    cp mod_mbox/data/* $_
+    chown -R www-data:www-data $_
+

+ +

+ You can host multiple mailing list archives with + mod_mbox, 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. +

+ +

+ mod_mbox configuration +

+ The last thing you need to do in order to get your + mod_mbox up and running is to configure Apache so that it + will call mod_mbox when trying to read a .mbox + file. The following configuration snippet is a good start : +

+ +


+    AddHandler mbox-handler .mbox
+    <LocationMatch /archives/([^/]+)>
+        MboxIndex On
+        MboxRootPath "/archives/"
+        MboxStyle "/archives/style.css"
+        MboxScript "/archives/archives.js"
+        MboxHideEmpty On
+        MboxAntispam On
+    </LocationMatch>
+

+ +

+ Please refer to the configuration directives reference for more information on these + directives. +

+ + + 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 @@ + + + + HTTPd developers + mod_mbox - Mailing list archives browser + + + +

+ Reference documentation +

+ In order to run properly, mod_mbox needs some + configuration. Here follows a list and description of all + configuration directives understood by mod_mbox. +

+ +

+ MboxIndex Directive + +

Activate mod_mbox index.

+ +


+    MboxIndex On|Off
+

+ +

+ Setting this option to On will tell mod_mbox 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. +

+ +

Default is Off

+ +

+ MboxRootPath Directive + +

Set archives root directory.

+ +


+    MboxRootPath /archives/
+

+ +

+ Specify the mail archives root directory, relative to webserver's + DocumentRoot. When set, mod_mbox will add + Site Index link on generated webpages, letting the user + fall back to the list of mailing list archives hosted on the + server. +

+ +

+ MboxStyle Directive + +

Set archives stylesheet file.

+ +


+    MboxStyle /archives/style.css
+

+ +

+ When set, mod_mbox will use this stylesheet file. The + path is relative to the webserver's DocumentRoot. This is + highly recommended since the dynamic browser won't work as + expected without a correct stylesheet. +

+ +

+ The ASF's default stylesheet is bundled with mod_mbox + sources and releases. Using it is generally a good start. +

+ +

+ MboxScript Directive + +

Set mod_mbox's javascript file.

+ +


+    MboxScript /archives/archives.js
+

+ +

+ When set, you will be able to use mod_mbox's dynamic + browsing interface, an AJAX (Asynchronous Javascript and XML) + application. A working javascript file is bundled with + mod_mbox, don't forget to copy it if you want to use it ! +

+ +

+ MboxHideEmpty Directive + +

Hide empty mailboxes from index listing.

+ +


+    MboxHideEmpty On|Off
+

+ +

+ This directive tells mod_mbox to hide empty (with zero + message) mailboxes from his index listings. +

+ +

Default is On

+ +

+ MboxAntispam Directive + +

Enable email obfuscation.

+ +


+    MboxAntispam On|Off
+

+ +

+ This directive tells mod_mbox to enable a + content-destructive email obfuscation, thus avoiding spam to + mailing list users. For exemple, + localpart@localdomain.com will be converted to + localp...@localdomain.com. +

+ +

Default is On

+ + + 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 @@

mod_mbox -

Do you want to setup mail archives with Apache httpd-2.0? Try out -mod_mbox.

Do you want to setup mail archives with Apache HTTPd 2.x ? Try out +mod_mbox.

Website: mod_mbox
Website
Source: mod_mbox
ViewCVS: mod_mbox
Mailing list: dev@httpd.apache.org