doc: README + INSTALL: update with -imapd info

I forgot to update these when releasing 1.6 :x

diff --git a/INSTALL b/INSTALL
index c2f988c37d57e3b6ea97599959208ce121e2745d..de871b1afde1bafcd9f038263d7cf2c837ad80d2 100644 (file)
--- 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.
 ---------------------------------------
 
 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
 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+
 
 * 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:
 
 
 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
 - 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
 
 - 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
 
 - 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)
 
                                     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
 - 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
 
 - 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
 
 - 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
 
 - IO::Compress (::Gzip)            deb: perl-modules (or libio-compress-perl)
                                    pkg: perl5

diff --git a/README b/README
index e7a8bf84b9fe932954e1617de7b39c6dadb67c4a..5f8a1a68c2e07df4fa3d0844746a62bf3154ca6f 100644 (file)
--- 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
 
 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:
 
 
 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
 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.
 
 
 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
 
 
 * 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
 
 
 * 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:
 
 
 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.
 
 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).
 
 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/
 
        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
 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:
 
 
 You may also clone all messages via git: