1 public-inbox (server-side) installation
2 ---------------------------------------
3 This is for folks who want to setup their own public-inbox instance.
4 Clients should see http://ssoma.public-inbox.org/INSTALL.html instead
5 if they want to import mail into their personal inboxes.
7 TODO: this still needs to be documented better,
8 also see the scripts/ and sa_config/ directories in the source tree
10 It should also be possible to use public-inbox with only IMAP
11 (or even POP(!)) access to a mailbox.
13 standard MakeMaker installation (Perl)
14 --------------------------------------
19 make install # root permissions may be needed
21 Requirements (server MDA)
22 -------------------------
24 * ssoma - http://ssoma.public-inbox.org/INSTALL.html
25 * SpamAssassin (spamc/spamd)
26 * MTA - postfix is recommended
27 * lynx (for converting HTML messages to text)
28 * Perl and several modules: (Debian package name)
29 - Date::Parse libtimedate-perl
30 - Email::Address libemail-address-perl
31 - Email::Filter libemail-filter-perl
32 - Email::MIME libemail-mime-perl
33 - Email::MIME::ContentType libemail-mime-contenttype-perl
34 - Encode::MIME::Header perl
35 - File::Path::Expand libfile-path-expand-perl
36 - IPC::Run libipc-run-perl
40 - CGI[1] perl-modules[2]
41 - Mail::Thread (2.5+)[1] libmail-thread-perl
42 - URI::Escape[1] liburi-perl
43 - Search::Xapian[3] libsearch-xapian-perl
44 - IO::Compress::Gzip[3] libio-compress-perl
46 - DBD::SQLite[3] libdbd-sqlite3-perl
47 - Danga::Socket[4] libdanga-socket-perl
49 [1] - Only required for serving/generating Atom and HTML pages.
50 [2] - Keep in mind this will be split into a separate Debian package
51 when CGI.pm is dropped from the Perl standard library.
52 Plack/PSGI and mod_perl2 are both supported.
53 [3] - Optional for HTML web interface and NNTP server
54 [4] - Optional for NNTP server
58 Copyright 2013-2015 all contributors <meta@public-inbox.org>
59 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>