[Erp5-report] r41446 luke - /erp5/trunk/utils/erp5.recipe.apache/README.txt

[nobody at svn.erp5.org]

Author: luke
Date: Wed Dec 15 10:53:17 2010
New Revision: 41446

URL: http://svn.erp5.org?rev=41446&view=rev
Log:
 - update README

Modified:
    erp5/trunk/utils/erp5.recipe.apache/README.txt

Modified: erp5/trunk/utils/erp5.recipe.apache/README.txt
URL: http://svn.erp5.org/erp5/trunk/utils/erp5.recipe.apache/README.txt?rev=41446&r1=41445&r2=41446&view=diff
==============================================================================
--- erp5/trunk/utils/erp5.recipe.apache/README.txt [utf8] (original)
+++ erp5/trunk/utils/erp5.recipe.apache/README.txt [utf8] Wed Dec 15 10:53:17 2010
@@ -1,4 +1,43 @@
 Introduction
 ============
 
-Recipe to generate apache instances.
+Recipe to generate Apache reverse proxy for Zope with SSL.
+
+Example configuration
+---------------------
+
+[buildout]
+parts =
+  my-frontend
+
+[my-frontend]
+recipe = erp5.recipe.apache
+httpd_binary = /path/to/bin/httpd
+openssl_binary = /path/to/bin/openssl
+
+ip = ::1
+port = 43214
+server_name = localhost
+
+backend_mapping =
+  127.0.0.1:16080/ /
+  127.0.0.1:16080/erp5 /erp5
+  127.0.0.1:16080/erp5 /differentview
+  127.0.0.1:16080/erp5/module/something /deep in
+
+After running this profile:
+
+ - SSL keys will be generated and stored in var/my-fronted-ssl
+ - var/run and var/log directories will be prepared:
+   - var/run/my-fronted.pid will be available during run
+   - var/log/my-fronted_access.log and var/log/my-fronted_error.log will be updated
+ - parts/my-fronted/etc/my-frontend.conf will be generated
+ - bin/my-fronted wrapper will be ready to serve apache in foreground mode
+
+VirtualHostMonster will be automatically configured to support backend mapping.
+
+TODO
+----
+
+ - convert README to docstring test
+ - use python entry point instead of shell script to generate wrapper