1 public-inbox (server-side) installation
2 ---------------------------------------
4 This is for folks who want to setup their own public-inbox instance.
5 Clients should use normal git-clone/git-fetch, or NNTP clients
6 if they want to import mail into their personal inboxes.
8 public-inbox is developed on Debian GNU/Linux systems and will
9 never depend on packages outside of the "main" component of
10 the "stable" distribution, currently Debian 9.x ("stretch")
12 Most packages are available in other GNU/Linux distributions
15 TODO: this still needs to be documented better,
16 also see the scripts/ and sa_config/ directories in the source tree
21 public-inbox requires a number of other packages to access its full
22 functionality. The core tools are, of course:
24 * Git (1.8.0+, 2.6+ for writing v2 repositories)
26 * DBD::SQLite (needed for NNTP, message threading, and v2 repositories)
28 To accept incoming mail into a public inbox, you'll likely want:
30 * MTA - postfix is recommended (for public-inbox-mda)
31 * SpamAssassin (spamc/spamd) (for public-inbox-watch/public-inbox-mda)
33 Beyond that, there is a long list of Perl modules required, starting with:
35 * Date::Parse deb: libtimedate-perl
39 * Devel::Peek deb: libperl5.$MINOR (e.g. libperl5.24)
42 (typically installed alongside Perl5)
44 * Email::MIME deb: libemail-mime-perl
48 * Plack deb: libplack-perl
50 rpm: perl-Plack, perl-Plack-Test,
51 (for HTML/Atom generation)
53 * URI::Escape deb: liburi-perl
56 (for HTML/Atom generation)
58 Where "deb" indicates package names for Debian-derived distributions,
59 "pkg" is for the FreeBSD package (maybe other common BSDs, too), and
60 "rpm" is for RPM-based distributions (only known to work on Fedora).
62 Numerous optional modules are likely to be useful as well:
64 - DBD::SQLite deb: libdbd-sqlite3-perl
67 (for v2, NNTP, or gzipped mboxes)
69 - Search::Xapian deb: libsearch-xapian-perl
71 rpm: perl-Search-Xapian
74 - Net::Server deb: libnet-server-perl
77 (for HTTP/NNTP background daemons,
78 not needed as systemd services or
81 - Inline::C[7] deb: libinline-c-perl
83 (speeds up process spawning on Linux,
84 see public-inbox-daemon(8))
86 - Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl
87 pkg: p5-Plack-Middleware-ReverseProxy
88 rpm: perl-Plack-Middleware-ReverseProxy
89 (ensures redirects are correct when running
90 behind nginx or Varnish)
92 - Plack::Middleware::Deflater deb: libplack-middleware-deflater-perl
93 pkg: p5 -Plack-Middleware-Deflater
94 rpm: perl-Plack-Middleware-Deflater
95 (saves bandwidth on responses)
97 * highlight deb: libhighlight-perl
98 (for syntax highlighting with coderepo)
100 The following modules are typically pulled in by dependencies listed
101 above, so there is no need to explicitly install them:
103 - Email::MIME::ContentType deb: libemail-mime-contenttype-perl
104 pkg: p5-Email-MIME-ContentType
105 rpm: perl-Email-MIME-ContentType
106 (pulled in by Email::MIME)
108 - Email::Simple deb: libemail-simple-perl
110 rpm: perl-Email-Simple
111 (pulled in by Email::MIME)
113 * Encode deb: libperl5.$MINOR (or libencode-perl)
116 (likely installed with Perl)
118 - DBI deb: libdbi-perl
121 (pulled in by DBD::SQLite)
123 - Filesys::Notify::Simple deb: libfilesys-notify-simple-perl
124 pkg: pkg-Filesys-Notify-Simple
125 rpm: perl-Filesys-Notify-Simple
126 (for public-inbox-watch, pulled in by Plack)
128 - IO::Compress::Gzip deb: perl-modules (or libio-compress-perl)
129 rpm: perl-PerlIO-gzip
131 (for gzipped mbox over HTTP)
133 Uncommonly needed modules:
135 - Socket6 deb: libsocket6-perl
138 (pulled in by SpamAssassin and Net::Server,
139 only necessary if using IPv6 with
140 Plack::Middleware::AccessLog or similar
143 - Crypt::CBC deb: libcrypt-cbc-perl
145 (for PublicInbox::Unsubscribe (rarely used))
147 Optional packages testing and development:
149 - IPC::Run deb: libipc-run-perl
153 - XML::Feed deb: libxml-feed-perl
157 - Test::HTTP::Server::Simple deb: libtest-http-server-simple-perl
158 pkg: p5-Test-HTTP-Server-Simple
159 rpm: perl-Test-HTTP-Server-Simple
160 (XXX is this really needed?)
162 standard MakeMaker installation (Perl)
163 --------------------------------------
165 Once the dependencies are installed, you should be able to build and
166 install the system (into /usr/local) with:
171 make install # root permissions may be needed
173 When installing Search::Xapian, make sure the underlying Xapian
174 installation is not affected by an index corruption bug:
176 https://bugs.debian.org/808610
178 For Debian 8.x (jessie), this means using Debian 8.5 or later.
180 public-inbox will never store unregeneratable data in Xapian
181 or any other search database we might use; Xapian corruption
182 will not destroy critical data.
184 See the public-inbox-overview(7) man page for the next steps once
185 the installation is complete.
190 Copyright 2013-2019 all contributors <meta@public-inbox.org>
191 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>