INSTALL

   1 public-inbox (server-side) installation
   2 ---------------------------------------
   3 This is for folks who want to setup their own public-inbox instance.
   4 Clients should see http://ssoma.public-inbox.org/INSTALL.html instead.
   5
   6 TODO: this still needs to be documented better,
   7 also see the scripts/ and sa_config/ directories in the source tree
   8
   9 It should also be possible to use public-inbox with only IMAP
  10 (or even POP(!)) access to a mailbox.
  11
  12 standard MakeMaker installation (Perl)
  13 --------------------------------------
  14
  15         perl Makefile.PL
  16         make
  17         make test
  18         make install # root permissions may be needed
  19
  20 Requirements (server MDA)
  21 -------------------------
  22 * git
  23 * ssoma - http://ssoma.public-inbox.org/INSTALL.html
  24 * SpamAssassin (spamc/spamd)
  25 * MTA - postfix is recommended
  26 * lynx (for converting HTML messages to text)
  27 * Perl and several modules:    (Debian package name)
  28   - Date::Parse                libtimedate-perl
  29   - Email::Address             libemail-address-perl
  30   - Email::Filter              libemail-filter-perl
  31   - Email::MIME                libemail-mime-perl
  32   - Email::MIME::ContentType   libemail-mime-contenttype-perl
  33   - Encode::MIME::Header       perl
  34   - File::Path::Expand         libfile-path-expand-perl
  35   - IPC::Run                   libipc-run-perl
  36
  37 Optional modules:
  38
  39   - CGI[1]                     perl-modules[2]
  40   - Mail::Thread (2.5+)[1]     libmail-thread-perl
  41   - URI::Escape[1]             liburi-perl
  42   - Search::Xapian[3]          libsearch-xapian-perl
  43   - IO::Compress::Gzip[3]      libio-compress-perl
  44
  45 [1] - Only required for serving/generating Atom and HTML pages.
  46 [2] - Keep in mind this will be split into a separate Debian package
  47       when CGI.pm is dropped from the Perl standard library.
  48       Plack/PSGI and mod_perl2 are both supported.
  49 [3] - Optional for HTML web interface
  50
  51 Copyright
  52 ---------
  53 Copyright 2013-2015, all contributors <meta@public-inbox.org>
  54 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>