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
14 public-inbox requires a number of other packages to access its full
15 functionality. The core tools are, of course:
19 * SQLite (needed for Xapian use)
21 To accept incoming mail into a public inbox, you'll likely want:
23 * MTA - postfix is recommended (for public-inbox-mda)
24 * SpamAssassin (spamc/spamd) (for public-inbox-watch/public-inbox-mda)
26 Beyond that, there is a long list of Perl modules required, starting with:
28 * Date::Parse deb: libdatetime-perl
29 rpm: perl-Time-ParseDate
31 * Email::MIME deb: libemail-mime-perl
34 * Email::MIME::ContentType deb: libemail-mime-contenttype-perl
35 rpm: perl-Email-MIME-ContentType
37 * Encode::MIME::Header deb: libencode-perl
40 Where "deb" indicates package names for Debian-derived distributions and
41 "rpm" is for RPM-based distributions (only known to work on Fedora).
43 Numerous optional modules are likely to be useful as well:
45 - Plack deb: libplack-perl
46 rpm: perl-Plack, perl-Plack-Test,
47 perl-Plack-Middleware-ReverseProxy,
48 perl-Plack-Middleware-Deflater
49 (for HTML/Atom generation)
51 - URI::Escape deb: liburi-perl
53 (for HTML/Atom generation)
55 - Search::Xapian deb: libsearch-xapian-perl
56 rpm: perl-Search-Xapian
57 (for NNTP service or gzipped mbox over HTTP)
59 - IO::Compress::Gzip deb: perl-modules (or libio-compress-perl)
61 (for gzipped mbox over HTTP)
63 - DBI deb: libdbi-perl
65 (for gzipped mbox over HTTP)
67 - DBD::SQLite deb: libdbd-sqlite3-perl
69 (for NNTP service or gzipped mbox over HTTP)
71 - Danga::Socket deb: libdanga-socket-perl
72 rpm: perl-Danga-Socket
73 (for bundled HTTP and NNTP servers)
75 - Net::Server deb: libnet-server-perl
77 (for HTTP/NNTP servers as standalone daemons)
79 - Filesys::Notify::Simple deb: libfilesys-notify-simple-perl
80 rpm: perl-Filesys-Notify-Simple
81 (for public-inbox-watch)
84 On Fedora systems, you'll probably also end up wanting
85 perl-Test-HTTP-Server-Simple, perl-Devel-Peek, and perl-IPC-Run to run the
88 standard MakeMaker installation (Perl)
89 --------------------------------------
91 Once the dependencies are installed, you should be able to build and
92 install the system (into /usr/local) with:
97 make install # root permissions may be needed
99 When installing Search::Xapian, make sure the underlying Xapian
100 installation is not affected by an index corruption bug:
102 https://bugs.debian.org/808610
104 For Debian 8.x (jessie), this means using Debian 8.5 or later.
106 public-inbox will never store unregeneratable data in Xapian
107 or any other search database we might use; Xapian corruption
108 will not destroy critical data.
110 See the public-inbox-overview(7) man page for the next steps once the
111 installation is complete.
116 Copyright 2013-2018 all contributors <meta@public-inbox.org>
117 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>