X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=de871b1afde1bafcd9f038263d7cf2c837ad80d2;hb=9dfc0b670fc634b54998c3020f173b82de1915ac;hp=2dd7dcff7013303091575e3c7e818a1fd50a6c8a;hpb=4bebfa0c80ad7f4596a7dca98b39121470a42af0;p=public-inbox.git diff --git a/INSTALL b/INSTALL index 2dd7dcff..de871b1a 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 use normal git-clone/git-fetch, or NNTP clients +Clients should use normal git-clone/git-fetch, IMAP or NNTP clients if they want to import mail into their personal inboxes. public-inbox is developed on Debian GNU/Linux systems and will @@ -24,7 +24,7 @@ functionality. The core tools are, of course: * Git (1.8.0+, 2.6+ for writing v2 inboxes) * Perl 5.10.1+ -* DBD::SQLite (needed for NNTP, message threading, and v2 inboxes) +* DBD::SQLite (needed for IMAP, NNTP, message threading, and v2 inboxes) To accept incoming mail into a public inbox, you'll likely want: @@ -36,15 +36,18 @@ Beyond that, there is a long list of Perl modules required, starting with: * 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) +Email::MIME will be optional as of public-inbox v1.5.0, +it may still be used in maintainer comparison tests: + +* Email::MIME deb: libemail-mime-perl + pkg: p5-Email-MIME + rpm: perl-Email-MIME + Plack and Date::Parse are optional as of public-inbox v1.3.0, but required for older releases: @@ -67,17 +70,17 @@ Numerous optional modules are likely to be useful as well: - DBD::SQLite deb: libdbd-sqlite3-perl pkg: p5-DBD-SQLite rpm: perl-DBD-SQLite - (for v2, NNTP, or gzipped mboxes) + (for v2, IMAP, NNTP, or gzipped mboxes) - Search::Xapian deb: libsearch-xapian-perl pkg: p5-Search-Xapian rpm: perl-Search-Xapian - (HTTP search) + (HTTP and IMAP search) - Net::Server deb: libnet-server-perl pkg: pkg-Net-Server rpm: perl-Net-Server - (for HTTP/NNTP background daemons, + (for HTTP/IMAP/NNTP background daemons, not needed as systemd services or foreground servers) @@ -86,17 +89,24 @@ Numerous optional modules are likely to be useful as well: (speeds up process spawning on Linux, see public-inbox-daemon(8)) +- Email::Address::XS deb: libemail-address-xs-perl + pkg: pkg-Email-Address-XS + (correct parsing of tricky email + addresses, phrases and comments, + required for IMAP) + +- Parse::RecDescent deb: libparse-recdescent-perl + pkg: p5-Parse-RecDescent + rpm: perl-ParseRecDescent + (optional, for public-inbox-imapd(1)) + + - Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl pkg: p5-Plack-Middleware-ReverseProxy rpm: perl-Plack-Middleware-ReverseProxy (ensures redirects are correct when running behind nginx or Varnish) -- Plack::Middleware::Deflater deb: libplack-middleware-deflater-perl - pkg: p5 -Plack-Middleware-Deflater - rpm: perl-Plack-Middleware-Deflater - (saves bandwidth on responses) - * highlight deb: libhighlight-perl (for syntax highlighting with coderepo) @@ -108,16 +118,6 @@ Numerous optional modules are likely to be useful as well: The following modules are typically pulled in by dependencies listed above, so there is no need to explicitly install them: -- Email::MIME::ContentType deb: libemail-mime-contenttype-perl - pkg: p5-Email-MIME-ContentType - rpm: perl-Email-MIME-ContentType - (pulled in by Email::MIME) - -- Email::Simple deb: libemail-simple-perl - pkg: p5-Email-Simple - rpm: perl-Email-Simple - (pulled in by Email::MIME) - * Encode deb: libperl5.$MINOR (or libencode-perl) pkg: perl5 rpm: perl-Encode @@ -134,17 +134,9 @@ above, so there is no need to explicitly install them: (optional for stale FD cleanup in daemons, typically installed alongside Perl5) -- Filesys::Notify::Simple deb: libfilesys-notify-simple-perl - 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) + (for public-inbox-watch and -imapd on Linux) - IO::Compress (::Gzip) deb: perl-modules (or libio-compress-perl) pkg: perl5 @@ -211,5 +203,5 @@ the installation is complete. Copyright --------- -Copyright 2013-2020 all contributors +Copyright 2013-2021 all contributors License: AGPL-3.0+