X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=INSTALL;h=0974028d0f73014bd8eb2e7c345441c0df3d6e28;hp=eb939a59d596c0f20e7f03f931791b4337b9dee5;hb=HEAD;hpb=47ad2954fa34cdc75fa5c56f38f352d77afba553 diff --git a/INSTALL b/INSTALL index eb939a59..aa9a502d 100644 --- a/INSTALL +++ b/INSTALL @@ -5,7 +5,7 @@ This is for folks who want to setup their own public-inbox instance. Clients should use normal git-clone/git-fetch, IMAP or NNTP clients if they want to import mail into their personal inboxes. -As of 2021, public-inbox is packaged by several OS distributions, +As of 2022, public-inbox is packaged by several OS distributions, listed in alphabetical order: Debian, GNU Guix, NixOS, and Void Linux. public-inbox is developed on Debian GNU/Linux systems and will @@ -28,7 +28,7 @@ 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 inboxes) -* Perl 5.10.1+ +* Perl 5.12.0+ * DBD::SQLite (needed for IMAP, NNTP, message threading, and v2 inboxes) To accept incoming mail into a public inbox, you'll likely want: @@ -72,13 +72,6 @@ Numerous optional modules are likely to be useful as well: rpm: perl-Search-Xapian (HTTP and IMAP search) -- Net::Server deb: libnet-server-perl - pkg: pkg-Net-Server - rpm: perl-Net-Server - (for HTTP/IMAP/NNTP background daemons, - not needed as systemd services or - foreground servers) - - Inline::C deb: libinline-c-perl pkg: pkg-Inline-C rpm: perl-Inline (or perl-Inline-C) @@ -96,6 +89,11 @@ Numerous optional modules are likely to be useful as well: rpm: perl-ParseRecDescent (optional, for public-inbox-imapd(1)) +- Mail::IMAPClient deb: libmail-imapclient-perl + pkg: p5-Mail-IMAPClient + rpm: perl-Mail-IMAPClient + (optional for lei and public-inbox-watch) + - BSD::Resource deb: libbsd-resource-perl pkg: p5-BSD-Resource rpm: perl-BSD-Resource @@ -116,9 +114,24 @@ Numerous optional modules are likely to be useful as well: rpm: xapian-core (optional, for public-inbox-compact(1)) +* curl (tool) deb, pkg, rpm: curl + (for HTTP(S) externals with curl) + - Linux::Inotify2 deb: liblinux-inotify2-perl rpm: perl-Linux-Inotify2 - (for public-inbox-watch and -imapd on Linux) + (for lei, public-inbox-watch and -imapd + on Linux) + +- IO::KQueue pkg: p5-IO-KQueue + (for lei, public-inbox-watch and -imapd + on *BSDs) + +- Net::Server deb: libnet-server-perl + pkg: pkg-Net-Server + rpm: perl-Net-Server + (for HTTP/IMAP/NNTP background daemons, + not needed as systemd services or + foreground servers) The following module is typically pulled in by dependencies listed above, so there is no need to explicitly install them: @@ -197,5 +210,5 @@ RPM-based distros split them out into separate packages: Copyright --------- -Copyright 2013-2021 all contributors +Copyright all contributors License: AGPL-3.0+