Homepage:
    http://www.steve.org.uk/Software/skxlist/



About
-----

   This is a very simple piece of mailing list software, which has
 just the bare minimum of facilities.  That means:

   1.  Users can submit & confirm subscription requests.
   2.  Users can submit & confirm unsubscription requests.
   3.  Users can post to lists, once subscribed.


Installation
------------

  Run "make install" to install the software.  This does three things:

   * Copies ./bin/sxklist to /sbin
   * Copies the templates files into /etc/skxlist/
   * Installs the logrotation script.

  Now running "/sbin/skxlist --help" should complete without any problem.


  Once you've done that you may run "skxlist --new-list=foo@example.com",
 and this will output the aliases you need to add to your system.

  For example you might add the following to /etc/aliases:

#
# Aliases for 'foo' mailing list.
#
^foo-subscribe$:   "|/sbin/skxlist --list=foo --domain=list.example.com --subscribe"
^foo-unsubscribe$: "|/sbin/skxlist --list=foo --domain=list.example.com --unsubscribe"
^foo$:             "|/sbin/skxlist --list=foo --domain=list.example.com --post"
^foo-admin$:       you@example.com


  This will ensure that users can send mail to :

    foo-subscribe@list.example.com    [To subscribe]
    foo-unsubscribe@list.example.com  [To unsubscribe]
    foo@list.example.com              [To post]
    foo-admin@list.example.com        [To contact you]

  The only remaining step is to run:

    mkdir /var/lib/skxlist
    chown -R Debian-exim.Debian-exim /var/lib/skxlist
    chmod -R 770 /var/lib/skxlist



Security
--------

  Because there is no privilege separation all the list mails will
 be written by the Debian-exim4 user, or whatever user your mailserver
 is configured to run as.

  You must ensure your mailserver can write to /var/lib/skxlist, and
 you will wish to configure user/group permissions such that no other
 local users can view/modify/change anything beneath that prefix.



Organisation
------------

  A mailing list will have a new top-level directory benath /var/lib/skxlist,
 and this will look something like this:

/var/lib/skxlist/list-foo/
|-- archive
|   |-- cur
|   |-- new
|   `-- tmp
`-- members
    |-- user1@example.com
    |-- user2@example.com
    `-- user3@example.net

5 directories, 3 files


  Here you see there are two directories "archives/" and "members/".

  Messages posted to your list will be archived beneath archives, and the
 members directory will have files named after the addresses of the subscribers.

  By default all users subscribed to a list may post to it, and nobody
 else can.



List Templates
--------------

  If you wish to customise the messages which are sent to users when
 they request subscription/unsubscription you can do so.

  By default the templates will be read from /etc/skxlist, but you can
 create a per-list template directory:

   /var/lib/skxlist/$list-foo/templates

  Copy the default files into that directory and they will be used.


List Options
------------

  There might be options files present beneath the list directory, these
 are simple flags which operate upon a per-list basis.

  So far there are the following:

    $prefix/list-foo/admin-only  -> Only email addresses listed here may post.
    $prefix/list-foo/no-archive  -> Disables the auto-archiving.
    $prefix/list-foo/no-subject  -> Avoid rewriting of post subjects.
    $prefix/list-foo/swallow     -> Swallow posts rather than bounce.
    $prefix/list-foo/open-list   -> Allow non-members to post too.



Steve
--