user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
* [PATCH] doc: INSTALL: update with more distro info, symlink-install
@ 2021-04-23  6:12 Eric Wong
  0 siblings, 0 replies; only message in thread
From: Eric Wong @ 2021-04-23  6:12 UTC (permalink / raw)
  To: meta

---
 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

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2021-04-23  6:12 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-23  6:12 [PATCH] doc: INSTALL: update with more distro info, symlink-install Eric Wong

user/dev discussion of public-inbox itself

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ https://public-inbox.org/meta \
		meta@public-inbox.org
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/inbox.comp.mail.public-inbox.meta
	nntp://ie5yzdi7fg72h7s4sdcztq5evakq23rdt33mfyfcddc5u3ndnw24ogqd.onion/inbox.comp.mail.public-inbox.meta
	nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for project(s) associated with this inbox:

	https://80x24.org/public-inbox.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git