]> Sergey Matveev's repositories - public-inbox.git/blob - INSTALL
view: fix link generation for replies in threads
[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.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 * ssoma - http://ssoma.public-inbox.org/INSTALL.html
27 * SpamAssassin (spamc/spamd)
28 * MTA - postfix is recommended
29 * lynx (for converting HTML messages to text)
30 * Perl and several modules:    (Debian package name)
31   - Date::Parse                libtimedate-perl
32   - Email::Address             libemail-address-perl
33   - Email::Filter              libemail-filter-perl
34   - Email::MIME                libemail-mime-perl
35   - Email::MIME::ContentType   libemail-mime-contenttype-perl
36   - Encode::MIME::Header       perl
37   - File::Path::Expand         libfile-path-expand-perl
38   - IPC::Run                   libipc-run-perl
39
40 Optional modules:
41
42   - Plack[1]                   libplack-perl
43   - Mail::Thread (2.5+)[1]     libmail-thread-perl
44   - URI::Escape[1]             liburi-perl
45   - Search::Xapian[3]          libsearch-xapian-perl
46   - IO::Compress::Gzip[3]      libio-compress-perl
47   - DBI[3]                     libdbi-perl
48   - DBD::SQLite[3]             libdbd-sqlite3-perl
49   - Danga::Socket[4]           libdanga-socket-perl
50   - Net::Server[4]             libnet-server-perl
51
52 [1] - Only required for serving/generating Atom and HTML pages.
53 [3] - Optional for HTML web interface and HTTP/NNTP servers
54 [4] - Optional for HTTP and NNTP servers
55
56 Copyright
57 ---------
58
59 Copyright 2013-2015 all contributors <meta@public-inbox.org>
60 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>