1
GOTMARC -- A web archive for the Game of Trees mailing list
2
===========================================================
3

4
A collection of scripts to generate a static mail archive from a
5
Maildir; intended to provide a public web interface for the Game of
6
Trees mailing list.
7

8
The only dependency outside base is mblaze.
9

10

11
How it works
12
------------
13

14
The makefile uses mlist(1) to gather all the mail of the mailing list,
15
mthread(1) for threading and mscan(1) for parsing.
16

17
Then, three custom scripts are called:
18

19
 - mexp: creates a separate HTML page for each mail, as well as the
20
   raw message/body parts and the attachments.  It's the heaviest part
21
   of the pipeline.  If a message appears to have already been exported,
22
   it will be skipped to save some time.
23

24
 - pe: (parallelized export) since mexp is slow, attemps to run N mexp
25
   processes in parallel and dispatch threads to them.
26

27
 - mkindex: generates the index and threads page.
28

29

30
Usage
31
-----
32

33
	$ make MDIR=/path/to/got/maildir
34

35
will create and populate a `/var/www/marc' directory with the HTML
36
files.  Pass OUTDIR to override the destination directory.  MDIR
37
defaults to ~/Mail/gameoftrees.
38

39
There's some basic support for parallelizing the export, although it's
40
disabled by default.  Tweak MAKE_JOBS for `pe' to use multiple jobs.
41

42
Every once in a while, the maildir should be synced (with mbsync for
43
example) and `make' re-run to update the archive.  gotmarc does
44
incremental updates to some extent so except for the first run, which
45
will take a while, updating the archive should be fast.
46

47
For use with httpd' `gzip-static' (or similar)
48

49
	$ make gzip
50

51
will recursively compress every file in OUTDIR, leaving the original
52
file intact.
53

54

55
License
56
-------
57

58
As far as I'm concerned, gotmarc (i.e. all the code in this
59
repository) is in the public domain.