ML-WEB-ARCHIVER(1) Linux User Manuals ML-WEB-ARCHIVER(1)

ml-web-archiver - A simple Web archive tool for email lists.

ml-web-archiver [-v|--version] [-h|--help] [-h|--help] [-f|--full] [-l|--list listaddress]

ml-web-archiver is an unsophisticated Web archiver for email lists, it understands MLMMJ archives, as well as Maildir and mbox mailboxes.

-V, --version

Shows ml-web-archiver version on standard output and exits.

-h, --help

Shows brief help and exits.

-f, --full

Processes the entire archive from beginning to end. Without this option, it only processes messages that have not already been processed. This option is only valid when a list name, input path, and output path have also been specified. Lists for which there are no existing archives will always be processed from beginning to end.

-l listaddress, --list listaddress

Email address of a specific list to process

-v, --verbose

Emits some informational messages to STDOUT while running.

-l, --list

The list's email address.

ml-web-archiver is configured in /etc/ml-web-archiver/ml-web-archiver.conf.php The are are two settings at this time.

•$syslog which turns on logging to syslog.
•$verbose which turns on informational messages while processing.

As this is a PHP script file, you must have an opening PHP tag at the top:

<?php
$syslog = TRUE;
$verbose = TRUE;

ml-web-archiver can be configured to process a list of mailing lists, by creating /etc/ml-web-archiver/lists and adding the lists in the following INI format:

[mlmmj-test@lists.example.com]
description = MLMMJ Test List
input = /var/spool/mlmmj/lists.example.com/mlmmj-test/archive
archiveurl = https://lists.example.com/archives/mlmmj-test
output = /var/www/ron/lists.example.com/www/archives/mlmmj-test
listurl = https://lists.example.com/mlmmj-test
searchurl = https://lists.example.com/search

listurl is optional, and should point to a page about the list, where perhaps a user can subscribe and/or unsubscribe.

searchurl is optional, and enables the message searching functionality. The search.php script should be aliased, otherwise it should be copied or symlinked to the filesystem path that corresponds to searchurl

Blank lines and lines where the first non-whitespace character is a ; character are comment lines and will be ignored.

When ml-web-archiver is run without any options, it reads the file /etc/ml-web-archiver/lists and processes all lists contained in that file.

With the option: --list listaddress
Only the given list is processed.

List processing always begins with the first unprocessed message when using the lists file, or when the --full option has not been given.

ml-web-archiver needs permission to read the email archives, and permission to write to the output directory.

Ron Guerin <ron@vnetworx.net>
bugs/patches can be submitted by email.

2025-11-22 November 2025