X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=INSTALL;h=2dd7dcff7013303091575e3c7e818a1fd50a6c8a;hp=4574311e0240b2e6fc33068c295cb7cf313ca5e9;hb=9f8184b0c8bd6bdb1f5f6c3845472c69863c1cf7;hpb=c9faf7cd4b0dc0c0e635a05fc75ae137cca40a79 diff --git a/INSTALL b/INSTALL index 4574311e..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: @@ -32,28 +33,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 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 @@ -69,7 +72,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 @@ -78,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)) @@ -97,6 +100,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: @@ -120,15 +128,28 @@ 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) -- IO::Compress::Gzip deb: perl-modules (or libio-compress-perl) - rpm: perl-PerlIO-gzip +- 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 - (for gzipped mbox over HTTP) + rpm: perl-IO-Compress + (for gzipped mbox over HTTP, v2 format) Uncommonly needed modules: @@ -146,28 +167,31 @@ 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: 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 @@ -187,5 +211,5 @@ the installation is complete. Copyright --------- -Copyright 2013-2019 all contributors +Copyright 2013-2020 all contributors License: AGPL-3.0+