X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=ccd9dac91926dbca7cefa7a661bde104e501c87b;hb=e041f5446ad266ee24e41a38e0090e2a65167606;hp=d57696e7bcc69a70295f52428853f5edd7171a34;hpb=bbba974cc2b93a13c79312fdc3a0567059471e2e;p=public-inbox.git
diff --git a/INSTALL b/INSTALL
index d57696e7..ccd9dac9 100644
--- a/INSTALL
+++ b/INSTALL
@@ -2,7 +2,7 @@ public-inbox (server-side) installation
---------------------------------------
This is for folks who want to setup their own public-inbox instance.
-Clients should see https://ssoma.public-inbox.org/INSTALL.html instead
+Clients should use normal git-clone/git-fetch, or NNTP clients
if they want to import mail into their personal inboxes.
TODO: this still needs to be documented better,
@@ -25,7 +25,7 @@ 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: libdatetime-perl
+* Date::Parse deb: libtimedate-perl
rpm: perl-Time-ParseDate
* Email::MIME deb: libemail-mime-perl
@@ -37,21 +37,19 @@ Beyond that, there is a long list of Perl modules required, starting with:
* Encode::MIME::Header deb: libencode-perl
rpm: perl-Encode
+* Plack deb: libplack-perl
+ rpm: perl-Plack, perl-Plack-Test,
+ (for HTML/Atom generation)
+
+* URI::Escape deb: liburi-perl
+ rpm: perl-URI
+ (for HTML/Atom generation)
+
Where "deb" indicates package names for Debian-derived distributions and
"rpm" is for RPM-based distributions (only known to work on Fedora).
Numerous optional modules are likely to be useful as well:
- - Plack deb: libplack-perl
- rpm: perl-Plack, perl-Plack-Test,
- perl-Plack-Middleware-ReverseProxy,
- perl-Plack-Middleware-Deflater
- (for HTML/Atom generation)
-
- - URI::Escape deb: liburi-perl
- rpm: perl-URI
- (for HTML/Atom generation)
-
- Search::Xapian deb: libsearch-xapian-perl
rpm: perl-Search-Xapian
(for NNTP service or gzipped mbox over HTTP)
@@ -74,16 +72,41 @@ Numerous optional modules are likely to be useful as well:
- Net::Server deb: libnet-server-perl
rpm: perl-Net-Server
- (for HTTP/NNTP servers as standalone daemons)
+ (for HTTP/NNTP servers as standalone daemons,
+ not needed as systemd services)
- Filesys::Notify::Simple deb: libfilesys-notify-simple-perl
rpm: perl-Filesys-Notify-Simple
(for public-inbox-watch)
+ - Inline::C[7] deb: libinline-c-perl
+ (speeds up spawning of git(1) on Linux
+ (see public-inbox-daemon(8))
+
+ - Plack::Middleware::ReverseProxy
+
+ deb: libplack-middleware-reverseproxy-perl
+ rpm: perl-Plack-Middleware-ReverseProxy
+ (ensures redirects are correct when running
+ behind nginx or Varnish)
+
+ - Plack::Middleware::Deflater
+
+ deb: libplack-middleware-deflater-perl
+ rpm: perl-Plack-Middleware-Deflater
+ (saves bandwidth on responses)
+
+ - Socket6 deb: libsocket6-perl
+ rpm: perl-Socket6
+ (pulled in by SpamAssassin and Net::Server,
+ only necessary if using IPv6 with
+ Plack::Middleware::AccessLog or similar)
On Fedora systems, you'll probably also end up wanting
perl-Test-HTTP-Server-Simple, perl-Devel-Peek, and perl-IPC-Run to run the
-test suite.
+test suite. On Debian systems, libxml-feed-perl and libipc-run-perl
+will aid in running the test suite (XML::Feed and IPC::Run respectively,
+on CPAN).
standard MakeMaker installation (Perl)
--------------------------------------
@@ -113,5 +136,5 @@ installation is complete.
Copyright
---------
-Copyright 2013-2018 all contributors
+Copyright 2013-2019 all contributors
License: AGPL-3.0+