about summary refs log tree commit homepage
path: root/INSTALL
diff options
Diffstat (limited to 'INSTALL')
1 files changed, 14 insertions, 7 deletions
diff --git a/INSTALL b/INSTALL
index c2f988c3..de871b1a 100644
@@ -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