X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=7d14ca55cffcd86eab6c473db3d3a6d4eb037fd1;hb=1f7ea2f8a4a8bb502edd05ee13bad0c74f4ccbf5;hp=4d54e6a0d84ba767c4aef691a00a3bda7437c54d;hpb=53a35a1c53a5a01e5cadc2a70a437d390f7edd4b;p=public-inbox.git
diff --git a/INSTALL b/INSTALL
index 4d54e6a0..7d14ca55 100644
--- a/INSTALL
+++ b/INSTALL
@@ -21,9 +21,9 @@ Requirements
public-inbox requires a number of other packages to access its full
functionality. The core tools are, of course:
-* Git (1.8.0+, 2.6+ for writing v2 repositories)
+* Git (1.8.0+, 2.6+ for writing v2 inboxes)
* Perl 5.10.1+
-* DBD::SQLite (needed for NNTP, message threading, and v2 repositories)
+* DBD::SQLite (needed for NNTP, message threading, and v2 inboxes)
To accept incoming mail into a public inbox, you'll likely want:
@@ -32,10 +32,6 @@ 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
-
* Digest::SHA typically installed with Perl
rpm: perl-Digest-SHA
@@ -43,15 +39,23 @@ Beyond that, there is a long list of Perl modules required, starting with:
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
@@ -134,7 +138,7 @@ above, so there is no need to explicitly install them:
rpm: perl-Filesys-Notify-Simple
(for public-inbox-watch, pulled in by Plack)
-- Linux::Inotify deb: liblinux-inotify2-perl
+- Linux::Inotify2 deb: liblinux-inotify2-perl
rpm: perl-Linux-Inotify2
(for public-inbox-watch on Linux)
@@ -170,9 +174,9 @@ Optional packages testing and development:
pkg: perl5
rpm: perl-Test-Simple
-- XML::Feed deb: libxml-feed-perl
- pkg: p5-XML-Feed
- rpm: perl-XML-Feed
+- XML::TreePP deb: libxml-treepp-perl
+ pkg: p5-XML-TreePP
+ rpm: perl-XML-TreePP
standard MakeMaker installation (Perl)
--------------------------------------
@@ -185,7 +189,7 @@ Once the dependencies are installed, you should be able to build and
install the system (into /usr/local) with:
perl Makefile.PL
- make # GNU make is preferred, `gmake' on BSD systems
+ make
make test
make install # root permissions may be needed
@@ -206,5 +210,5 @@ the installation is complete.
Copyright
---------
-Copyright 2013-2019 all contributors
+Copyright 2013-2020 all contributors
License: AGPL-3.0+