https://github.com/omar-polo/smarc

static web mail archive generator
https://github.com/omar-polo/smarc

Last synced: 8 days ago
JSON representation

static web mail archive generator

• Host: GitHub
• URL: https://github.com/omar-polo/smarc
• Owner: omar-polo
• Created: 2023-05-07T18:46:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-28T10:29:05.000Z (3 months ago)
• Last Synced: 2024-08-28T11:54:20.414Z (3 months ago)
• Language: C
• Homepage: https://projects.omarpolo.com/smarc.html
• Size: 423 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README
  • Changelog: CHANGES

Awesome Lists containing this project

README

        
SMARC -- static web mail archive generator

==========================================

A collection of scripts to generate a static mail archive from a

Maildir; originally intended to provide a public web interface for the

Game of Trees mailing list, now flexible enough to be used for other

lists.

The static site generator depends on perl and mblaze, the web search

component on libevent and sqlite3.

How it works

------------

smarc(1) incrementally generate a set of static files from a maildir,

smingest(1) to populate an sqlite3 database to provide a search

facility for the msearchd(8) web interface.

smarc(7) documents the steps needed for a first setup, how to operate it

and tips for maintaining multiple archives.

Building

--------

To compile it, run

	$ ./configure

	$ make

	# make install

Several parameters can be passed to the `configure' script to customize

the build:

 --mandir or MANDIR			Where to install man pages

 --perllib or PERLLIB			Where to install the perl module

 --prefix or PREFIX			Where to install, /usr/local

 --realsysconfdir or REALSYSCONFDIR	"Real" sysconfdir

 --sharedir or SHAREDIR			$PREFIX/share by default

 --sysconfdir or SYSCONFDIR		/etc

 --wwwuser or WWWUSER			Name of the user used by msearchd

and also:

 CC		The C compiler

 CFLAGS		Flags for the C compiler

 LDFLAGS	Flags for the linker

 PKG_CONFIG	pkg-config program, use `no' or empty to disable usage

The variables can also be set in the environment for the configure

script to pick them up.

The difference between REALSYSCONFDIR and SYSCONFDIR is to accomodate

the packaging on some systems.  For example, on OpenBSD SYSCONFDIR is

pointed at /usr/local/share/examples and the port then copies the files

in /etc, to allow the user to freely change some files and keep edits

across package updates.

smarc always installs in SYSCONFDIR but at runtime looks into

REALSYSCONFDIR.

License

-------

smarc, smingest and msearchd are released in the public domain.  The

configure script loosely based on oconfigure and is released under the

terms of ISC license.  Some OpenBSD-compats are included to build on

multiple platforms, these are released under a BSD-style license.

See the first lines of each file for the copyright owners.