README

   1 ssoma - some sort of mail archiver
   2 ----------------------------------
   3
   4 WARNING: ssoma will not be updated for public-inbox v2 repositories.
   5 Nowadays, public-inbox has NNTP support which makes ssoma redundant.
   6
   7 ssoma is a git-based mail archiver and transport.  Email is injected via
   8 ssoma-mda(1) (MDA: mail delivery agent) on a server and may be shared
   9 (via git) and extracted to mbox, Maildir, or IMAP via ssoma(1).  ssoma
  10 existed primarily as the mechanism (not policy) for public-inbox v1.
  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 Install
  19 -------
  20 Installation should be easy and require only a few, commonly-available
  21 packages.  See http://ssoma.public-inbox.org/INSTALL for details.
  22
  23 Hacking
  24 -------
  25 Source code is available via git:
  26
  27         git clone git://80x24.org/ssoma
  28
  29 See below for contact info.
  30
  31 Contact
  32 -------
  33 We are happy to see feedback of all types via plain-text email.
  34 Please email comments, user/developer discussion, patches, bug reports,
  35 and pull requests to the public-inbox discussion list at:
  36
  37     meta@public-inbox.org
  38
  39 Please Cc: all recipients when replying (this is not a requirement of
  40 public-inbox or ssoma, but a good idea since we do not require
  41 subscription).  This also makes it easier to rope in folks of
  42 tangentially related projects we depend on (e.g. git developers on
  43 git@vger.kernel.org).
  44
  45 You can subscribe via ssoma, LISTNAME is a name of your choosing:
  46
  47     URL=git://public-inbox.org/meta
  48     LISTNAME=public-inbox
  49
  50     # to initialize a maildir (this may be a new or existing maildir,
  51     # ssoma will not touch existing messages)
  52     # If you prefer mbox, use mbox:/path/to/mbox as the last argument
  53     ssoma add $LISTNAME $URL maildir:/path/to/maildir
  54
  55     # read with your favorite MUA (only using mutt as an example)
  56     mutt -f /path/to/maildir # (or /path/to/mbox)
  57
  58     # to keep your mbox or maildir up-to-date, periodically run the following:
  59     ssoma sync $LISTNAME
  60
  61     # your MUA may modify and delete messages from the maildir or mbox,
  62     # this does not affect ssoma functionality at all
  63
  64     # to sync all your ssoma subscriptions
  65     ssoma sync
  66
  67     # You may wish to sync in your cronjob
  68     ssoma sync --cron
  69
  70 Mail repository format
  71 ----------------------
  72 If you are uncomfortable running code in ssoma for any reason and
  73 would rather read directly from the git repository, the following
  74 document describes it:
  75
  76     http://ssoma.public-inbox.org/ssoma_repository.txt
  77
  78 Again, note that this DOES NOT cover the public-inbox v2 repository
  79 format.
  80
  81 Copyright
  82 ---------
  83 Copyright 2013-2016 all contributors <meta@public-inbox.org>
  84 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
  85
  86 This program is free software: you can redistribute it and/or modify
  87 it under the terms of the GNU Affero General Public License as published by
  88 the Free Software Foundation, either version 3 of the License, or
  89 (at your option) any later version.
  90
  91 This program is distributed in the hope that it will be useful,
  92 but WITHOUT ANY WARRANTY; without even the implied warranty of
  93 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  94 GNU Affero General Public License for more details.
  95
  96 You should have received a copy of the GNU Affero General Public License
  97 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  98
  99 Additional permission under GNU GPL version 3 section 7:
 100
 101     If you modify this program, or any covered work, by linking or
 102     combining it with the OpenSSL project's OpenSSL library (or a
 103     modified version of that library), containing parts covered by the
 104     terms of the OpenSSL or SSLeay licenses, the copyright holder(s)
 105     grants you additional permission to convey the resulting work.
 106     Corresponding Source for a non-source form of such a combination
 107     shall include the source code for the parts of OpenSSL used as well
 108     as that of the covered work.