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
22 Requirements (server MDA)
23 -------------------------
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
33 - IPC::Run libipc-run-perl
37 - Plack[1] libplack-perl
38 - Mail::Thread (2.5+)[1] libmail-thread-perl
39 - URI::Escape[1] liburi-perl
40 - Search::Xapian[3] libsearch-xapian-perl
41 - IO::Compress::Gzip[3] libio-compress-perl
43 - DBD::SQLite[3] libdbd-sqlite3-perl
44 - Danga::Socket[4] libdanga-socket-perl
45 - Net::Server[4] libnet-server-perl
47 [1] - Only required for serving/generating Atom and HTML pages.
48 [3] - Optional for HTML web interface and HTTP/NNTP servers
49 [4] - Optional for HTTP and NNTP servers
51 When installing Search::Xapian, make sure the underlying Xapian
52 is patched against the index corruption bug documented in:
54 https://bugs.debian.org/808610
56 For Debian 8.0, this means installing from jessie-backports
57 until the fix lands in jessie.
59 # Ensure the following line is in your apt sources.list(5)
60 # (typically /etc/apt/sources.list):
62 deb http://http.us.debian.org/debian jessie-backports main
67 apt-get install -t jessie-backports libxapian22
69 to install the package.
71 public-inbox will never store unregeneratable data in Xapian
72 or any other search database we might use; Xapian corruption
73 will not destroy critical data.
78 Copyright 2013-2016 all contributors <meta@public-inbox.org>
79 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>