examples: make web configs consistent and add README

Hopefully this is enough to get some folks started.

diff --git a/examples/README b/examples/README
new file mode 100644 (file)
index 0000000..5113393
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,20 @@
+Various example configuration files related to public-inbox
+-----------------------------------------------------------
+
+For all server admins
+---------------------
+public-inbox-config - configuration file, this maps configured inboxes
+
+For Apache2 users without Plack
+-------------------------------
+apache2_perl.conf - intended to be the basis of a production config
+
+Web server configs for quick-and-dirty demos
+--------------------------------------------
+apache2_cgi.conf - for Apache2 users who cannot install mod_perl
+cgi-webrick.rb - only for Rubyists who do not wish to install Plack or Apache
+
+Contact
+-------
+Please send any related feedback to public-inbox: meta@public-inbox.org
+Our public-inbox is: git://public-inbox.org/meta

diff --git a/examples/apache2_cgi.conf b/examples/apache2_cgi.conf
index 455e47805ed4920d9df3e53e8285ef0c0fc9719b..775b7e677088cafa6e44f2f970f98a602697f3d8 100644 (file)
--- a/examples/apache2_cgi.conf
+++ b/examples/apache2_cgi.conf
@@ -1,12 +1,13 @@
 # Example Apache2 configuration using mod_cgi
-# adjust paths to your installation
+# If possible, use mod_perl (see apache2_perl.conf) instead of this.
+# Adjust paths to your installation.
 
 ServerName "public-inbox"
 ServerRoot "/var/www/cgi-bin"
 DocumentRoot "/var/www/cgi-bin"
 ErrorLog "/tmp/public-inbox-error.log"
 PidFile "/tmp/public-inbox.pid"
-Listen 8080
+Listen 127.0.0.1:8080
 LoadModule cgi_module /usr/lib/apache2/modules/mod_cgi.so
 LoadModule env_module /usr/lib/apache2/modules/mod_env.so
 LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so

diff --git a/examples/apache2_perl.conf b/examples/apache2_perl.conf
index e963af6e4d31183ad9e44b2400b6c1ceb8172ced..04d5a8e81c2a895351ada07c4c83e90af43617a2 100644 (file)
--- a/examples/apache2_perl.conf
+++ b/examples/apache2_perl.conf
@@ -1,12 +1,12 @@
 # Example Apache2 configuration using mod_perl2
-# adjust paths to your installation
+# Adjust paths to your installation
 
 ServerName "public-inbox"
 ServerRoot "/var/www/cgi-bin"
 DocumentRoot "/var/www/cgi-bin"
 ErrorLog "/tmp/public-inbox-error.log"
 PidFile "/tmp/public-inbox.pid"
-Listen 8080
+Listen 127.0.0.1:8080
 LoadModule perl_module /usr/lib/apache2/modules/mod_perl.so
 LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so
 LoadModule dir_module /usr/lib/apache2/modules/mod_dir.so

diff --git a/examples/cgi-webrick.rb b/examples/cgi-webrick.rb
index 1bc690f1fbb7f7f7a6225ccb6fa02f502d4c550e..21e336d525877f4ab5e1da9fbb21c52ecdfb2c18 100644 (file)
--- a/examples/cgi-webrick.rb
+++ b/examples/cgi-webrick.rb
@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+# Sample configuration using WEBrick, mainly intended dev/testing
+# for folks familiar with Ruby and not various Perl webserver
+# deployment options.
 require 'webrick'
 require 'logger'
 options = {
@@ -12,8 +15,8 @@ options = {
 server = WEBrick::HTTPServer.new(options)
 server.mount("/",
              WEBrick::HTTPServlet::CGIHandler,
-            "#{Dir.pwd}/blib/script/public-inbox.cgi")
+            "/var/www/cgi-bin/public-inbox.cgi")
 ['INT', 'TERM'].each do |signal|
-  trap(signal) {exit}
+  trap(signal) {exit!(0)}
 end
 server.start