diff options
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 27 |
1 files changed, 18 insertions, 9 deletions
@@ -5,6 +5,13 @@ This is for folks who want to setup their own public-inbox instance. Clients should use normal git-clone/git-fetch, or NNTP clients if they want to import mail into their personal inboxes. +public-inbox is developed on Debian GNU/Linux systems and will +never depend on packages outside of the "main" component of +the "stable" distribution, currently Debian 9.x ("stretch") + +Most packages are available in other GNU/Linux distributions; +and FreeBSD support can happen. + TODO: this still needs to be documented better, also see the scripts/ and sa_config/ directories in the source tree @@ -14,8 +21,8 @@ Requirements public-inbox requires a number of other packages to access its full functionality. The core tools are, of course: -* Git -* Perl +* Git (1.8.0+, 2.6+ for writing v2 repositories) +* Perl 5.8+ * SQLite (needed for Xapian use) To accept incoming mail into a public inbox, you'll likely want: @@ -25,7 +32,7 @@ To accept incoming mail into a public inbox, you'll likely want: Beyond that, there is a long list of Perl modules required, starting with: -* Date::Parse deb: libdatetime-perl +* Date::Parse deb: libtimedate-perl rpm: perl-Time-ParseDate * Email::MIME deb: libemail-mime-perl @@ -50,10 +57,6 @@ Where "deb" indicates package names for Debian-derived distributions and Numerous optional modules are likely to be useful as well: - - Socket6 deb: libsocket6-perl - rpm: perl-Socket6 - (for IPv6 support) - - Search::Xapian deb: libsearch-xapian-perl rpm: perl-Search-Xapian (for NNTP service or gzipped mbox over HTTP) @@ -76,14 +79,15 @@ Numerous optional modules are likely to be useful as well: - Net::Server deb: libnet-server-perl rpm: perl-Net-Server - (for HTTP/NNTP servers as standalone daemons) + (for HTTP/NNTP servers as standalone daemons, + not needed as systemd services) - Filesys::Notify::Simple deb: libfilesys-notify-simple-perl rpm: perl-Filesys-Notify-Simple (for public-inbox-watch) - Inline::C[7] deb: libinline-c-perl - (speeds up spawning on Linux + (speeds up spawning of git(1) on Linux (see public-inbox-daemon(8)) - Plack::Middleware::ReverseProxy @@ -99,6 +103,11 @@ Numerous optional modules are likely to be useful as well: rpm: perl-Plack-Middleware-Deflater (saves bandwidth on responses) + - Socket6 deb: libsocket6-perl + rpm: perl-Socket6 + (pulled in by SpamAssassin and Net::Server, + only necessary if using IPv6 with + Plack::Middleware::AccessLog or similar) On Fedora systems, you'll probably also end up wanting perl-Test-HTTP-Server-Simple, perl-Devel-Peek, and perl-IPC-Run to run the |