X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=2dd7dcff7013303091575e3c7e818a1fd50a6c8a;hb=453dee4881a9c764b09d33f3a827879f2cd3669d;hp=137c9a54b1601dc6e0d75a29e5c9ff7816062204;hpb=56643bfddba2f7bca60955e5c48435fe58cc8e1c;p=public-inbox.git
diff --git a/INSTALL b/INSTALL
index 137c9a54..2dd7dcff 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:
@@ -39,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
@@ -72,16 +81,11 @@ 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))
-- Date::Parse deb: libtimedate-perl
- pkg: p5-TimeDate
- rpm: perl-TimeDate
- (for broken, mostly historical emails)
-
- Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl
pkg: p5-Plack-Middleware-ReverseProxy
rpm: perl-Plack-Middleware-ReverseProxy
@@ -135,17 +139,17 @@ 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)
- Filesys::Notify::KQueue pkg: p5-Filesys-Notify-KQueue
(for public-inbox-watch on FreeBSD)
-- IO::Compress::Gzip deb: perl-modules (or libio-compress-perl)
+- 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:
@@ -171,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)
--------------------------------------
@@ -187,7 +191,7 @@ install the system (into /usr/local) with:
perl Makefile.PL
make
- make test
+ make test # see HACKING for faster tests for hackers
make install # root permissions may be needed
When installing Search::Xapian, make sure the underlying Xapian
@@ -207,5 +211,5 @@ the installation is complete.
Copyright
---------
-Copyright 2013-2019 all contributors
+Copyright 2013-2020 all contributors
License: AGPL-3.0+