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 * Digest::SHA typically installed with Perl
38 * Email::MIME deb: libemail-mime-perl
42 * Plack deb: libplack-perl
44 rpm: perl-Plack, perl-Plack-Test,
45 (for HTML/Atom generation)
47 * URI::Escape deb: liburi-perl
50 (for HTML/Atom generation)
52 Where "deb" indicates package names for Debian-derived distributions,
53 "pkg" is for the FreeBSD package (maybe other common BSDs, too), and
54 "rpm" is for RPM-based distributions (only known to work on Fedora).
56 Numerous optional modules are likely to be useful as well:
58 - DBD::SQLite deb: libdbd-sqlite3-perl
61 (for v2, NNTP, or gzipped mboxes)
63 - Search::Xapian deb: libsearch-xapian-perl
65 rpm: perl-Search-Xapian
68 - Net::Server deb: libnet-server-perl
71 (for HTTP/NNTP background daemons,
72 not needed as systemd services or
75 - Inline::C[7] deb: libinline-c-perl
77 (speeds up process spawning on Linux,
78 see public-inbox-daemon(8))
80 - Date::Parse deb: libtimedate-perl
83 (for broken, mostly historical emails)
85 - Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl
86 pkg: p5-Plack-Middleware-ReverseProxy
87 rpm: perl-Plack-Middleware-ReverseProxy
88 (ensures redirects are correct when running
89 behind nginx or Varnish)
91 - Plack::Middleware::Deflater deb: libplack-middleware-deflater-perl
92 pkg: p5 -Plack-Middleware-Deflater
93 rpm: perl-Plack-Middleware-Deflater
94 (saves bandwidth on responses)
96 * highlight deb: libhighlight-perl
97 (for syntax highlighting with coderepo)
99 * xapian-compact (tool) deb: xapian-tools
102 (optional, for public-inbox-compact(1))
104 The following modules are typically pulled in by dependencies listed
105 above, so there is no need to explicitly install them:
107 - Email::MIME::ContentType deb: libemail-mime-contenttype-perl
108 pkg: p5-Email-MIME-ContentType
109 rpm: perl-Email-MIME-ContentType
110 (pulled in by Email::MIME)
112 - Email::Simple deb: libemail-simple-perl
114 rpm: perl-Email-Simple
115 (pulled in by Email::MIME)
117 * Encode deb: libperl5.$MINOR (or libencode-perl)
120 (likely installed with Perl)
122 - DBI deb: libdbi-perl
125 (pulled in by DBD::SQLite)
127 * Devel::Peek deb: libperl5.$MINOR (e.g. libperl5.24)
130 (optional for stale FD cleanup in daemons,
131 typically installed alongside Perl5)
133 - Filesys::Notify::Simple deb: libfilesys-notify-simple-perl
134 pkg: p5-Filesys-Notify-Simple
135 rpm: perl-Filesys-Notify-Simple
136 (for public-inbox-watch, pulled in by Plack)
138 - Linux::Inotify deb: liblinux-inotify2-perl
139 rpm: perl-Linux-Inotify2
140 (for public-inbox-watch on Linux)
142 - Filesys::Notify::KQueue pkg: p5-Filesys-Notify-KQueue
143 (for public-inbox-watch on FreeBSD)
145 - IO::Compress::Gzip deb: perl-modules (or libio-compress-perl)
147 rpm: perl-IO-Compress
148 (for gzipped mbox over HTTP)
150 Uncommonly needed modules:
152 - Socket6 deb: libsocket6-perl
155 (pulled in by SpamAssassin and Net::Server,
156 only necessary if using IPv6 with
157 Plack::Middleware::AccessLog or similar
160 - Crypt::CBC deb: libcrypt-cbc-perl
162 (for PublicInbox::Unsubscribe (rarely used))
164 Optional packages testing and development:
166 - Plack::Test deb: libplack-test-perl
170 - Test::Simple deb: perl-modules-5.$MINOR
172 rpm: perl-Test-Simple
174 - XML::Feed deb: libxml-feed-perl
178 standard MakeMaker installation (Perl)
179 --------------------------------------
181 To use MakeMaker, you need to ensure ExtUtils::MakeMaker is available.
182 This is typically installed with Perl, but RPM-based systems will likely
183 need to install the `perl-ExtUtils-MakeMaker' package.
185 Once the dependencies are installed, you should be able to build and
186 install the system (into /usr/local) with:
191 make install # root permissions may be needed
193 When installing Search::Xapian, make sure the underlying Xapian
194 installation is not affected by an index corruption bug:
196 https://bugs.debian.org/808610
198 For Debian 8.x (jessie), this means using Debian 8.5 or later.
200 public-inbox will never store unregeneratable data in Xapian
201 or any other search database we might use; Xapian corruption
202 will not destroy critical data.
204 See the public-inbox-overview(7) man page for the next steps once
205 the installation is complete.
210 Copyright 2013-2019 all contributors <meta@public-inbox.org>
211 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>