X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=54c344c7af1b486ab8191a8a592b6c814ed1378f;hb=8968889e3ebfa09dd2c80fe8b917b83ac13ff356;hp=1bfb69f10ec4b85bf06ddf999240245310cb792f;hpb=cd195aaa6552b44385417827842d34f27fc84224;p=public-inbox.git diff --git a/INSTALL b/INSTALL index 1bfb69f1..54c344c7 100644 --- a/INSTALL +++ b/INSTALL @@ -1,7 +1,9 @@ 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 @@ -19,13 +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) - - CGI[1] perl-modules[2] - Date::Parse libtimedate-perl - Email::Address libemail-address-perl - Email::Filter libemail-filter-perl @@ -34,16 +36,24 @@ Requirements (server MDA) - Encode::MIME::Header perl - File::Path::Expand libfile-path-expand-perl - IPC::Run libipc-run-perl + +Optional modules: + + - Plack[1] libplack-perl - 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, FastCGI, and mod_perl2 will all be supported. +[3] - Optional for HTML web interface and NNTP server +[4] - Optional for NNTP server Copyright --------- -Copyright 2013, Eric Wong and all contributors. + +Copyright 2013-2015 all contributors License: AGPLv3 or later