From 21dd4cc5672ae3ead8a513d3be926722ddb80879 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 11 Aug 2022 20:13:08 +0000 Subject: [PATCH] doc: drop ancient Apache and WEBrick examples Having old, unmaintained docs for other HTTP servers is likely harmful at this point. public-inbox-httpd is specifically designed to handle git repos on slow storage and stream giant mbox.gz files fairly to slow clients. --- MANIFEST | 4 ---- examples/README | 4 ---- examples/apache2_cgi.conf | 34 ------------------------------ examples/apache2_perl.conf | 25 ---------------------- examples/apache2_perl_old.conf | 38 ---------------------------------- examples/cgi-webrick.rb | 25 ---------------------- 6 files changed, 130 deletions(-) delete mode 100644 examples/apache2_cgi.conf delete mode 100644 examples/apache2_perl.conf delete mode 100644 examples/apache2_perl_old.conf delete mode 100644 examples/cgi-webrick.rb diff --git a/MANIFEST b/MANIFEST index d37ba0ab..196b9627 100644 --- a/MANIFEST +++ b/MANIFEST @@ -122,10 +122,6 @@ devel/README devel/syscall-list examples/README examples/README.unsubscribe -examples/apache2_cgi.conf -examples/apache2_perl.conf -examples/apache2_perl_old.conf -examples/cgi-webrick.rb examples/cgit-commit-filter.lua examples/cgit-wwwhighlight-filter.lua examples/cgit.psgi diff --git a/examples/README b/examples/README index 1d5dcd34..5674d7ed 100644 --- a/examples/README +++ b/examples/README @@ -9,10 +9,6 @@ For PSGI/Plack (HTTP) servers ----------------------------- public-inbox.psgi - starting point for PSGI/Plack users in production and dev -For Apache2 users ------------------ -apache2_perl.conf - intended to be the basis of a production config - Contact ------- Please send any related feedback to public-inbox: meta@public-inbox.org diff --git a/examples/apache2_cgi.conf b/examples/apache2_cgi.conf deleted file mode 100644 index 5ec64d72..00000000 --- a/examples/apache2_cgi.conf +++ /dev/null @@ -1,34 +0,0 @@ -# Example Apache2 configuration using CGI mod_cgi -# If possible, use mod_perl (see apache2_perl.conf) or -# a standalone PSGI/Plack # server 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 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 -LoadModule dir_module /usr/lib/apache2/modules/mod_dir.so -LoadModule mime_module /usr/lib/apache2/modules/mod_mime.so -TypesConfig "/dev/null" - - - Options +ExecCGI - AddHandler cgi-script .cgi - - # we use this hack to ensure "public-inbox.cgi" doesn't show up - # in any of our redirects: - SetEnv NO_SCRIPT_NAME 1 - - # our public-inbox.cgi requires PATH_INFO-based URLs with minimal - # use of query parameters - DirectoryIndex public-inbox.cgi - RewriteEngine On - RewriteCond %{REQUEST_FILENAME} !-f - RewriteCond %{REQUEST_FILENAME} !-d - RewriteRule ^.* /public-inbox.cgi/$0 [L,PT] - diff --git a/examples/apache2_perl.conf b/examples/apache2_perl.conf deleted file mode 100644 index a4721b5b..00000000 --- a/examples/apache2_perl.conf +++ /dev/null @@ -1,25 +0,0 @@ -# Example Apache2 configuration using Plack::Handler::Apache2 -# Adjust paths to your installation - -ServerName "public-inbox" -ServerRoot "/var/www" -DocumentRoot "/var/www" -ErrorLog "/tmp/public-inbox-error.log" -PidFile "/tmp/public-inbox.pid" -Listen 127.0.0.1:8080 -LoadModule perl_module /usr/lib/apache2/modules/mod_perl.so - -# no need to set no rely on HOME if using this: -PerlSetEnv PI_CONFIG /home/pi/.public-inbox/config - - - SetHandler perl-script - PerlResponseHandler Plack::Handler::Apache2 - PerlSetVar psgi_app /path/to/public-inbox.psgi - - -# Optional, preload the application in the parent like startup.pl - - use Plack::Handler::Apache2; - Plack::Handler::Apache2->preload("/path/to/public-inbox.psgi"); - diff --git a/examples/apache2_perl_old.conf b/examples/apache2_perl_old.conf deleted file mode 100644 index a6de2304..00000000 --- a/examples/apache2_perl_old.conf +++ /dev/null @@ -1,38 +0,0 @@ -# Example legacy Apache2 configuration using CGI + mod_perl2 -# Consider using Plack::Handler::Apache2 instead (see apache2_perl.conf) -# 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 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 -LoadModule mime_module /usr/lib/apache2/modules/mod_mime.so -TypesConfig "/dev/null" - -# PerlPassEnv PATH # this is implicit - - Options +ExecCGI - AddHandler perl-script .cgi - PerlResponseHandler ModPerl::Registry - PerlOptions +ParseHeaders - - # we use this hack to ensure "public-inbox.cgi" doesn't show up - # in any of our redirects: - PerlSetEnv NO_SCRIPT_NAME 1 - - # no need to set no rely on HOME if using this: - PerlSetEnv PI_CONFIG /home/pi/.public-inbox/config - - # our public-inbox.cgi requires PATH_INFO-based URLs with minimal - # use of query parameters - DirectoryIndex public-inbox.cgi - RewriteEngine On - RewriteCond %{REQUEST_FILENAME} !-f - RewriteCond %{REQUEST_FILENAME} !-d - RewriteRule ^.* /public-inbox.cgi/$0 [L,PT] - diff --git a/examples/cgi-webrick.rb b/examples/cgi-webrick.rb deleted file mode 100644 index 5554a012..00000000 --- a/examples/cgi-webrick.rb +++ /dev/null @@ -1,25 +0,0 @@ -#!/usr/bin/env ruby -# Sample configuration using WEBrick, mainly intended dev/testing -# for folks familiar with Ruby and not various Perl webserver -# deployment options. For those familiar with Perl web servers, -# plackup(1) is recommended for development and public-inbox-httpd(1) -# is our production deployment server. -require 'webrick' -require 'logger' -options = { - :BindAddress => '127.0.0.1', - :Port => 8080, - :Logger => Logger.new($stderr), - :CGIPathEnv => ENV['PATH'], # need to run 'git' commands - :AccessLog => [ - [ Logger.new($stdout), WEBrick::AccessLog::COMBINED_LOG_FORMAT ] - ], -} -server = WEBrick::HTTPServer.new(options) -server.mount("/", - WEBrick::HTTPServlet::CGIHandler, - "/var/www/cgi-bin/public-inbox.cgi") -['INT', 'TERM'].each do |signal| - trap(signal) {exit!(0)} -end -server.start -- 2.44.0