user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Eric Wong <e@80x24.org>
Cc: meta@public-inbox.org
Subject: [PATCH] Update the installation instructions with Fedora package names
Date: Tue, 27 Feb 2018 16:36:09 -0700	[thread overview]
Message-ID: <20180227163609.23ed8aa3@lwn.net> (raw)

Add a few more details and (especially) the Fedora package names.  I also
took the liberty of reorganizing things slightly while I was there.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 INSTALL | 58 ++++++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 40 insertions(+), 18 deletions(-)

diff --git a/INSTALL b/INSTALL
index 3758e8d..68fbd66 100644
--- a/INSTALL
+++ b/INSTALL
@@ -8,32 +8,32 @@ 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
 ------------
 
-* git
-* Perl and several modules:    (Debian package name)
-  - Date::Parse                libtimedate-perl
-  - Email::MIME                libemail-mime-perl
-  - Email::MIME::ContentType   libemail-mime-contenttype-perl
-  - Encode::MIME::Header       perl
+public-inbox requires a number of other packages to access its full
+functionality.  The core tools are, of course:
+
+* Git
+* Perl
+* Sqlite
 
-Optional components:
+To accept incoming mail into a public inbox, you'll likely want:
 
 * MTA - postfix is recommended (for public-inbox-mda)
 * SpamAssassin (spamc/spamd)   (for public-inbox-watch/public-inbox-mda)
 
+Beyond that, there is a long list of Perl modules required, starting with: 
+
+* Date::Parse
+* Email::MIME
+* Email::MIME::ContentType
+* Encode::MIME::Header
+
+On Debian systems, these modules can be had with the libtimedate-perl,
+libemail-mime-perl, and libemail-mime-contenttype-perl packages.  On Fedora
+and similar, install perl-Time-ParseDate and perl-Email-MIME.
+
 Optional Perl modules:
 
   - Plack[1]                   libplack-perl
@@ -46,6 +46,13 @@ Optional Perl modules:
   - Net::Server[5]             libnet-server-perl
   - Filesys::Notify::Simple[6] libfilesys-notify-simple-perl
 
+On Fedora systems the modules you'll want are perl-Plack, perl-Plack-Test,
+perl-Plack-Middleware-ReverseProxy, perl-Plack-Middleware-Deflater,
+perl-URI, perl-Search-Xapian, perl-PerlIO-gzip, perl-DBI, perl-DBD-SQLite,
+perl-Danga-Socket, perl-Net-Server.  You'll probably also end up wanting
+perl-Test-HTTP-Server-Simple, perl-Devel-Peek, perl-IPC-Run, and
+perl-Filesys-Notify-Simple.
+
 [1] - Optional, needed for serving/generating Atom and HTML pages
 [2] - Optional, only required for NNTP server
 [3] - Optional, needed for gzipped mbox support over HTTP
@@ -53,6 +60,18 @@ Optional Perl modules:
 [5] - Optional, needed for standalone daemonization of HTTP+NNTP servers
 [6] - Optional, needed for public-inbox-watch Maildir watcher
 
+standard MakeMaker installation (Perl)
+--------------------------------------
+
+Once the dependencies are installed, you should be able to build and
+install the system (into /usr/local) with:
+
+	perl Makefile.PL
+	make
+	make test
+	make install # root permissions may be needed
+
+
 When installing Search::Xapian, make sure the underlying Xapian
 installation is not affected by an index corruption bug:
 
@@ -64,6 +83,9 @@ public-inbox will never store unregeneratable data in Xapian
 or any other search database we might use; Xapian corruption
 will not destroy critical data.
 
+See public-inbox-overview for the next steps once the installation is
+complete.
+
 Copyright
 ---------
 
-- 
2.14.3


             reply	other threads:[~2018-02-27 23:36 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-02-27 23:36 Jonathan Corbet [this message]
2018-02-28  3:55 ` Eric Wong
2018-03-11 16:48   ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180227163609.23ed8aa3@lwn.net \
    --to=corbet@lwn.net \
    --cc=e@80x24.org \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this inbox:

	https://80x24.org/public-inbox.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).