-Optional Perl modules:
-
- - Plack[1] libplack-perl
- - URI::Escape[1] liburi-perl
- - Search::Xapian[2][3] libsearch-xapian-perl
- - IO::Compress::Gzip[3] perl-modules (or libio-compress-perl)
- - DBI[3] libdbi-perl
- - DBD::SQLite[2][3] libdbd-sqlite3-perl
- - Danga::Socket[4] libdanga-socket-perl
- - Net::Server[5] libnet-server-perl
- - Filesys::Notify::Simple[6] libfilesys-notify-simple-perl
- - Inline::C[7] libinline-c-perl
- - Plack::Middleware::ReverseProxy[8] libplack-middleware-reverseproxy-perl
- - Plack::Middleware::Deflater[8] libplack-middleware-deflater-perl
-
-[1] - Optional, needed for serving/generating Atom and HTML pages
-[2] - Optional, only required for NNTP server
-[3] - Optional, needed for gzipped mbox support over HTTP
-[4] - Optional, needed for bundled HTTP and NNTP servers
-[5] - Optional, needed for standalone daemonization of HTTP+NNTP servers
-[6] - Optional, needed for public-inbox-watch Maildir watcher
-[7] - Optional, allows speeds up spawning on Linux (see public-inbox-daemon(8))
-[8] - Optional, recommended for PSGI interface
+Beyond that, there is one non-standard Perl module required:
+
+* URI::Escape deb: liburi-perl
+ pkg: p5-URI
+ rpm: perl-URI
+ (for HTML/Atom generation)
+
+Plack and Date::Parse are optional as of public-inbox v1.3.0,
+but required for older releases:
+
+* Plack deb: libplack-perl
+ pkg: p5-Plack
+ rpm: perl-Plack, perl-Plack-Test,
+ (for HTML/Atom generation)
+
+- Date::Parse deb: libtimedate-perl
+ pkg: p5-TimeDate
+ rpm: perl-TimeDate
+ (for broken, mostly historical emails)
+
+Where "deb" indicates package names for Debian-derived distributions,
+"pkg" is for the FreeBSD package (maybe other common BSDs, too), and
+"rpm" is for RPM-based distributions (only known to work on Fedora).
+
+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, IMAP, NNTP, or gzipped mboxes)
+
+- Search::Xapian or Xapian(.pm) deb: libsearch-xapian-perl
+ pkg: p5-Search-Xapian OR p5-Xapian
+ rpm: perl-Search-Xapian
+ (HTTP and IMAP search)
+
+- Net::Server deb: libnet-server-perl
+ pkg: pkg-Net-Server
+ rpm: perl-Net-Server
+ (for HTTP/IMAP/NNTP background daemons,
+ not needed as systemd services or
+ foreground servers)
+
+- Inline::C deb: libinline-c-perl
+ pkg: pkg-Inline-C
+ rpm: perl-Inline (or perl-Inline-C)
+ (speeds up process spawning on Linux,
+ see public-inbox-daemon(8))
+
+- Email::Address::XS deb: libemail-address-xs-perl
+ pkg: pkg-Email-Address-XS
+ (correct parsing of tricky email
+ 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))
+
+- BSD::Resource deb: libbsd-resource-perl
+ pkg: p5-BSD-Resource
+ rpm: perl-BSD-Resource
+ (optional, for PSGI limiters
+ see public-inbox-config(5))
+
+- Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl
+ pkg: p5-Plack-Middleware-ReverseProxy
+ rpm: perl-Plack-Middleware-ReverseProxy
+ (ensures redirects are correct when running
+ behind nginx or Varnish)
+
+* highlight deb: libhighlight-perl
+ (for syntax highlighting with coderepo)
+
+* xapian-compact (tool) deb: xapian-tools
+ pkg: xapian-core
+ rpm: xapian-core
+ (optional, for public-inbox-compact(1))
+
+- Linux::Inotify2 deb: liblinux-inotify2-perl
+ rpm: perl-Linux-Inotify2
+ (for public-inbox-watch and -imapd on Linux)
+
+The following module is typically pulled in by dependencies listed
+above, so there is no need to explicitly install them:
+
+- DBI deb: libdbi-perl
+ pkg: p5-DBI
+ rpm: perl-DBI
+ (pulled in by DBD::SQLite)
+
+Uncommonly needed modules (see HACKING for development-only modules):
+
+- Socket6 deb: libsocket6-perl
+ pkg: p5-Socket6
+ rpm: perl-Socket6
+ (pulled in by SpamAssassin and Net::Server,
+ only necessary if using IPv6 with
+ Plack::Middleware::AccessLog or similar
+ on Perl <= 5.12)
+
+- Crypt::CBC deb: libcrypt-cbc-perl
+ pkg: p5-Crypt-CBC
+ (for PublicInbox::Unsubscribe (rarely used))
+
+standard MakeMaker installation (Perl)
+--------------------------------------
+
+To use MakeMaker, you need to ensure ExtUtils::MakeMaker is available.
+This is typically installed with Perl, but RPM-based systems will likely
+need to install the `perl-ExtUtils-MakeMaker' package.
+
+Once the dependencies are installed, you should be able to build and
+install the system (into /usr/local) with:
+
+ perl Makefile.PL
+ make
+ make test # see HACKING for faster tests for hackers
+ make install # root permissions may be needed