X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=INSTALL;h=3c0b9108e5f0aba8e08fd1dfa21c7203cc6676ec;hb=cd50d183273c105a7f08b1875ba6f7a51d9f8e9a;hp=ccd9dac91926dbca7cefa7a661bde104e501c87b;hpb=e041f5446ad266ee24e41a38e0090e2a65167606;p=public-inbox.git diff --git a/INSTALL b/INSTALL index ccd9dac9..3c0b9108 100644 --- a/INSTALL +++ b/INSTALL @@ -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: @@ -66,10 +73,6 @@ Numerous optional modules are likely to be useful as well: rpm: perl-DBD-SQLite (for NNTP service or gzipped mbox over HTTP) - - Danga::Socket deb: libdanga-socket-perl - rpm: perl-Danga-Socket - (for bundled HTTP and NNTP servers) - - Net::Server deb: libnet-server-perl rpm: perl-Net-Server (for HTTP/NNTP servers as standalone daemons, @@ -100,7 +103,11 @@ Numerous optional modules are likely to be useful as well: rpm: perl-Socket6 (pulled in by SpamAssassin and Net::Server, only necessary if using IPv6 with - Plack::Middleware::AccessLog or similar) + Plack::Middleware::AccessLog or similar + on Perl <= 5.12) + + - Crypt::CBC deb: libcrypt-cbc-perl + (for the rarely-used PublicInbox::Unsubscribe) 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