X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=11d844cf1c9e8c3b4de293d5de158f19fa9b16bc;hb=1dc0f0c10fd856166a6726034de8aec53392901a;hp=7f12fbec97f16fc5d2343bc92555574ad8cc52e2;hpb=216ecf0404c79e0e4986a4717d10f6a029e4257b;p=public-inbox.git diff --git a/INSTALL b/INSTALL index 7f12fbec..11d844cf 100644 --- a/INSTALL +++ b/INSTALL @@ -23,18 +23,20 @@ Requirements ------------ * git -* SpamAssassin (spamc/spamd) -* MTA - postfix is recommended * Perl and several modules: (Debian package name) - Date::Parse libtimedate-perl - Email::MIME libemail-mime-perl - Email::MIME::ContentType libemail-mime-contenttype-perl - Encode::MIME::Header perl -Optional modules: +Optional components: + +* MTA - postfix is recommended (for public-inbox-mda) +* SpamAssassin (spamc/spamd) (for public-inbox-watch/public-inbox-mda) + +Optional Perl modules: - Plack[1] libplack-perl - - Mail::Thread (2.5+)[1] libmail-thread-perl - URI::Escape[1] liburi-perl - Search::Xapian[2][3] libsearch-xapian-perl - IO::Compress::Gzip[3] perl-modules (or libio-compress-perl) @@ -43,6 +45,9 @@ Optional modules: - 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 @@ -50,6 +55,8 @@ Optional modules: [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 When installing Search::Xapian, make sure the underlying Xapian installation is not affected by an index corruption bug: @@ -62,8 +69,16 @@ public-inbox will never store unregeneratable data in Xapian or any other search database we might use; Xapian corruption will not destroy critical data. +Optional Perl modules (for developers): + + - XML::Feed[9] libxml-feed-perl + - IPC::Run[10] libipc-run-perl + +[9] - Optional, for testing Atom feeds +[10] - Optional, for some tests (we hope to drop this dependency someday) + Copyright --------- -Copyright 2013-2016 all contributors +Copyright 2013-2018 all contributors License: AGPL-3.0+