]> Sergey Matveev's repositories - public-inbox.git/blob - INSTALL
various documentation updates
[public-inbox.git] / 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 instead.
6
7 TODO: this still needs to be documented better,
8 also see the scripts/ and sa_config/ directories in the source tree
9
10 It should also be possible to use public-inbox with only IMAP
11 (or even POP(!)) access to a mailbox.
12
13 standard MakeMaker installation (Perl)
14 --------------------------------------
15
16         perl Makefile.PL
17         make
18         make test
19         make install # root permissions may be needed
20
21 Requirements (server MDA)
22 -------------------------
23 * git
24 * ssoma - http://ssoma.public-inbox.org/README
25 * SpamAssassin (spamc/spamd)
26 * MTA - postfix is recommended
27 * lynx (for converting HTML messages to text)
28 * Perl and several modules:    (Debian package name)
29   - CGI[1]                     perl-modules[2]
30   - Date::Parse                libtimedate-perl
31   - Email::Address             libemail-address-perl
32   - Email::Filter              libemail-filter-perl
33   - Email::MIME                libemail-mime-perl
34   - Email::MIME::ContentType   libemail-mime-contenttype-perl
35   - Encode::MIME::Header       perl
36   - File::Path::Expand         libfile-path-expand-perl
37   - IPC::Run                   libipc-run-perl
38   - Mail::Thread (2.5+)[1]     libmail-thread-perl
39   - URI::Escape[1]             liburi-perl
40   - XML::Atom::SimpleFeed[1]   libxml-atom-simplefeed-perl
41
42 [1] - Only required for serving/generating Atom and HTML pages.
43 [2] - Keep in mind this will be split into a separate Debian package
44       when CGI.pm is dropped from the Perl standard library.
45       Plack/PSGI, FastCGI, and mod_perl2 will all be supported.
46
47 Copyright
48 ---------
49 Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
50 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>