From cf35d38e7f845393659dfce0249a76d529a2c92c Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Wed, 2 Jan 2019 08:23:13 +0000 Subject: update and add documentation for repository formats Remove confusing documentation around ssoma now that we have NNTP and downloadable mbox support. Only lightly-checked for grammar and speling, and not yet formatting. Edits, corrections and addendums expected :> --- README | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'README') diff --git a/README b/README index 26e0b695..ffd433d8 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) @@ -123,10 +127,6 @@ You may also clone all messages via 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: - - https://ssoma.public-inbox.org/README.html - Anti-Spam --------- @@ -140,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. @@ -151,7 +151,7 @@ aims to preserve the focus on content, and not presentation. Copyright --------- -Copyright 2013-2018 all contributors +Copyright 2013-2019 all contributors License: AGPL-3.0+ This program is free software: you can redistribute it and/or modify -- cgit v1.2.3-24-ge0c7