---------------------------------------
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,
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
* 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)
+ - Socket6 deb: libsocket6-perl
+ rpm: perl-Socket6
+ (for IPv6 support)
- Search::Xapian deb: libsearch-xapian-perl
rpm: perl-Search-Xapian
rpm: perl-Filesys-Notify-Simple
(for public-inbox-watch)
+ - Inline::C[7] deb: libinline-c-perl
+ (speeds up spawning 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)
+
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)
--------------------------------------
Copyright
---------
-Copyright 2013-2018 all contributors <meta@public-inbox.org>
+Copyright 2013-2019 all contributors <meta@public-inbox.org>
License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>