[tor-commits] [flashproxy/master] tweak apache instructions

[infinity0 at torproject.org]

commit ca032bf816f8812221cdb56fe1d3c5fdd6b1cf9c
Author: Ximin Luo <infinity0 at gmx.com>
Date:   Wed Nov 6 01:13:15 2013 +0000

    tweak apache instructions
    - point out that current instructions are Debian-specific
    - move example conf to have a .conf extension, mandated by newer versions of Apache
    - remove redundanet instructions from conf, delegating to doc instead
---
 facilitator/Makefile.am                  |    2 +-
 facilitator/doc/http-howto.txt           |   10 +++++++---
 facilitator/examples/fp-facilitator      |   31 ------------------------------
 facilitator/examples/fp-facilitator.conf |   29 ++++++++++++++++++++++++++++
 4 files changed, 37 insertions(+), 35 deletions(-)

diff --git a/facilitator/Makefile.am b/facilitator/Makefile.am
index 2a9086b..6960e32 100644
--- a/facilitator/Makefile.am
+++ b/facilitator/Makefile.am
@@ -20,7 +20,7 @@ dist_initconf_DATA = default/facilitator default/facilitator-email-poller defaul
 endif
 
 dist_doc_DATA = doc/appspot-howto.txt doc/facilitator-design.txt doc/email-howto.txt doc/http-howto.txt doc/server-howto.txt README
-dist_example_DATA = examples/fp-facilitator examples/reg-email.pass
+dist_example_DATA = examples/fp-facilitator.conf examples/reg-email.pass
 dist_appengine_DATA = appengine/app.yaml appengine/config.go appengine/fp-reg.go appengine/README
 appengineconf_DATA = appengine/config.go
 
diff --git a/facilitator/doc/http-howto.txt b/facilitator/doc/http-howto.txt
index bd7daa4..7db6402 100644
--- a/facilitator/doc/http-howto.txt
+++ b/facilitator/doc/http-howto.txt
@@ -3,6 +3,10 @@ handling the HTTP client registration method (facilitator.cgi /
 flashproxy-reg-http / flashproxy-reg-url), as well as for browser
 proxies to poll and receive a client to serve.
 
+Unfortunately we only had time to give commands specific to the Debian
+distribution of Apache; other distributions may need to tweak some
+things, e.g. a2enmod, a2ensite only exist on Debian.
+
 == HTTP server setup
 
 Apache is the web server that runs the CGI program.
@@ -15,9 +19,9 @@ Edit /etc/apache2/ports.conf and comment out the port 80 configuration.
 	# NameVirtualHost *:80
 	# Listen 80
 
-Edit examples/fp-facilitator as per the instructions given in that file, and
-install it to /etc/apache2/sites-available/fp-facilitator or whatever is
-appropriate for your apache2 installation.
+Copy examples/fp-facilitator.conf to /etc/apache2/sites-available/ or
+wherever is appropriate for your Apache2 installation, then edit it as
+per the instructions given in that file itself.
 
 Link the configured site into sites-enabled.
 	# a2ensite fp-facilitator
diff --git a/facilitator/examples/fp-facilitator b/facilitator/examples/fp-facilitator
deleted file mode 100644
index c979ea6..0000000
--- a/facilitator/examples/fp-facilitator
+++ /dev/null
@@ -1,31 +0,0 @@
-# This is an example apache2 config for serving the facilitator.
-#
-# To use this file, copy it to /etc/apache2/sites-available/fp-facilitator, or
-# wherever is appropriate. Then edit it according to the instructions below.
-# Finally, run `a2ensite fp-facilitator` to enable it.
-#
-# You should also run `a2enmod ssl headers` to enable SSL and HSTS.
-#
-MaxClients 256
-<VirtualHost *:443>
-	# Update this with your hostname!
-	ServerName fp-facilitator.example.com
-	DocumentRoot /dev/null
-	# Make sure the path below matchs where you installed the facilitator.
-	ScriptAliasMatch ^(.*) /usr/bin/facilitator.cgi$1
-
-	CustomLog ${APACHE_LOG_DIR}/fp-access.log common
-	ErrorLog ${APACHE_LOG_DIR}/fp-error.log
-	LogLevel warn
-
-	# requires mod_ssl
-	SSLEngine on
-	# Manually install your certificate to the following location.
-	SSLCertificateFile /etc/apache2/fp-facilitator.pem
-	# If you got an intermediate certificate, uncomment the following line
-	# and install the certificate to that location too.
-	#SSLCertificateChainFile /etc/apache2/fp-intermediate.pem
-
-	# requires mod_headers
-	Header add Strict-Transport-Security "max-age=15768000"
-</VirtualHost>
diff --git a/facilitator/examples/fp-facilitator.conf b/facilitator/examples/fp-facilitator.conf
new file mode 100644
index 0000000..40182cc
--- /dev/null
+++ b/facilitator/examples/fp-facilitator.conf
@@ -0,0 +1,29 @@
+# This is an example apache2 config for serving the facilitator.
+#
+# For instructions on how to install it, see doc/http-howto.txt. You
+# should also edit the contents according to the instructions below.
+#
+MaxClients 256
+<VirtualHost *:443>
+	# Update this with your hostname!
+	ServerName fp-facilitator.example.com
+	DocumentRoot /dev/null
+	# Make sure the path below matchs where you installed the facilitator.
+	ScriptAliasMatch ^(.*) /usr/bin/facilitator.cgi$1
+
+	# Non-Debian distros will need to tweak this too
+	CustomLog ${APACHE_LOG_DIR}/fp-access.log common
+	ErrorLog ${APACHE_LOG_DIR}/fp-error.log
+	LogLevel warn
+
+	# requires mod_ssl
+	SSLEngine on
+	# Manually install your certificate to the following location.
+	SSLCertificateFile /etc/apache2/fp-facilitator.pem
+	# If you got an intermediate certificate, uncomment the following line
+	# and install the certificate to that location too.
+	#SSLCertificateChainFile /etc/apache2/fp-intermediate.pem
+
+	# requires mod_headers
+	Header add Strict-Transport-Security "max-age=15768000"
+</VirtualHost>