X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=e7d4b752224b1d7d206a0ca51e859553b182a63c;hb=5e800c1aac067ec42cc6bcac10a0c339467a26d6;hp=8e512a63a37f9614d4f25adee859f6f42177f58c;hpb=546ff31b4c11d74f63aa4501659224dbf864c21c;p=public-inbox.git

diff --git a/INSTALL b/INSTALL
index 8e512a63..e7d4b752 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,6 +1,16 @@
-Note: this still needs to be documented better,
+public-inbox (server-side) installation
+---------------------------------------
+
+This is for folks who want to setup their own public-inbox instance.
+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,
 also see the scripts/ and sa_config/ directories in the source tree
 
+It should also be possible to use public-inbox with only IMAP
+(or even POP(!)) access to a mailbox.
+
 standard MakeMaker installation (Perl)
 --------------------------------------
 
@@ -11,31 +21,45 @@ standard MakeMaker installation (Perl)
 
 Requirements (server MDA)
 -------------------------
+
 * git
-* ssoma - http://ssoma.public-inbox.org/README
 * SpamAssassin (spamc/spamd)
 * MTA - postfix is recommended
-* lynx (for converting HTML messages to text)
 * Perl and several modules:    (Debian package name)
-  - CGI                        perl-modules[1]
   - 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
   - Encode::MIME::Header       perl
-  - File::Path::Expand         libfile-path-expand-perl
-  - IPC::Run                   libipc-run-perl
-  - Mail::Thread (2.5+)        libmail-thread-perl
-  - URI::Escape                liburi-perl
-  - XML::Atom::SimpleFeed      libxml-atom-simplefeed-perl
+
+Optional modules:
+
+  - Plack[1]                   libplack-perl
+  - Mail::Thread (2.5+)[1]     libmail-thread-perl
+  - URI::Escape[1]             liburi-perl
+  - Search::Xapian[3]          libsearch-xapian-perl
+  - IO::Compress::Gzip[3]      libio-compress-perl
+  - 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.
-      Keep in mind this will be split into a separate Debian package
-      when CGI.pm is dropped from the Perl standard library.
-      Plack/PSGI, FastCGI, and mod_perl2 will all be supported.
+[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.x (jessie), this means using Debian 8.5 or later.
+
+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, Eric Wong <normalperson@yhbt.net> and all contributors.
-License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
+
+Copyright 2013-2016 all contributors <meta@public-inbox.org>
+License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>