README

   1 ssoma - some sort of mail archiver
   2 ----------------------------------
   3
   4 ssoma is a git-based mail archiver and transport.  Email is injected via
   5 ssoma-mda(1) (MDA: mail delivery agent) on a server and may be shared
   6 (via git) and extracted to mbox, Maildir, or IMAP via ssoma(1).  It
   7 exists primarily as the mechanism for public-inbox but may easily be
   8 used for other projects.
   9
  10 See http://public-inbox.org/ for more information on how ssoma is used.
  11
  12 Features
  13 --------
  14 * stores email in git, so readers have a full history of the mailing list
  15 * mail user-agent (MUA) users may choose from IMAP, mbox(5), and Maildir
  16 * uses only well-documented and easy-to-implement data formats
  17
  18 Hacking
  19 -------
  20 Source code is available via git:
  21
  22         git clone git://bogomips.org/ssoma
  23
  24 See below for contact info.
  25
  26 Contact
  27 -------
  28 We are happy to see feedback of all types via plain-text email.
  29 Please email comments, user/developer discussion, patches, bug reports,
  30 and pull requests to the public-inbox discussion list at:
  31
  32     meta@public-inbox.org
  33
  34 Please Cc: all recipients when replying (this is not a requirement of
  35 public-inbox or ssoma, but a good idea since we do not require
  36 subscription).  This also makes it easier to rope in folks of
  37 tangentially related projects we depend on (e.g. git developers on
  38 git@vger.kernel.org).
  39
  40 You can subscribe via ssoma, LISTNAME is a name of your choosing:
  41
  42     URL=git://public-inbox.org/meta
  43     LISTNAME=public-inbox
  44
  45     # to initialize a maildir (this may be a new or existing maildir,
  46     # ssoma will not touch existing messages)
  47     # If you prefer mbox, use mbox:/path/to/mbox as the last argument
  48     ssoma add $LISTNAME $URL maildir:/path/to/maildir
  49
  50     # read with your favorite MUA (only using mutt as an example)
  51     mutt -f /path/to/maildir # (or /path/to/mbox)
  52
  53     # to keep your mbox or maildir up-to-date, periodically run the following:
  54     ssoma sync $LISTNAME
  55
  56     # your MUA may modify and delete messages from the maildir or mbox,
  57     # this does not affect ssoma functionality at all
  58
  59     # to sync all your ssoma subscriptions
  60     ssoma sync
  61
  62 Mail repository format
  63 ----------------------
  64 If you are uncomfortable running code in ssoma for any reason and
  65 would rather read directly from the git repository, the following
  66 document describes it:
  67
  68     http://ssoma.public-inbox.org/ssoma_repository.txt
  69
  70 Copyright
  71 ---------
  72 Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
  73 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
  74
  75 This program is free software: you can redistribute it and/or modify
  76 it under the terms of the GNU Affero General Public License as published by
  77 the Free Software Foundation, either version 3 of the License, or
  78 (at your option) any later version.
  79
  80 This program is distributed in the hope that it will be useful,
  81 but WITHOUT ANY WARRANTY; without even the implied warranty of
  82 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  83 GNU Affero General Public License for more details.
  84
  85 You should have received a copy of the GNU Affero General Public License
  86 along with this program.  If not, see <http://www.gnu.org/licenses/>.