Code Monkey home page Code Monkey logo

mlmmj-archivist's Introduction

mlmmj-archivist

A shell script for creating web archives for mlmmj mailing lists. Mlmmj-archivist generates the web archives for the public mailing lists of GFOSS (ΕΕΛ/ΛΑΚ), available at https://lists.ellak.gr/.

Features

  • Supports flat and hierarchical mailing list directory structures; eg. both /var/spool/mlmmj/listname and /var/spool/mlmmj/domain.tld/listname structures are supported.
  • Theming support.
  • Localization support.
  • Also creates introduction pages for the domain and each mailing list.

Requirements & Compatibility

  • MHonArc.
  • rsync.
  • Basic UNIX utilities: awk, cat, date, grep, install, sed and, of course, sh.

Tested on Debian Wheezy. Currently it requires GNU date so it is not very portable. Should fix this in a future update.

The current Makefile requires GNU make. In future versions it should work with BSD make too.

Installation

Running

make install

should install the script in /usr/local/bin, the configuration samples in /etc/mlmmj-archivist and the bundled templates in /usr/local/share/mlmmj-archivist/templates.

All paths can be adjusted by setting the environment variables:

  • SYSCONFDIR: for the configuration directory.
  • PREFIX: for replacing /usr/local with something else.
  • BINDIR: the installation path for the executable script.
  • SHAREDIR: the shared directory; currently contains the templates directory.
  • DESTDIR: the root directory to work on. Useful for packaging.

After completing the installation you should copy the configuration files mlmmj-archivist.conf.sample to mlmmj-archivist.conf, and mhonarc.mrc.sample to mhonarc.mrc, and tweak to your preference, prior to running the script for first time.

Usage

mlmmj-archivist is designed to run from cron in predefined intervals. Since it creates archives incrementally it can be used with frequent intervals in busy hosts with many mailing list messages.

An example crontab entry for running mlmmj-archivist hourly:

5 * * * *  /usr/local/bin/mlmmj-archivist

TODO

  • Add parallel archive creation capability, for SMP systems.
  • Switch the localization system to something less hackish; gettext is a good candidate.

License

This project is licensed under the ISC license.

mlmmj-archivist's People

Contributors

mtzanidakis avatar axilleas avatar

Stargazers

iRedMail avatar  avatar Lampros avatar

Watchers

Alexios Zavras (zvr) avatar James Cloos avatar Theodoros G. Karounos avatar  avatar david bromoiras avatar Pantelis Sarantos avatar GFOSS Developers avatar  avatar Theodore Theodoropoulos avatar Christos Karamolegkos avatar  avatar

Forkers

scott5 koustab

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.