+Requirements
+------------
+
+public-inbox requires a number of other packages to access its full
+functionality. The core tools are, of course:
+
+* Git
+* Perl
+* SQLite (needed for Xapian use)
+
+To accept incoming mail into a public inbox, you'll likely want:
+
+* MTA - postfix is recommended (for public-inbox-mda)
+* SpamAssassin (spamc/spamd) (for public-inbox-watch/public-inbox-mda)
+
+Beyond that, there is a long list of Perl modules required, starting with:
+
+* Date::Parse deb: libdatetime-perl
+ rpm: perl-Time-ParseDate
+
+* Email::MIME deb: libemail-mime-perl
+ rpm: perl-Email-MIME
+
+* Email::MIME::ContentType deb: libemail-mime-contenttype-perl
+ rpm: perl-Email-MIME-ContentType
+
+* Encode::MIME::Header deb: libencode-perl
+ rpm: perl-Encode
+
+Where "deb" indicates package names for Debian-derived distributions and
+"rpm" is for RPM-based distributions (only known to work on Fedora).
+
+Numerous optional modules are likely to be useful as well:
+
+ - Plack deb: libplack-perl
+ rpm: perl-Plack, perl-Plack-Test,
+ (for HTML/Atom generation)
+
+ - URI::Escape deb: liburi-perl
+ rpm: perl-URI
+ (for HTML/Atom generation)
+
+ - Search::Xapian deb: libsearch-xapian-perl
+ rpm: perl-Search-Xapian
+ (for NNTP service or gzipped mbox over HTTP)
+
+ - IO::Compress::Gzip deb: perl-modules (or libio-compress-perl)
+ rpm: perl-PerlIO-gzip
+ (for gzipped mbox over HTTP)
+
+ - DBI deb: libdbi-perl
+ rpm: perl-DBI
+ (for gzipped mbox over HTTP)
+
+ - DBD::SQLite deb: libdbd-sqlite3-perl
+ rpm: perl-DBD-SQLite
+ (for NNTP service or gzipped mbox over HTTP)
+
+ - Danga::Socket deb: libdanga-socket-perl
+ rpm: perl-Danga-Socket
+ (for bundled HTTP and NNTP servers)
+
+ - Net::Server deb: libnet-server-perl
+ rpm: perl-Net-Server
+ (for HTTP/NNTP servers as standalone daemons)
+
+ - Filesys::Notify::Simple deb: libfilesys-notify-simple-perl
+ rpm: perl-Filesys-Notify-Simple
+ (for public-inbox-watch)
+
+ - Inline::C[7] deb: libinline-c-perl
+ (speeds up spawning on Linux
+ (see public-inbox-daemon(8))
+
+ - Plack::Middleware::ReverseProxy
+
+ deb: libplack-middleware-reverseproxy-perl
+ rpm: perl-Plack-Middleware-ReverseProxy
+ (ensures redirects are correct when running
+ behind nginx or Varnish)
+
+ - Plack::Middleware::Deflater
+
+ deb: libplack-middleware-deflater-perl
+ rpm: perl-Plack-Middleware-Deflater
+ (saves bandwidth on responses)
+
+
+On Fedora systems, you'll probably also end up wanting
+perl-Test-HTTP-Server-Simple, perl-Devel-Peek, and perl-IPC-Run to run the
+test suite. On Debian systems, libxml-feed-perl and libipc-run-perl(*)
+will aid in running the test suite (XML::Feed and IPC::Run respectively,
+on CPAN).
+
+(*) we hope to drop this dependency someday