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 (for HTML/Atom generation)
49 - URI::Escape deb: liburi-perl
51 (for HTML/Atom generation)
53 - Search::Xapian deb: libsearch-xapian-perl
54 rpm: perl-Search-Xapian
55 (for NNTP service or gzipped mbox over HTTP)
57 - IO::Compress::Gzip deb: perl-modules (or libio-compress-perl)
59 (for gzipped mbox over HTTP)
61 - DBI deb: libdbi-perl
63 (for gzipped mbox over HTTP)
65 - DBD::SQLite deb: libdbd-sqlite3-perl
67 (for NNTP service or gzipped mbox over HTTP)
69 - Danga::Socket deb: libdanga-socket-perl
70 rpm: perl-Danga-Socket
71 (for bundled HTTP and NNTP servers)
73 - Net::Server deb: libnet-server-perl
75 (for HTTP/NNTP servers as standalone daemons)
77 - Filesys::Notify::Simple deb: libfilesys-notify-simple-perl
78 rpm: perl-Filesys-Notify-Simple
79 (for public-inbox-watch)
81 - Inline::C[7] deb: libinline-c-perl
82 (speeds up spawning on Linux
83 (see public-inbox-daemon(8))
85 - Plack::Middleware::ReverseProxy
87 deb: libplack-middleware-reverseproxy-perl
88 rpm: perl-Plack-Middleware-ReverseProxy
89 (ensures redirects are correct when running
90 behind nginx or Varnish)
92 - Plack::Middleware::Deflater
94 deb: libplack-middleware-deflater-perl
95 rpm: perl-Plack-Middleware-Deflater
96 (saves bandwidth on responses)
99 On Fedora systems, you'll probably also end up wanting
100 perl-Test-HTTP-Server-Simple, perl-Devel-Peek, and perl-IPC-Run to run the
101 test suite. On Debian systems, libxml-feed-perl and libipc-run-perl(*)
102 will aid in running the test suite (XML::Feed and IPC::Run respectively,
105 (*) we hope to drop this dependency someday
107 standard MakeMaker installation (Perl)
108 --------------------------------------
110 Once the dependencies are installed, you should be able to build and
111 install the system (into /usr/local) with:
116 make install # root permissions may be needed
118 When installing Search::Xapian, make sure the underlying Xapian
119 installation is not affected by an index corruption bug:
121 https://bugs.debian.org/808610
123 For Debian 8.x (jessie), this means using Debian 8.5 or later.
125 public-inbox will never store unregeneratable data in Xapian
126 or any other search database we might use; Xapian corruption
127 will not destroy critical data.
129 See the public-inbox-overview(7) man page for the next steps once the
130 installation is complete.
135 Copyright 2013-2018 all contributors <meta@public-inbox.org>
136 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>