Cleanup html docs using dpatch

[manu/mod-proxy-html.git] / proxy_html.conf

diff --git a/proxy_html.conf b/proxy_html.conf
index 4e9367e..49afe98 100644 (file)
--- a/proxy_html.conf
+++ b/proxy_html.conf
@@ -1,16 +1,20 @@
 # Configuration example.
 #
-# First, to load the module with its prerequisites
+# First, to load the module with its prerequisites.  Note: mod_xml2enc
+# is not always necessary, but without it mod_proxy_html is likely to
+# mangle pages in encodings other than ASCII or Unicode (utf-8).
 #
 # For Unix-family systems:
 # LoadFile     /usr/lib/libxml2.so
 # LoadModule   proxy_html_module       modules/mod_proxy_html.so
+# LoadModule   xml2enc_module          modules/mod_xml2enc.so
 #
 # For Windows (I don't know if there's a standard path for the libraries)
 # LoadFile     C:/path/zlib.dll
 # LoadFile     C:/path/iconv.dll
 # LoadFile     C:/path/libxml2.dll
 # LoadModule   proxy_html_module       modules/mod_proxy_html.so
+# LoadModule   xml2enc_module          modules/mod_xml2enc.so
 # 
 # All knowledge of HTML links has been removed from the mod_proxy_html
 # code itself, and is instead read from httpd.conf (or included file)
@@ -56,7 +60,26 @@ ProxyHTMLEvents      onclick ondblclick onmousedown onmouseup \
 #
 # ProxyHTMLLinks       myelement       myattr otherattr
 #
-# Also at top level in httpd.conf, you can declare charset aliases.
-# This is the most efficient way to support encodings that libxml2
-# doesn't natively support.  See the documentation at
+###########
+# EXAMPLE #
+###########
+#
+# To define the URL /my-gateway/ as a gateway to an appserver with address
+# http://some.app.intranet/ on a private network, after loading the
+# modules and including this configuration file:
+#
+# ProxyRequests Off  <-- this is an important security setting
+# ProxyPass /my-gateway/ http://some.app.intranet/
+# <Location /my-gateway/>
+#      ProxyPassReverse /
+#      ProxyHTMLEnable On
+#      ProxyHTMLURLMap http://some.app.intranet/ /my-gateway/
+#      ProxyHTMLURLMap / /my-gateway/
+# </Location>
+#
+# Many (though not all) real-life setups are more complex.
+#
+# See the documentation at
 # http://apache.webthing.com/mod_proxy_html/
+# and the tutorial at
+# http://www.apachetutor.org/admin/reverseproxies