X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=bf1c821a9448602d18c21faf3f761ec67272db38;hb=faa0f744db6047db0594baf00535cc8122211ede;hp=72e0763c417166d78381087a6b5d0dab336a4d91;hpb=0b1de991a099b5e8b9a9e3e85b5eaaacc9362dbb;p=public-inbox.git
diff --git a/INSTALL b/INSTALL
index 72e0763c..bf1c821a 100644
--- a/INSTALL
+++ b/INSTALL
@@ -32,28 +32,30 @@ To accept incoming mail into a public inbox, you'll likely want:
Beyond that, there is a long list of Perl modules required, starting with:
-* Date::Parse deb: libtimedate-perl
- pkg: p5-TimeDate
- rpm: perl-TimeDate
-
-* Devel::Peek deb: libperl5.$MINOR (e.g. libperl5.24)
- pkg: perl5
- rpm: perl-Devel-Peek
- (typically installed alongside Perl5)
+* Digest::SHA typically installed with Perl
+ rpm: perl-Digest-SHA
* Email::MIME deb: libemail-mime-perl
pkg: p5-Email-MIME
rpm: perl-Email-MIME
+* URI::Escape deb: liburi-perl
+ pkg: p5-URI
+ rpm: perl-URI
+ (for HTML/Atom generation)
+
+Plack and Date::Parse will be optional when v1.3.0 is released,
+but required for current and older releases:
+
* Plack deb: libplack-perl
pkg: p5-Plack
rpm: perl-Plack, perl-Plack-Test,
(for HTML/Atom generation)
-* URI::Escape deb: liburi-perl
- pkg: p5-URI
- rpm: perl-URI
- (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
@@ -125,14 +127,27 @@ above, so there is no need to explicitly install them:
rpm: perl-DBI
(pulled in by DBD::SQLite)
+* Devel::Peek deb: libperl5.$MINOR (e.g. libperl5.24)
+ pkg: perl5
+ rpm: perl-Devel-Peek
+ (optional for stale FD cleanup in daemons,
+ typically installed alongside Perl5)
+
- Filesys::Notify::Simple deb: libfilesys-notify-simple-perl
- pkg: pkg-Filesys-Notify-Simple
+ pkg: p5-Filesys-Notify-Simple
rpm: perl-Filesys-Notify-Simple
(for public-inbox-watch, pulled in by Plack)
+- Linux::Inotify2 deb: liblinux-inotify2-perl
+ rpm: perl-Linux-Inotify2
+ (for public-inbox-watch on Linux)
+
+- Filesys::Notify::KQueue pkg: p5-Filesys-Notify-KQueue
+ (for public-inbox-watch on FreeBSD)
+
- IO::Compress::Gzip deb: perl-modules (or libio-compress-perl)
- rpm: perl-PerlIO-gzip
pkg: perl5
+ rpm: perl-IO-Compress
(for gzipped mbox over HTTP)
Uncommonly needed modules:
@@ -151,22 +166,25 @@ Uncommonly needed modules:
Optional packages testing and development:
-- IPC::Run deb: libipc-run-perl
- pkg: p5-IPC-Run
- rpm: perl-IPC-Run
+- Plack::Test deb: libplack-test-perl
+ pkg: p5-Plack
+ rpm: perl-Plack-Test
-- XML::Feed deb: libxml-feed-perl
- pkg: p5-XML-Feed
- rpm: perl-XML-Feed
+- Test::Simple deb: perl-modules-5.$MINOR
+ pkg: perl5
+ rpm: perl-Test-Simple
-- Test::HTTP::Server::Simple deb: libtest-http-server-simple-perl
- pkg: p5-Test-HTTP-Server-Simple
- rpm: perl-Test-HTTP-Server-Simple
- (XXX is this really needed?)
+- XML::TreePP deb: libxml-treepp-perl
+ pkg: p5-XML-TreePP
+ rpm: perl-XML-TreePP
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:
@@ -192,5 +210,5 @@ the installation is complete.
Copyright
---------
-Copyright 2013-2019 all contributors
+Copyright 2013-2020 all contributors
License: AGPL-3.0+