From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH] doc: README + INSTALL: update with -imapd info
Date: Mon, 25 Jan 2021 19:18:32 +0000 [thread overview]
Message-ID: <20210125191832.12429-1-e@80x24.org> (raw)
I forgot to update these when releasing 1.6 :x
---
INSTALL | 21 ++++++++++++++-------
README | 16 ++++++++++------
2 files changed, 24 insertions(+), 13 deletions(-)
diff --git a/INSTALL b/INSTALL
index c2f988c3..de871b1a 100644
--- a/INSTALL
+++ b/INSTALL
@@ -2,7 +2,7 @@ public-inbox (server-side) installation
---------------------------------------
This is for folks who want to setup their own public-inbox instance.
-Clients should use normal git-clone/git-fetch, or NNTP clients
+Clients should use normal git-clone/git-fetch, IMAP or NNTP clients
if they want to import mail into their personal inboxes.
public-inbox is developed on Debian GNU/Linux systems and will
@@ -24,7 +24,7 @@ functionality. The core tools are, of course:
* Git (1.8.0+, 2.6+ for writing v2 inboxes)
* Perl 5.10.1+
-* DBD::SQLite (needed for NNTP, message threading, and v2 inboxes)
+* DBD::SQLite (needed for IMAP, NNTP, message threading, and v2 inboxes)
To accept incoming mail into a public inbox, you'll likely want:
@@ -70,17 +70,17 @@ Numerous optional modules are likely to be useful as well:
- DBD::SQLite deb: libdbd-sqlite3-perl
pkg: p5-DBD-SQLite
rpm: perl-DBD-SQLite
- (for v2, NNTP, or gzipped mboxes)
+ (for v2, IMAP, NNTP, or gzipped mboxes)
- Search::Xapian deb: libsearch-xapian-perl
pkg: p5-Search-Xapian
rpm: perl-Search-Xapian
- (HTTP search)
+ (HTTP and IMAP search)
- Net::Server deb: libnet-server-perl
pkg: pkg-Net-Server
rpm: perl-Net-Server
- (for HTTP/NNTP background daemons,
+ (for HTTP/IMAP/NNTP background daemons,
not needed as systemd services or
foreground servers)
@@ -92,7 +92,14 @@ Numerous optional modules are likely to be useful as well:
- Email::Address::XS deb: libemail-address-xs-perl
pkg: pkg-Email-Address-XS
(correct parsing of tricky email
- addresses, phrases and comments)
+ addresses, phrases and comments,
+ required for IMAP)
+
+- Parse::RecDescent deb: libparse-recdescent-perl
+ pkg: p5-Parse-RecDescent
+ rpm: perl-ParseRecDescent
+ (optional, for public-inbox-imapd(1))
+
- Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl
pkg: p5-Plack-Middleware-ReverseProxy
@@ -129,7 +136,7 @@ above, so there is no need to explicitly install them:
- Linux::Inotify2 deb: liblinux-inotify2-perl
rpm: perl-Linux-Inotify2
- (for public-inbox-watch on Linux)
+ (for public-inbox-watch and -imapd on Linux)
- IO::Compress (::Gzip) deb: perl-modules (or libio-compress-perl)
pkg: perl5
diff --git a/README b/README
index e7a8bf84..5f8a1a68 100644
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ 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.
+read via NNTP, IMAP, Atom feeds or HTML archives.
public-inbox spawned around three main ideas:
@@ -38,7 +38,7 @@ headers. List server admins are also burdened with delivery
failures.
public-inbox uses the "pull" model. Casual readers may
-follow the list via NNTP, Atom feed or HTML archives.
+follow the list via NNTP, IMAP, Atom feed or HTML archives.
If a reader loses interest, they simply stop following.
@@ -56,7 +56,7 @@ Features
* 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
+* Atom feed, IMAP, NNTP allows casual readers to follow via local tools
* uses only well-documented and easy-to-implement data formats
@@ -64,7 +64,7 @@ Try it out now, see https://try.public-inbox.org/
Requirements for reading:
-* any software capable of NNTP or following Atom feeds
+* any software capable of IMAP, NNTP or following Atom feeds
Any basic web browser will do for the HTML archives.
We primarily develop on w3m to maximize accessibility.
@@ -114,15 +114,19 @@ subscription. This also makes it easier to rope in folks of
tangentially related projects we depend on (e.g. git developers
on git@vger.kernel.org).
-The archives are readable via NNTP or HTTP:
+The archives are readable via IMAP, NNTP or HTTP:
- nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
+ nntps://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
+ imaps://news.public-inbox.org/inbox.comp.mail.public-inbox.meta.0
https://public-inbox.org/meta/
+AUTH=ANONYMOUS is supported for IMAP, but any username + password works
+
And as Tor hidden services:
http://hjrcffqmbrq6wope.onion/meta/
nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
+ imap://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta.0
You may also clone all messages via git:
reply other threads:[~2021-01-25 19:18 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210125191832.12429-1-e@80x24.org \
--to=e@80x24.org \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).