From 0449c3c4ac1a60dde24225d648546362c3bc3fa1 Mon Sep 17 00:00:00 2001
From: Eric Wong <e@80x24.org>
Date: Sun, 28 Feb 2016 22:28:50 +0000
Subject: [PATCH] examples/: PSGI example updates

Users wanting to customize their installation should know
to about the usability of STDOUT for logging.
(and we still need manpages for -nntpd and -httpd)
---
 examples/public-inbox.psgi | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/examples/public-inbox.psgi b/examples/public-inbox.psgi
index 0d11c19f..f5749122 100644
--- a/examples/public-inbox.psgi
+++ b/examples/public-inbox.psgi
@@ -3,6 +3,8 @@
 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
 # Note: this is part of our test suite, update t/plack.t if this changes
 # Usage: plackup [OPTIONS] /path/to/this/file
+# A startup command for development which monitors changes:
+#	plackup -I lib -o 127.0.0.1 -R lib -r examples/public-inbox.psgi
 use strict;
 use warnings;
 use PublicInbox::WWW;
@@ -22,6 +24,7 @@ builder {
 	};
 	$@ and warn
 "Plack::Middleware::Deflater missing, bandwidth will be wasted\n";
+
 	# Enable to ensure redirects and Atom feed URLs are generated
 	# properly when running behind a reverse proxy server which
 	# sets X-Forwarded-For and X-Forwarded-Proto request headers.
@@ -31,6 +34,13 @@ builder {
 "Plack::Middleware::ReverseProxy missing,\n",
 "URL generation for redirects may be wrong if behind a reverse proxy\n";
 
+	# Optional: Log timing information for requests to track performance.
+	# Logging to STDOUT is recommended since public-inbox-httpd knows
+	# how to reopen it via SIGUSR1 after log rotation.
+	# enable 'AccessLog::Timed',
+	#	logger => sub { syswrite(STDOUT, $_[0]) },
+	#	format => '%t "%r" %>s %b %D';
+
 	enable 'Head';
 	sub { $www->call(@_) };
 }
-- 
2.51.0