]> Sergey Matveev's repositories - public-inbox.git/blobdiff - README
public-inbox 1.1.0-pre1
[public-inbox.git] / README
diff --git a/README b/README
index 4c405acde3dc23cd31b96af738cb37439f4de129..26e0b69514df24567cf366468e852f0daad2053b 100644 (file)
--- a/README
+++ b/README
@@ -1,15 +1,18 @@
 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
 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.
 
@@ -18,41 +21,44 @@ to run their own instances with minimal overhead.
 
 Implementation
 --------------
-public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements
-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
-may also have difficulty following existing discussions if archives do
-not expose Message-ID headers for responses.  List server admins may be
-burdened with delivery failures.
+public-inbox stores mail in a git repository keyed by Message-ID
+as documented in: https://ssoma.public-inbox.org/ssoma_repository.txt
 
-public-inbox uses the "pull" model.  Casual readers may also follow
-the list via NNTP, Atom feed or HTML archives.
+By storing (and optionally) exposing an inbox via git, it is
+fast and efficient to host and mirror public-inboxes.
 
-Users of the ssoma[1] command-line tool may import mail into an mbox,
-Maildir, or IMAP folder from git repositories periodically.
+Traditional mailing lists use the "push" model.  For readers,
+that requires commitment to subscribe and effort to unsubscribe.
+New readers may also have difficulty following existing
+discussions if archives do not expose Message-ID and References
+headers.  List server admins are also burdened with delivery
+failures.
+
+public-inbox uses the "pull" model.  Casual readers may also
+follow the list via NNTP, Atom feed or HTML archives.
 
 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.
+easy-to-relocate to different mail addresses without losing
+or splitting archives.
 
 _Anybody_ may also setup a delivery-only mailing list server to
 replay a public-inbox git archive to subscribers via SMTP.
 
-[1] http://ssoma.public-inbox.org/
-
 Features
 --------
+
 * anybody may participate via plain-text email
+
 * 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:
 
@@ -66,24 +72,30 @@ Requirements (participant)
 
 * 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 SPOF.
+  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
+AGPL source code is available via git:
+
+       git clone https://public-inbox.org/ public-inbox
+       git clone git://repo.or.cz/public-inbox
+       torsocks git clone http://hjrcffqmbrq6wope.onion/public-inbox
 
 See below for contact info.
 
 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,
@@ -99,30 +111,38 @@ on git@vger.kernel.org).
 The archives are readable via NNTP or HTTP:
 
        nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
-       http://public-inbox.org/meta/
+       https://public-inbox.org/meta/
+
+And as Tor hidden services:
+
+       http://hjrcffqmbrq6wope.onion/meta/
+       nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
 
 You may also clone all messages via git:
 
-       git clone --mirror git://public-inbox.org/meta.git
+       git clone --mirror https://public-inbox.org/meta/
+       torsocks git clone --mirror http://hjrcffqmbrq6wope.onion/meta/
 
 Or pass the same git repository URL for ssoma using the instructions at:
 
-       http://ssoma.public-inbox.org/README.html
+       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.
 
-See http://public-inbox/dc-dlvr-spam-flow.html for more info.
+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
-entire mail archives are shared between clients.
+
+To discourage phishing, trackers, exploits and other nuisances,
+only plain-text emails are allowed and HTML is rejected.
+This improves accessibility, and saves bandwidth and storage
+as mail is archived forever.
 
 As of the 2010s, successful online social networks and forums are the
 ones which heavily restrict users formatting options; so public-inbox
@@ -130,8 +150,9 @@ aims to preserve the focus on content, and not presentation.
 
 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-2018 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
@@ -144,7 +165,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 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: