1 b2508be5 2022-08-24 op GOTMARC -- because $POPULAR_ARCHIVE hates us!
2 b2508be5 2022-08-24 op =============================================
4 b2508be5 2022-08-24 op A collection of scripts to generate a static mail archive from a
5 b2508be5 2022-08-24 op Maildir; intended to provide a public web interface for the Game of
6 b2508be5 2022-08-24 op Trees mailing list.
8 b2508be5 2022-08-24 op The dependencies are:
11 b2508be5 2022-08-24 op - imagemagick (to resize the got logo)
17 7067473a 2022-08-24 op The makefile uses mlist(1) to gather all the mail of the mailing list,
18 7067473a 2022-08-24 op mthread(1) for threading and mscan(1) for parsing.
20 57784939 2022-08-25 op Then, three custom scripts are called::
22 b2508be5 2022-08-24 op - mexp: creates a separate HTML page for each mail, as well as the
23 7067473a 2022-08-24 op raw message/body parts and the attachments. It's the heaviest part
24 7067473a 2022-08-24 op of the pipeline. If a message appears to have already been exported,
25 7067473a 2022-08-24 op it will be skipped to save some time.
27 57784939 2022-08-25 op - pe: (parallelized export) since mexp is slow, attemps to run N mexp
28 57784939 2022-08-25 op processes in parallel and dispatch threads to them.
30 b2508be5 2022-08-24 op - mkindex: generates the index and threads page.
36 b2508be5 2022-08-24 op $ make MDIR=/path/to/got/maildir
38 b2508be5 2022-08-24 op will create and populate a `www' directory with the HTML files. Pass
39 b2508be5 2022-08-24 op OUTDIR to override the destination directory.
41 5f54ec1a 2022-08-24 op Every once in a while, the maildir should be synced (with mbsync for
42 5f54ec1a 2022-08-24 op example) and `make' re-run to update the archive. gotmarc does
43 5f54ec1a 2022-08-24 op incremental updates to some extent so except for the first run, which
44 5f54ec1a 2022-08-24 op will take a while, updating the archive should be fast.
46 b2508be5 2022-08-24 op For use with httpd' `gzip-static' (or similar)
50 b2508be5 2022-08-24 op will recursively compress every file in OUTDIR, leaving the original
57 2215cb0b 2022-08-24 op As far as I'm concerned, gotmarc (i.e. all the code in this
58 2215cb0b 2022-08-24 op repository) is in the public domain.
