1 public-inbox (server-side) installation
2 ---------------------------------------
4 This is for folks who want to setup their own public-inbox instance.
5 Clients should see https://ssoma.public-inbox.org/INSTALL.html instead
6 if they want to import mail into their personal inboxes.
8 TODO: this still needs to be documented better,
9 also see the scripts/ and sa_config/ directories in the source tree
11 It should also be possible to use public-inbox with only IMAP
12 (or even POP(!)) access to a mailbox.
14 standard MakeMaker installation (Perl)
15 --------------------------------------
20 make install # root permissions may be needed
26 * SpamAssassin (spamc/spamd)
27 * MTA - postfix is recommended
28 * Perl and several modules: (Debian package name)
29 - Date::Parse libtimedate-perl
30 - Email::MIME libemail-mime-perl
31 - Email::MIME::ContentType libemail-mime-contenttype-perl
32 - Encode::MIME::Header perl
36 - Plack[1] libplack-perl
37 - Mail::Thread (2.5+)[1] libmail-thread-perl
38 - URI::Escape[1] liburi-perl
39 - Search::Xapian[2][3] libsearch-xapian-perl
40 - IO::Compress::Gzip[3] perl-modules (or libio-compress-perl)
42 - DBD::SQLite[2][3] libdbd-sqlite3-perl
43 - Danga::Socket[4] libdanga-socket-perl
44 - Net::Server[5] libnet-server-perl
45 - Filesys::Notify::Simple[6] libfilesys-notify-simple-perl
47 [1] - Optional, needed for serving/generating Atom and HTML pages
48 [2] - Optional, only required for NNTP server
49 [3] - Optional, needed for gzipped mbox support over HTTP
50 [4] - Optional, needed for bundled HTTP and NNTP servers
51 [5] - Optional, needed for standalone daemonization of HTTP+NNTP servers
52 [6] - Optional, needed for public-inbox-watch Maildir watcher
54 When installing Search::Xapian, make sure the underlying Xapian
55 installation is not affected by an index corruption bug:
57 https://bugs.debian.org/808610
59 For Debian 8.x (jessie), this means using Debian 8.5 or later.
61 public-inbox will never store unregeneratable data in Xapian
62 or any other search database we might use; Xapian corruption
63 will not destroy critical data.
68 Copyright 2013-2016 all contributors <meta@public-inbox.org>
69 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>