X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=bb682942d7bdbd18f9840b7a735f3b601500e25a;hb=938cf615b743c62f5359285c2fd7da7b9f0ba6b0;hp=1c7370ecf4505f41e40f52474ab28ef06ae61d4d;hpb=bf798ee2f9fd31c58adf06e99ce56a7b9b9c5c74;p=public-inbox.git

diff --git a/INSTALL b/INSTALL
index 1c7370ec..bb682942 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,6 +1,15 @@
-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 http://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)
 --------------------------------------
 
@@ -12,11 +21,11 @@ standard MakeMaker installation (Perl)
 Requirements (server MDA)
 -------------------------
 * git
-* ssoma - http://ssoma.public-inbox.org/README
+* 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)
-  - CGI                        perl-modules[1]
   - Date::Parse                libtimedate-perl
   - Email::Address             libemail-address-perl
   - Email::Filter              libemail-filter-perl
@@ -24,18 +33,27 @@ Requirements (server MDA)
   - Email::MIME::ContentType   libemail-mime-contenttype-perl
   - Encode::MIME::Header       perl
   - File::Path::Expand         libfile-path-expand-perl
-  - IPC::Open2                 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:
+
+  - CGI[1]                     perl-modules[2]
+  - 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
 
 [1] - Only required for serving/generating Atom and HTML pages.
-      Keep in mind this will be split into a separate Debian package
+[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, FastCGI, and mod_perl2 will all be supported.
+      Plack/PSGI and mod_perl2 are both supported.
+[3] - Optional for HTML web interface and NNTP server
+[4] - Optional for NNTP server
 
 Copyright
 ---------
-Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
+Copyright 2013-2015 all contributors <meta@public-inbox.org>
 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>