X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=7d14ca55cffcd86eab6c473db3d3a6d4eb037fd1;hb=1f7ea2f8a4a8bb502edd05ee13bad0c74f4ccbf5;hp=99836c13695e62fcc6d5fa0830d5ae114b4f0379;hpb=d06475cc90b2d1f43ef8454d56ddb19e6293a385;p=public-inbox.git
diff --git a/INSTALL b/INSTALL
index 99836c13..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,32 +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
-* Encode::MIME::Header deb: libencode-perl
- pkg: perl5
- rpm: perl-Encode
+* 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
@@ -73,7 +71,7 @@ Numerous optional modules are likely to be useful as well:
- Search::Xapian deb: libsearch-xapian-perl
pkg: p5-Search-Xapian
rpm: perl-Search-Xapian
- (for v2, HTTP search)
+ (HTTP search)
- Net::Server deb: libnet-server-perl
pkg: pkg-Net-Server
@@ -101,6 +99,11 @@ Numerous optional modules are likely to be useful as well:
* highlight deb: libhighlight-perl
(for syntax highlighting with coderepo)
+* xapian-compact (tool) deb: xapian-tools
+ pkg: xapian-core
+ rpm: xapian-core
+ (optional, for public-inbox-compact(1))
+
The following modules are typically pulled in by dependencies listed
above, so there is no need to explicitly install them:
@@ -114,19 +117,37 @@ above, so there is no need to explicitly install them:
rpm: perl-Email-Simple
(pulled in by Email::MIME)
+* Encode deb: libperl5.$MINOR (or libencode-perl)
+ pkg: perl5
+ rpm: perl-Encode
+ (likely installed with Perl)
+
- DBI deb: libdbi-perl
pkg: p5-DBI
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:
@@ -145,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:
@@ -186,5 +210,5 @@ the installation is complete.
Copyright
---------
-Copyright 2013-2019 all contributors
+Copyright 2013-2020 all contributors
License: AGPL-3.0+