]> Sergey Matveev's repositories - public-inbox.git/blob - INSTALL
doc: various cleanups all around
[public-inbox.git] / INSTALL
1 Note: this still needs to be documented better,
2 also see the scripts/ and sa_config/ directories in the source tree
3
4 standard MakeMaker installation (Perl)
5 --------------------------------------
6
7         perl Makefile.PL
8         make
9         make test
10         make install # root permissions may be needed
11
12 Requirements (server MDA)
13 -------------------------
14 * git
15 * ssoma - http://ssoma.public-inbox.org/README
16 * SpamAssassin (spamc/spamd)
17 * MTA - postfix is recommended
18 * Perl and several modules:    (Debian package name)
19   - CGI                        perl-modules[1]
20   - Date::Parse                libtimedate-perl
21   - Email::Address             libemail-address-perl
22   - Email::Filter              libemail-filter-perl
23   - Email::MIME                libemail-mime-perl
24   - Email::MIME::ContentType   libemail-mime-contenttype-perl
25   - Encode::MIME::Header       perl
26   - File::Path::Expand         libfile-path-expand-perl
27   - IPC::Open2                 perl
28   - IPC::Run                   libipc-run-perl
29   - URI::Escape                liburi-perl
30   - XML::Atom::SimpleFeed      libxml-atom-simplefeed-perl
31
32 [1] - Only required for serving/generating Atom and HTML pages.
33       Keep in mind this will be split into a separate Debian package
34       when CGI.pm is dropped from the Perl standard library.
35       Plack/PSGI, FastCGI, and mod_perl2 will all be supported.
36
37 Copyright
38 ---------
39 Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
40 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>