Merge remote-tracking branch 'origin/wwwlisting'

[public-inbox.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index ccd9dac91926dbca7cefa7a661bde104e501c87b..b22d848409c2b6e7c5518cd3274d5cb40b683123 100644 (file)
--- 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.10.1+
 * SQLite (needed for Xapian use)
 
 To accept incoming mail into a public inbox, you'll likely want:
@@ -100,7 +107,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