X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=3984df718f95684c28865fba89812d18a42b8ef9;hb=90dc2b8ca53f93ca937e7cc71cd7c915e3df8020;hp=a661c77672ba1aa96315f8f7dd245dbf5bfca298;hpb=d9aad3a7988262b31ab2171f2c982daf04ac822c;p=public-inbox.git
diff --git a/INSTALL b/INSTALL
index a661c776..3984df71 100644
--- a/INSTALL
+++ b/INSTALL
@@ -7,7 +7,8 @@ if they want to import mail into their personal inboxes.
public-inbox is developed on Debian GNU/Linux systems and will
never depend on packages outside of the "main" component of
-the "stable" distribution, currently Debian 9.x ("stretch")
+the "stable" distribution, currently Debian 10.x ("buster"),
+but older versions of Debian remain supported.
Most packages are available in other GNU/Linux distributions
and FreeBSD.
@@ -21,9 +22,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 +33,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 +40,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 are optional as of public-inbox v1.3.0,
+but required for 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
@@ -76,7 +81,7 @@ Numerous optional modules are likely to be useful as well:
not needed as systemd services or
foreground servers)
-- Inline::C[7] deb: libinline-c-perl
+- Inline::C deb: libinline-c-perl
pkg: pkg-Inline-C
(speeds up process spawning on Linux,
see public-inbox-daemon(8))
@@ -130,14 +135,21 @@ above, so there is no need to explicitly install them:
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)
-- IO::Compress::Gzip deb: perl-modules (or libio-compress-perl)
+- 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)
pkg: perl5
rpm: perl-IO-Compress
- (for gzipped mbox over HTTP)
+ (for gzipped mbox over HTTP, v2 format)
Uncommonly needed modules:
@@ -155,10 +167,6 @@ 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
@@ -167,9 +175,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)
--------------------------------------
@@ -203,5 +211,5 @@ the installation is complete.
Copyright
---------
-Copyright 2013-2019 all contributors
+Copyright 2013-2020 all contributors
License: AGPL-3.0+