From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 95EFE1F5AE for ; Fri, 23 Apr 2021 06:12:49 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH] doc: INSTALL: update with more distro info, symlink-install Date: Fri, 23 Apr 2021 06:12:49 +0000 Message-Id: <20210423061249.7818-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: --- INSTALL | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/INSTALL b/INSTALL index 4da0227e..e1aa2c0e 100644 --- a/INSTALL +++ b/INSTALL @@ -5,13 +5,18 @@ 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, +listed in alphabetical order: Debian, 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. Most packages are available in other GNU/Linux distributions -and FreeBSD. +and FreeBSD. CentOS 7.x users will likely want newer git and +Xapian packages for better performance and v2 inbox support: +https://public-inbox.org/meta/20210421151308.yz5hzkgm75klunpe@nitro.local/ TODO: this still needs to be documented better, also see the scripts/ and sa_config/ directories in the source tree @@ -152,12 +157,22 @@ install the system (into /usr/local) with: make test # see HACKING for faster tests for hackers make install # root permissions may be needed -When installing Search::Xapian, make sure the underlying Xapian -installation is not affected by an index corruption bug: +symlink-install (public-inbox.git and 1.7.0+) +--------------------------------------------- - https://bugs.debian.org/808610 +For users who lack permissions and/or wish to minimize their +installation footprint, the "symlink-install" target is available in +public-inbox.git. The following installs symlinks to $HOME/bin +pointing to the source tree: + + perl Makefile.PL + make symlink-install prefix=$HOME -For Debian 8.x (jessie), this means using Debian 8.5 or later. +Other installation notes +------------------------ + +Debian 8.x (jessie) users, use Debian 8.5 or later if using Xapian: + https://bugs.debian.org/808610 public-inbox will never store unregeneratable data in Xapian or any other search database we might use; Xapian corruption