X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=2a9bd34e12468ed2e6e822127d8d1fb20318e427;hb=e2ed3be62fbb53e16a9248a408a7a069a05842e6;hp=dd85d5e0a04474ff485c882efa24c29db1fba0e8;hpb=329736d51862b767cdaecf5c13a53e642164fbae;p=public-inbox.git

diff --git a/INSTALL b/INSTALL
index dd85d5e0..2a9bd34e 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,6 +1,14 @@
-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.
+
+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)
 --------------------------------------
 
@@ -9,28 +17,38 @@ standard MakeMaker installation (Perl)
 	make test
 	make install # root permissions may be needed
 
-Requirements (MUA client)
--------------------------
-* git
-* ssoma - http://ssoma.public-inbox.org/README
-* Perl and several modules:
-    - Email::LocalDelivery
-    - Email::Filter
-    - Email::Simple
-    - Digest::SHA
-
 Requirements (server MDA)
 -------------------------
 * git
+* ssoma - http://ssoma.public-inbox.org/INSTALL.html
 * SpamAssassin (spamc/spamd)
 * MTA - postfix is recommended
-* ssoma - http://ssoma.public-inbox.org/README
-* Perl and several modules:
-    - Email::Simple
-    - File::FcntlLock
-    - Digest::SHA
+* 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
+  - Encode::MIME::Header       perl
+  - File::Path::Expand         libfile-path-expand-perl
+  - IPC::Run                   libipc-run-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
+
+[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
 
 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>