about summary refs log tree commit homepage
path: root/INSTALL
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2023-09-13 09:12:38 +0000
committerEric Wong <e@80x24.org>2023-09-14 10:06:22 +0000
commit50f041f9d2bf4988329787105769b7f04d263873 (patch)
treea84028ec01dfe9ccb4f173730e798e50f1bac6a8 /INSTALL
parentbdcfcf5deb1411b244b6f9a7d842c0ec14544297 (diff)
downloadpublic-inbox-50f041f9d2bf4988329787105769b7f04d263873.tar.gz
We'll also note that curl is used by lei and -clone.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL24
1 files changed, 13 insertions, 11 deletions
diff --git a/INSTALL b/INSTALL
index 13a1bdc6..4f473b78 100644
--- a/INSTALL
+++ b/INSTALL
@@ -5,17 +5,17 @@ This is for folks who want to set up 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 2022, public-inbox is packaged by several OS distributions,
+As of 2023, 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
 never depend on packages outside of the "main" component of
-the "stable" distribution, currently Debian 10.x ("buster"),
-but older versions of Debian remain supported.
+the "oldstable" distribution, currently Debian 11.x ("bullseye"),
+but older versions of Debian remain supported (as are newer ones).
 
-Most packages are available in other GNU/Linux distributions
-and FreeBSD.  CentOS 7.x users will likely want newer git and
-Xapian packages for better performance and v2 inbox support:
+Most packages are available in other GNU/Linux distributions,
+FreeBSD, NetBSD, and OpenBSD.  CentOS 7.x users will likely want
+newer git and Xapian for better performance and v2 inbox support:
 https://public-inbox.org/meta/20210421151308.yz5hzkgm75klunpe@nitro.local/
 
 TODO: this still needs to be documented better,
@@ -57,7 +57,7 @@ but required for older releases:
                                    (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
+"pkg" is for the FreeBSD package (and some other common BSDs, too), and
 "rpm" is for RPM-based distributions (only known to work on Fedora).
 
 Numerous optional modules are likely to be useful as well:
@@ -71,7 +71,7 @@ Numerous optional modules are likely to be useful as well:
                                    pkg: p5-Xapian (FreeBSD, NetBSD)
                                         xapian-bindings-perl (OpenBSD)
                                    rpm: perl-Search-Xapian
-                                   (HTTP and IMAP search)
+                                   (lei; HTTP and IMAP search)
 
 - Inline::C                        deb: libinline-c-perl
                                    pkg: p5-Inline-C
@@ -94,7 +94,8 @@ Numerous optional modules are likely to be useful as well:
 - Mail::IMAPClient                 deb: libmail-imapclient-perl
                                    pkg: p5-Mail-IMAPClient
                                    rpm: perl-Mail-IMAPClient
-                                   (only for lei and public-inbox-watch)
+                                   (only for lei and public-inbox-watch
+                                    when reading from IMAP)
 
 - BSD::Resource                    deb: libbsd-resource-perl
                                    pkg: p5-BSD-Resource
@@ -115,10 +116,11 @@ Numerous optional modules are likely to be useful as well:
                                    pkg: xapian-core
                                    rpm: xapian-core
                                    (for public-inbox-compact(1) and
-                                    public-inbox-cindex(1))
+                                    public-inbox-cindex(1))
 
 * curl (tool)                      deb, pkg, rpm: curl
-                                   (for HTTP(S) externals with curl)
+                                   (for lei HTTP(S) externals with curl and
+                                    public-inbox-clone(1))
 
 - Linux::Inotify2                  deb: liblinux-inotify2-perl
                                    rpm: perl-Linux-Inotify2