README

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