From 2e9aef3017084286a9e84b78ee66498217970f73 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Wed, 19 Dec 2018 09:50:57 +0000 Subject: [PATCH] README: add warnings about the lack of v2 support Repositories and everything else will continue to exist; but don't encourage people to use specialized tools when generic ones such as NNTP will do. --- Documentation/ssoma_repository.pod | 4 ++++ README | 15 ++++++++------- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/Documentation/ssoma_repository.pod b/Documentation/ssoma_repository.pod index 912f309..6929c83 100644 --- a/Documentation/ssoma_repository.pod +++ b/Documentation/ssoma_repository.pod @@ -6,6 +6,10 @@ ssoma_repository - repository and tree description for ssoma =head1 DESCRIPTION +WARNING: this does NOT describe the scalable v2 format used +by public-inbox. Use of ssoma is not recommended for new +installations due to scalability problems. + ssoma uses a git repository to store each email as a git blob. The tree filename of the blob is based on the SHA1 hexdigest of the first Message-ID header. A commit is made for each message diff --git a/README b/README index d2be773..de12f93 100644 --- a/README +++ b/README @@ -1,15 +1,13 @@ ssoma - some sort of mail archiver ---------------------------------- + +WARNING: ssoma will not be updated for public-inbox v2 repositories. +Nowadays, public-inbox has NNTP support which makes ssoma redundant. + ssoma is a git-based mail archiver and transport. Email is injected via ssoma-mda(1) (MDA: mail delivery agent) on a server and may be shared (via git) and extracted to mbox, Maildir, or IMAP via ssoma(1). ssoma -exists primarily as the mechanism (not policy) for public-inbox but may -easily be used for other projects. - -Readers of public-inbox instances may install ssoma to extract messages -into their favorite mail client for reading. - -See http://public-inbox.org/ for more information on how ssoma is used. +existed primarily as the mechanism (not policy) for public-inbox v1. Features -------- @@ -77,6 +75,9 @@ document describes it: http://ssoma.public-inbox.org/ssoma_repository.txt +Again, note that this DOES NOT cover the public-inbox v2 repository +format. + Copyright --------- Copyright 2013-2016 all contributors -- 2.11.4.GIT