]> Sergey Matveev's repositories - public-inbox.git/blob - INSTALL
search: remove unnecessary xpfx export
[public-inbox.git] / 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   - CGI[1]                     perl-modules[2]
29   - Date::Parse                libtimedate-perl
30   - Email::Address             libemail-address-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   - Mail::Thread (2.5+)[1]     libmail-thread-perl
38   - URI::Escape[1]             liburi-perl
39   - XML::Atom::SimpleFeed[1]   libxml-atom-simplefeed-perl
40
41 [1] - Only required for serving/generating Atom and HTML pages.
42 [2] - Keep in mind this will be split into a separate Debian package
43       when CGI.pm is dropped from the Perl standard library.
44       Plack/PSGI and mod_perl2 are both supported.
45
46 Copyright
47 ---------
48 Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
49 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>