X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=README;h=a3c1e61cfa4d3ae6a5685dee76467f3f011617eb;hb=90dc2b8ca53f93ca937e7cc71cd7c915e3df8020;hp=ca4e2a86ed35b0f690d50c5e222d6c7b2af8ee47;hpb=79bf257cbc4e188992f540d6b4ae1bd5cbcf26ee;p=public-inbox.git
diff --git a/README b/README
index ca4e2a86..a3c1e61c 100644
--- a/README
+++ b/README
@@ -22,8 +22,9 @@ to run their own instances with minimal overhead.
Implementation
--------------
-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 stores mail in git repositories as documented
+in https://public-inbox.org/public-inbox-v2-format.txt and
+https://public-inbox.org/public-inbox-v1-format.txt
By storing (and optionally) exposing an inbox via git, it is
fast and efficient to host and mirror public-inboxes.
@@ -35,10 +36,10 @@ 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
+public-inbox uses the "pull" model. Casual readers may
follow the list via NNTP, Atom feed or HTML archives.
-If a reader loses interest, they simply stop syncing.
+If a reader loses interest, they simply stop following.
Since we use git, mirrors are easy-to-setup, and lists are
easy-to-relocate to different mail addresses without losing
@@ -75,6 +76,9 @@ Requirements (participant)
their mailers to reduce the impact of a public-inbox as a
single point of failure.
+* The HTTP web interface exposes mboxrd files, and NNTP clients often
+ feature reply-by-email functionality
+
* participants do not need to install public-inbox, only server admins
Requirements (server)
@@ -85,9 +89,11 @@ See https://public-inbox.org/INSTALL
Hacking
-------
-Source code is available via git:
+AGPL source code is available via git:
git clone https://public-inbox.org/public-inbox.git
+ git clone https://repo.or.cz/public-inbox.git
+ torsocks git clone http://hjrcffqmbrq6wope.onion/public-inbox
See below for contact info.
@@ -111,13 +117,15 @@ The archives are readable via NNTP or HTTP:
nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
https://public-inbox.org/meta/
-You may also clone all messages via git:
+And as Tor hidden services:
- git clone --mirror https://public-inbox.org/meta/
+ http://hjrcffqmbrq6wope.onion/meta/
+ nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
-Or pass the same git repository URL for ssoma using the instructions at:
+You may also clone all messages via git:
- https://ssoma.public-inbox.org/README.html
+ git clone --mirror https://public-inbox.org/meta/
+ torsocks git clone --mirror http://hjrcffqmbrq6wope.onion/meta/
Anti-Spam
---------
@@ -132,7 +140,7 @@ Content Filtering
-----------------
To discourage phishing, trackers, exploits and other nuisances,
-only plain-text emails are allowed and HTML is rejected.
+only plain-text emails are allowed and HTML is rejected by default.
This improves accessibility, and saves bandwidth and storage
as mail is archived forever.
@@ -143,7 +151,7 @@ aims to preserve the focus on content, and not presentation.
Copyright
---------
-Copyright 2013-2016 all contributors
+Copyright 2013-2020 all contributors
License: AGPL-3.0+
This program is free software: you can redistribute it and/or modify