X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=INSTALL;h=11d844cf1c9e8c3b4de293d5de158f19fa9b16bc;hp=25cc3c9c4046872225983f539a6ed772c7372849;hb=87425172fb480214c3f72e0174f4f8f15f48d92d;hpb=4d254238299f950c4a7f94ffd2e0c1fba28c74a4 diff --git a/INSTALL b/INSTALL index 25cc3c9c..11d844cf 100644 --- a/INSTALL +++ b/INSTALL @@ -19,63 +19,66 @@ standard MakeMaker installation (Perl) make test make install # root permissions may be needed -Requirements (server MDA) -------------------------- +Requirements +------------ * git -* SpamAssassin (spamc/spamd) -* MTA - postfix is recommended -* lynx (for converting HTML messages to text) * Perl and several modules: (Debian package name) - Date::Parse libtimedate-perl - - Email::Filter libemail-filter-perl - Email::MIME libemail-mime-perl - Email::MIME::ContentType libemail-mime-contenttype-perl - Encode::MIME::Header perl - - IPC::Run libipc-run-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[3] libsearch-xapian-perl - - IO::Compress::Gzip[3] libio-compress-perl + - Search::Xapian[2][3] libsearch-xapian-perl + - IO::Compress::Gzip[3] perl-modules (or libio-compress-perl) - DBI[3] libdbi-perl - - DBD::SQLite[3] libdbd-sqlite3-perl + - DBD::SQLite[2][3] libdbd-sqlite3-perl - Danga::Socket[4] libdanga-socket-perl - - Net::Server[4] libnet-server-perl - -[1] - Only required for serving/generating Atom and HTML pages. -[3] - Optional for HTML web interface and HTTP/NNTP servers -[4] - Optional for HTTP and NNTP servers + - 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 When installing Search::Xapian, make sure the underlying Xapian -is patched against the index corruption bug documented in: +installation is not affected by an index corruption bug: https://bugs.debian.org/808610 -For Debian 8.0, this means installing from jessie-backports -until the fix lands in jessie. - -# Ensure the following line is in your apt sources.list(5) -# (typically /etc/apt/sources.list): - -deb http://http.us.debian.org/debian jessie-backports main - -Then run: - - apt-get update - apt-get install -t jessie-backports libxapian22 - -to install the package. +For Debian 8.x (jessie), this means using Debian 8.5 or later. 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+