INSTALL

   1 public-inbox (server-side) installation
   2 ---------------------------------------
   3
   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.
   7
   8 TODO: this still needs to be documented better,
   9 also see the scripts/ and sa_config/ directories in the source tree
  10
  11 Requirements
  12 ------------
  13
  14 public-inbox requires a number of other packages to access its full
  15 functionality.  The core tools are, of course:
  16
  17 * Git
  18 * Perl
  19 * SQLite (needed for Xapian use)
  20
  21 To accept incoming mail into a public inbox, you'll likely want:
  22
  23 * MTA - postfix is recommended (for public-inbox-mda)
  24 * SpamAssassin (spamc/spamd)   (for public-inbox-watch/public-inbox-mda)
  25
  26 Beyond that, there is a long list of Perl modules required, starting with:
  27
  28 * Date::Parse                   deb: libdatetime-perl
  29                                 rpm: perl-Time-ParseDate
  30
  31 * Email::MIME                   deb: libemail-mime-perl
  32                                 rpm: perl-Email-MIME
  33
  34 * Email::MIME::ContentType      deb: libemail-mime-contenttype-perl
  35                                 rpm: perl-Email-MIME-ContentType
  36
  37 * Encode::MIME::Header          deb: libencode-perl
  38                                 rpm: perl-Encode
  39
  40 Where "deb" indicates package names for Debian-derived distributions and
  41 "rpm" is for RPM-based distributions (only known to work on Fedora).
  42
  43 Numerous optional modules are likely to be useful as well:
  44
  45   - Plack                      deb: libplack-perl
  46                                rpm: perl-Plack, perl-Plack-Test,
  47                                (for HTML/Atom generation)
  48
  49   - URI::Escape                deb: liburi-perl
  50                                rpm: perl-URI
  51                                (for HTML/Atom generation)
  52
  53   - Search::Xapian             deb: libsearch-xapian-perl
  54                                rpm: perl-Search-Xapian
  55                                (for NNTP service or gzipped mbox over HTTP)
  56
  57   - IO::Compress::Gzip         deb: perl-modules (or libio-compress-perl)
  58                                rpm: perl-PerlIO-gzip
  59                                (for gzipped mbox over HTTP)
  60
  61   - DBI                        deb: libdbi-perl
  62                                rpm: perl-DBI
  63                                (for gzipped mbox over HTTP)
  64
  65   - DBD::SQLite                deb: libdbd-sqlite3-perl
  66                                rpm: perl-DBD-SQLite
  67                                (for NNTP service or gzipped mbox over HTTP)
  68
  69   - Danga::Socket              deb: libdanga-socket-perl
  70                                rpm: perl-Danga-Socket
  71                                (for bundled HTTP and NNTP servers)
  72
  73   - Net::Server                deb: libnet-server-perl
  74                                rpm: perl-Net-Server
  75                                (for HTTP/NNTP servers as standalone daemons)
  76
  77   - Filesys::Notify::Simple    deb: libfilesys-notify-simple-perl
  78                                rpm: perl-Filesys-Notify-Simple
  79                                (for public-inbox-watch)
  80
  81   - Inline::C[7]               deb: libinline-c-perl
  82                                (speeds up spawning on Linux
  83                                 (see public-inbox-daemon(8))
  84
  85   - Plack::Middleware::ReverseProxy
  86
  87                                deb: libplack-middleware-reverseproxy-perl
  88                                rpm: perl-Plack-Middleware-ReverseProxy
  89                                (ensures redirects are correct when running
  90                                 behind nginx or Varnish)
  91
  92   - Plack::Middleware::Deflater
  93
  94                                deb: libplack-middleware-deflater-perl
  95                                rpm: perl-Plack-Middleware-Deflater
  96                                (saves bandwidth on responses)
  97
  98
  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,
 103 on CPAN).
 104
 105 (*) we hope to drop this dependency someday
 106
 107 standard MakeMaker installation (Perl)
 108 --------------------------------------
 109
 110 Once the dependencies are installed, you should be able to build and
 111 install the system (into /usr/local) with:
 112
 113         perl Makefile.PL
 114         make
 115         make test
 116         make install # root permissions may be needed
 117
 118 When installing Search::Xapian, make sure the underlying Xapian
 119 installation is not affected by an index corruption bug:
 120
 121         https://bugs.debian.org/808610
 122
 123 For Debian 8.x (jessie), this means using Debian 8.5 or later.
 124
 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.
 128
 129 See the public-inbox-overview(7) man page for the next steps once the
 130 installation is complete.
 131
 132 Copyright
 133 ---------
 134
 135 Copyright 2013-2018 all contributors <meta@public-inbox.org>
 136 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>