X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=ca74c1cc71cedc3d52144a1cdd54cd7c33f22ddd;hb=34329921385d2489c2ea94eab73a6ad567863565;hp=bb682942d7bdbd18f9840b7a735f3b601500e25a;hpb=938cf615b743c62f5359285c2fd7da7b9f0ba6b0;p=public-inbox.git
diff --git a/INSTALL b/INSTALL
index bb682942..ca74c1cc 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,7 +1,8 @@
public-inbox (server-side) installation
---------------------------------------
+
This is for folks who want to setup their own public-inbox instance.
-Clients should see http://ssoma.public-inbox.org/INSTALL.html instead
+Clients should see https://ssoma.public-inbox.org/INSTALL.html instead
if they want to import mail into their personal inboxes.
TODO: this still needs to be documented better,
@@ -20,14 +21,13 @@ standard MakeMaker installation (Perl)
Requirements (server MDA)
-------------------------
+
* git
-* ssoma - http://ssoma.public-inbox.org/INSTALL.html
* SpamAssassin (spamc/spamd)
* MTA - postfix is recommended
* lynx (for converting HTML messages to text)
* Perl and several modules: (Debian package name)
- Date::Parse libtimedate-perl
- - Email::Address libemail-address-perl
- Email::Filter libemail-filter-perl
- Email::MIME libemail-mime-perl
- Email::MIME::ContentType libemail-mime-contenttype-perl
@@ -37,7 +37,7 @@ Requirements (server MDA)
Optional modules:
- - CGI[1] perl-modules[2]
+ - Plack[1] libplack-perl
- Mail::Thread (2.5+)[1] libmail-thread-perl
- URI::Escape[1] liburi-perl
- Search::Xapian[3] libsearch-xapian-perl
@@ -45,15 +45,38 @@ Optional modules:
- DBI[3] libdbi-perl
- DBD::SQLite[3] libdbd-sqlite3-perl
- Danga::Socket[4] libdanga-socket-perl
+ - Net::Server[4] libnet-server-perl
[1] - Only required for serving/generating Atom and HTML pages.
-[2] - Keep in mind this will be split into a separate Debian package
- when CGI.pm is dropped from the Perl standard library.
- Plack/PSGI and mod_perl2 are both supported.
-[3] - Optional for HTML web interface and NNTP server
-[4] - Optional for NNTP server
+[3] - Optional for HTML web interface and HTTP/NNTP servers
+[4] - Optional for HTTP and NNTP servers
+
+When installing Search::Xapian, make sure the underlying Xapian
+is patched against the index corruption bug documented in:
+
+ https://bugs.debian.org/808610
+
+For Debian 8.0, this means installing from jessie-backports
+until the fix lands in jessie.
+
+# Ensure the following line is in your apt sources.list(5)
+# (typically /etc/apt/sources.list):
+
+deb http://http.us.debian.org/debian jessie-backports main
+
+Then run:
+
+ apt-get update
+ apt-get install -t jessie-backports libxapian22
+
+to install the package.
+
+public-inbox will never store unregeneratable data in Xapian
+or any other search database we might use; Xapian corruption
+will not destroy critical data.
Copyright
---------
-Copyright 2013-2015 all contributors
-License: AGPLv3 or later
+
+Copyright 2013-2016 all contributors
+License: AGPL-3.0+