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 http://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 It should also be possible to use public-inbox with only IMAP
  12 (or even POP(!)) access to a mailbox.
  13
  14 standard MakeMaker installation (Perl)
  15 --------------------------------------
  16
  17         perl Makefile.PL
  18         make
  19         make test
  20         make install # root permissions may be needed
  21
  22 Requirements (server MDA)
  23 -------------------------
  24
  25 * git
  26 * SpamAssassin (spamc/spamd)
  27 * MTA - postfix is recommended
  28 * lynx (for converting HTML messages to text)
  29 * Perl and several modules:    (Debian package name)
  30   - Date::Parse                libtimedate-perl
  31   - Email::Filter              libemail-filter-perl
  32   - Email::MIME                libemail-mime-perl
  33   - Email::MIME::ContentType   libemail-mime-contenttype-perl
  34   - Encode::MIME::Header       perl
  35   - File::Path::Expand         libfile-path-expand-perl
  36   - IPC::Run                   libipc-run-perl
  37
  38 Optional modules:
  39
  40   - Plack[1]                   libplack-perl
  41   - Mail::Thread (2.5+)[1]     libmail-thread-perl
  42   - URI::Escape[1]             liburi-perl
  43   - Search::Xapian[3]          libsearch-xapian-perl
  44   - IO::Compress::Gzip[3]      libio-compress-perl
  45   - DBI[3]                     libdbi-perl
  46   - DBD::SQLite[3]             libdbd-sqlite3-perl
  47   - Danga::Socket[4]           libdanga-socket-perl
  48   - Net::Server[4]             libnet-server-perl
  49
  50 [1] - Only required for serving/generating Atom and HTML pages.
  51 [3] - Optional for HTML web interface and HTTP/NNTP servers
  52 [4] - Optional for HTTP and NNTP servers
  53
  54 When installing Search::Xapian, make sure the underlying Xapian
  55 is patched against the index corruption bug documented in:
  56
  57         https://bugs.debian.org/808610
  58
  59 For Debian 8.0, this means installing from jessie-backports
  60 until the fix lands in jessie.
  61
  62 # Ensure the following line is in your apt sources.list(5)
  63 # (typically /etc/apt/sources.list):
  64
  65 deb http://http.us.debian.org/debian jessie-backports main
  66
  67 Then run:
  68
  69         apt-get update
  70         apt-get install -t jessie-backports libxapian22
  71
  72 to install the package.
  73
  74 public-inbox will never store unregeneratable data in Xapian
  75 or any other search database we might use; Xapian corruption
  76 will not destroy critical data.
  77
  78 Copyright
  79 ---------
  80
  81 Copyright 2013-2015 all contributors <meta@public-inbox.org>
  82 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>