README

   1 public-inbox - an "archives first" approach to mailing lists
   2 ------------------------------------------------------------
   3 public-inbox implements the sharing of an email inbox via git to
   4 complement or replace traditional mailing lists.
   5
   6 public-inbox spawned around three main ideas:
   7
   8 * Publically accessible and archived communication is essential to
   9   Free and Open Source development.
  10 * Contributing to Free and Open Source projects should not require the
  11   use of non-Free/non-Open Source services or software.
  12 * Graphical user interfaces should not be required for text-based
  13   communication.
  14
  15 public-inbox aims to be easy-to-deploy and manage; encouraging projects
  16 to run their own instances with minimal overhead.
  17
  18 Features
  19 --------
  20 * anybody may participate via plain-text email
  21 * stores email in git, readers have a complete archive of the inbox
  22 * Atom feed allows casual readers to follow via feed reader
  23 * Mail user-agent (MUA) users may use Maildir, mbox(5) and/or IMAP locally
  24 * uses only well-documented and easy-to-implement data formats
  25
  26 Try it out now, see http://try.public-inbox.org/
  27
  28 Implementation
  29 --------------
  30 public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements
  31 no policy of its own.  By exposing an inbox via git, readers may follow
  32 the inbox without subscribing via SMTP and have easy access to old
  33 messages.
  34
  35 Traditional mailing lists use the "push" model.  For readers, this
  36 requires commitment to subscribe and effort to unsubscribe.  New readers
  37 may also have difficulty following existing discussions if archives do
  38 not expose Message-ID headers for responses.  List server admins may be
  39 burdened with delivery failures.
  40
  41 public-inbox uses the "pull" model.  Readers import mail into an mbox,
  42 Maildir, or IMAP folder from git repositories periodically.  If a reader
  43 loses interest, they simply stop syncing.  Since we use git, mirrors are
  44 easy-to-setup, and lists are easy-to-relocate to different mail
  45 addresses without losing/splitting archives.  Dedicated readers only
  46 need to install ssoma, a command-line tool[1] currently implemented in
  47 Perl.
  48
  49 Casual readers may also follow the list via Atom feed or web archives.
  50
  51 _Anybody_ may also setup a delivery-only mailing list server to replay
  52 a public-inbox git archive to subscribers via SMTP.
  53
  54 [1] http://ssoma.public-inbox.org/
  55
  56 Requirements (Atom, read-only client)
  57 -------------------------------------
  58 * any feed reader capable of following Atom feeds
  59
  60 Any basic web browser will do for the HTML archives.
  61
  62 Requirements (participant)
  63 --------------------------
  64 * ssoma - http://ssoma.public-inbox.org/
  65 * any MUA which may send text-only emails ("git send-email" works!)
  66 * participants do not need to install public-inbox, only server admins
  67
  68 Requirements (server)
  69 ---------------------
  70 See http://public-inbox.org/INSTALL.html
  71
  72 Hacking
  73 -------
  74 Source code is available via git:
  75
  76         git clone git://80x24.org/public-inbox
  77
  78 See below for contact info.
  79
  80 Contact
  81 -------
  82 We are happy to see feedback of all types via plain-text email.
  83 public-inbox discussion is self-hosting on public-inbox.org
  84 Please send comments, user/developer discussion, patches, bug reports,
  85 and pull requests to our public-inbox address at:
  86
  87         meta@public-inbox.org
  88
  89 Please Cc: all recipients when replying as we do not require
  90 subscription.  This also makes it easier to rope in folks of
  91 tangentially related projects we depend on (e.g. git developers
  92 on git@vger.kernel.org).
  93
  94 You may subscribe via ssoma(1), LISTNAME is a name of your choosing:
  95
  96     URL=git://public-inbox.org/meta
  97     LISTNAME=public-inbox
  98
  99     # to initialize a maildir (this may be a new or existing maildir,
 100     # ssoma will not touch existing messages)
 101     # If you prefer mbox, use "ssoma add mbox ..." instead
 102     ssoma add $LISTNAME $URL maildir:/path/to/maildir/
 103
 104     # read with your favorite MUA (only using mutt as an example)
 105     mutt -f /path/to/maildir # (or /path/to/mbox)
 106
 107     # to keep your mbox or maildir up-to-date, periodically run the following:
 108     ssoma sync $LISTNAME
 109
 110     # your MUA may modify and delete messages from the maildir or mbox,
 111     # this does not affect ssoma functionality at all
 112
 113     # to sync all your ssoma subscriptions via cronjob
 114     ssoma sync --cron
 115
 116 HTML inbox archives are available: http://public-inbox.org/meta/
 117
 118 Anti-Spam
 119 ---------
 120 The maintainer of public-inbox has found SpamAssassin a good tool for
 121 filtering his personal mail, and it will be the default spam filtering
 122 tool in public-inbox.
 123
 124 Readers may also use a custom mail-delivery-agent for delivery to enable
 125 spam filtering by having ssoma deliver to a command via pipe.
 126
 127 There is unlikely to be any tool which is 100% accurate at classifying
 128 spam, so it is possible to remove messages using the ssoma-rm(1) tool
 129 in ssoma.
 130
 131 Content Filtering
 132 -----------------
 133 To discourage phishing, web bugs (tracking), viruses and other nuisances,
 134 only plain-text content is allowed and non-text content is stripped.
 135 This saves I/O bandwidth and storage, which is important as
 136 entire mail archives are shared between clients.
 137
 138 As of the 2010s, successful online social networks and forums are the
 139 ones which heavily restrict users formatting options; so public-inbox
 140 aims to preserve the focus on content, and not presentation.
 141
 142 Copyright
 143 ---------
 144 Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
 145 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
 146
 147 This program is free software: you can redistribute it and/or modify
 148 it under the terms of the GNU Affero General Public License as published by
 149 the Free Software Foundation, either version 3 of the License, or
 150 (at your option) any later version.
 151
 152 This program is distributed in the hope that it will be useful,
 153 but WITHOUT ANY WARRANTY; without even the implied warranty of
 154 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 155 GNU Affero General Public License for more details.
 156
 157 You should have received a copy of the GNU Affero General Public License
 158 along with this program.  If not, see <http://www.gnu.org/licenses/>.