From: Eric Wong <e@80x24.org>
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 [thread overview]
Message-ID: <20210423061249.7818-1-e@80x24.org> (raw)
---
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
reply other threads:[~2021-04-23 6:12 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210423061249.7818-1-e@80x24.org \
--to=e@80x24.org \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).