]> Sergey Matveev's repositories - public-inbox.git/blobdiff - INSTALL
doc: minor updates to trim down the README
[public-inbox.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 0e9ab6d678a80a480565ee44f97db93cb903fbe2..bb682942d7bdbd18f9840b7a735f3b601500e25a 100644 (file)
--- 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 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
@@ -25,7 +26,6 @@ Requirements (server MDA)
 * MTA - postfix is recommended
 * lynx (for converting HTML messages to text)
 * Perl and several modules:    (Debian package name)
-  - CGI[1]                     perl-modules[2]
   - Date::Parse                libtimedate-perl
   - Email::Address             libemail-address-perl
   - Email::Filter              libemail-filter-perl
@@ -34,16 +34,26 @@ Requirements (server MDA)
   - 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
-  - XML::Atom::SimpleFeed[1]   libxml-atom-simplefeed-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.
 [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
 
 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>