---------------------------------------
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
* 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:
- 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)
- 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
(ensures redirects are correct when running
behind nginx or Varnish)
-- Plack::Middleware::Deflater deb: libplack-middleware-deflater-perl
- pkg: p5 -Plack-Middleware-Deflater
- rpm: perl-Plack-Middleware-Deflater
- (saves bandwidth on responses)
-
* highlight deb: libhighlight-perl
(for syntax highlighting with coderepo)
- 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
Copyright
---------
-Copyright 2013-2020 all contributors <meta@public-inbox.org>
+Copyright 2013-2021 all contributors <meta@public-inbox.org>
License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>