-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)
--------------------------------------
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
* 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::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:
+
+ - 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.
+[3] - Optional for HTML web interface and HTTP/NNTP servers
+[4] - Optional for HTTP and NNTP servers
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>