X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=6d5ef94c666974f1d5735db9dee53e00caa21406;hb=2710d3105e70ff467eff9e977325628b4e9dd1c5;hp=0246299be05816b47e9ed47627446434b14dcf28;hpb=e220b8b2ee5cfd458167dc2c6c92726352c4c80e;p=public-inbox.git diff --git a/INSTALL b/INSTALL index 0246299b..6d5ef94c 100644 --- a/INSTALL +++ b/INSTALL @@ -32,23 +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 +* 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 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 @@ -127,13 +134,20 @@ 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) +- 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: @@ -152,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 + +- Test::Simple deb: perl-modules-5.$MINOR + pkg: perl5 + rpm: perl-Test-Simple - XML::Feed deb: libxml-feed-perl pkg: p5-XML-Feed rpm: perl-XML-Feed -- 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?) - 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: