public-inbox - an "archives first" approach to mailing lists
------------------------------------------------------------
+
public-inbox implements the sharing of an email inbox via git to
complement or replace traditional mailing lists. Readers may
-subscribe to a mailing list using ssoma[1] (a git-wrapper) to
-import email from a git repository into an IMAP folder, Maildir,
-or mbox. Readers may also read via NNTP, Atom feeds and HTML
-archives.
+read via NNTP, Atom feeds or HTML archives.
public-inbox spawned around three main ideas:
-* Publically accessible and archived communication is essential to
- Free and Open Source development.
-* Contributing to Free and Open Source projects should not require the
- use of non-Free/non-Open Source services or software.
+* Publicly accessible and archived communication is essential to
+ Free Software development.
+
+* Contributing to Free Software projects should not require the
+ use of non-Free services or software.
+
* Graphical user interfaces should not be required for text-based
communication.
Implementation
--------------
+
public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements
-no policy of its own. By exposing an inbox via git, readers may follow
-the inbox without subscribing via SMTP and have easy access to old
-messages.
+no policy of its own. By storing (and optionally) exposing an inbox
+via git, it is fast and efficient to host and mirror public-inboxes.
Traditional mailing lists use the "push" model. For readers, this
requires commitment to subscribe and effort to unsubscribe. New readers
not expose Message-ID headers for responses. List server admins may be
burdened with delivery failures.
-public-inbox uses the "pull" model. Readers import mail into an mbox,
-Maildir, or IMAP folder from git repositories periodically. If a reader
-loses interest, they simply stop syncing. Since we use git, mirrors are
-easy-to-setup, and lists are easy-to-relocate to different mail
-addresses without losing/splitting archives. Dedicated readers only
-need to install ssoma, a command-line tool[1] currently implemented in
-Perl.
+public-inbox uses the "pull" model. Casual readers may also follow
+the list via NNTP, Atom feed or HTML archives.
+
+Users of the ssoma[1] command-line tool may import mail into an mbox,
+Maildir, or IMAP folder from git repositories periodically.
-Casual readers may also follow the list via NNTP, Atom feed or
-HTML archives.
+If a reader loses interest, they simply stop syncing.
-_Anybody_ may also setup a delivery-only mailing list server to replay
-a public-inbox git archive to subscribers via SMTP.
+Since we use git, mirrors are easy-to-setup, and lists are
+easy-to-relocate to different mail addresses without losing/splitting
+archives.
-[1] http://ssoma.public-inbox.org/
+_Anybody_ may also setup a delivery-only mailing list server to
+replay a public-inbox git archive to subscribers via SMTP.
+
+[1] https://ssoma.public-inbox.org/
Features
--------
+
* anybody may participate via plain-text email
-* stores email in git, readers have a complete archive of the inbox
-* Atom feed allows casual readers to follow via feed reader
-* Mail user-agent (MUA) users may use Maildir, mbox(5) and/or IMAP locally
+
+* stores email in git, readers may have a complete archive of the inbox
+
+* Atom feed and NNTP allows casual readers to follow via feed reader
+
* uses only well-documented and easy-to-implement data formats
-Try it out now, see http://try.public-inbox.org/
+Try it out now, see https://try.public-inbox.org/
+
+Requirements for reading:
-Requirements (Atom, read-only client)
--------------------------------------
-* any feed reader capable of following Atom feeds
+* any software capable of NNTP or following Atom feeds
Any basic web browser will do for the HTML archives.
+We primarily develop on w3m to maximize accessibility.
Requirements (participant)
--------------------------
-* ssoma - http://ssoma.public-inbox.org/
+
* any MUA which may send text-only emails ("git send-email" works!)
+ Users are strongly encouraged to use the "reply-all" feature of
+ their mailers to reduce the impact of a public-inbox as a
+ single point of failure.
+
* participants do not need to install public-inbox, only server admins
Requirements (server)
---------------------
-See http://public-inbox.org/INSTALL
+
+See https://public-inbox.org/INSTALL
Hacking
-------
+
Source code is available via git:
git clone git://80x24.org/public-inbox
Contact
-------
+
We are happy to see feedback of all types via plain-text email.
public-inbox discussion is self-hosting on public-inbox.org
Please send comments, user/developer discussion, patches, bug reports,
tangentially related projects we depend on (e.g. git developers
on git@vger.kernel.org).
-You may subscribe via ssoma(1), LISTNAME is a name of your choosing:
-
- URL=git://public-inbox.org/meta
- LISTNAME=public-inbox
-
- # to initialize a maildir (this may be a new or existing maildir,
- # ssoma will not touch existing messages)
- # If you prefer mbox, use "ssoma add mbox ..." instead
- ssoma add $LISTNAME $URL maildir:/path/to/maildir/
+The archives are readable via NNTP or HTTP:
- # read with your favorite MUA (only using mutt as an example)
- mutt -f /path/to/maildir # (or /path/to/mbox)
+ nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
+ https://public-inbox.org/meta/
- # to keep your mbox or maildir up-to-date, periodically run the following:
- ssoma sync $LISTNAME
+You may also clone all messages via git:
- # your MUA may modify and delete messages from the maildir or mbox,
- # this does not affect ssoma functionality at all
+ git clone --mirror https://public-inbox.org/meta/
- # to sync all your ssoma subscriptions via cronjob
- ssoma sync --cron
+Or pass the same git repository URL for ssoma using the instructions at:
-HTML inbox archives are available: http://public-inbox.org/meta/
-The archives are also readable via NNTP:
- nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
+ https://ssoma.public-inbox.org/README.html
Anti-Spam
---------
+
The maintainer of public-inbox has found SpamAssassin a good tool for
filtering his personal mail, and it will be the default spam filtering
tool in public-inbox.
-Readers may also use a custom mail-delivery-agent for delivery to enable
-spam filtering by having ssoma deliver to a command via pipe.
-
-There is unlikely to be any tool which is 100% accurate at classifying
-spam, so it is possible to remove messages using the ssoma-rm(1) tool
-in ssoma.
+See https://public-inbox.org/dc-dlvr-spam-flow.html for more info.
Content Filtering
-----------------
+
To discourage phishing, web bugs (tracking), viruses and other nuisances,
only plain-text content is allowed and non-text content is stripped.
This saves I/O bandwidth and storage, which is important as
Copyright
---------
-Copyright 2013-2015 all contributors <meta@public-inbox.org>
-License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
+
+Copyright 2013-2016 all contributors <meta@public-inbox.org>
+License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
-along with this program. If not, see <http://www.gnu.org/licenses/>.
+along with this program. If not, see <https://www.gnu.org/licenses/>.
Additional permission under GNU GPL version 3 section 7: