about summary refs log tree commit homepage
path: root/INSTALL
blob: bb682942d7bdbd18f9840b7a735f3b601500e25a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
public-inbox (server-side) installation
---------------------------------------
This is for folks who want to setup their own public-inbox instance.
Clients should see http://ssoma.public-inbox.org/INSTALL.html instead
if they want to import mail into their personal inboxes.

TODO: this still needs to be documented better,
also see the scripts/ and sa_config/ directories in the source tree

It should also be possible to use public-inbox with only IMAP
(or even POP(!)) access to a mailbox.

standard MakeMaker installation (Perl)
--------------------------------------

	perl Makefile.PL
	make
	make test
	make install # root permissions may be needed

Requirements (server MDA)
-------------------------
* git
* ssoma - http://ssoma.public-inbox.org/INSTALL.html
* SpamAssassin (spamc/spamd)
* MTA - postfix is recommended
* lynx (for converting HTML messages to text)
* Perl and several modules:    (Debian package name)
  - Date::Parse                libtimedate-perl
  - Email::Address             libemail-address-perl
  - Email::Filter              libemail-filter-perl
  - Email::MIME                libemail-mime-perl
  - Email::MIME::ContentType   libemail-mime-contenttype-perl
  - Encode::MIME::Header       perl
  - File::Path::Expand         libfile-path-expand-perl
  - IPC::Run                   libipc-run-perl

Optional modules:

  - CGI[1]                     perl-modules[2]
  - Mail::Thread (2.5+)[1]     libmail-thread-perl
  - URI::Escape[1]             liburi-perl
  - Search::Xapian[3]          libsearch-xapian-perl
  - IO::Compress::Gzip[3]      libio-compress-perl
  - DBI[3]                     libdbi-perl
  - DBD::SQLite[3]             libdbd-sqlite3-perl
  - Danga::Socket[4]           libdanga-socket-perl

[1] - Only required for serving/generating Atom and HTML pages.
[2] - Keep in mind this will be split into a separate Debian package
      when CGI.pm is dropped from the Perl standard library.
      Plack/PSGI and mod_perl2 are both supported.
[3] - Optional for HTML web interface and NNTP server
[4] - Optional for NNTP server

Copyright
---------
Copyright 2013-2015 all contributors <meta@public-inbox.org>
License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>