From: Andre Malo <nd@apache.org>
Date: Fri, 20 Dec 2002 16:44:46 +0000 (+0000)
Subject: add initial documentation for mod_proxy_connect, mod_proxy_ftp
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=37e362bbaec907cf76c8c658b3100f0e8522f38e;p=apache

add initial documentation for mod_proxy_connect, mod_proxy_ftp
and mod_proxy_http


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@98054 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_proxy_connect.xml b/docs/manual/mod/mod_proxy_connect.xml
new file mode 100644
index 0000000000..f694b51afd
--- /dev/null
+++ b/docs/manual/mod/mod_proxy_connect.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<modulesynopsis>
+
+<name>mod_proxy_connect</name>
+<description><module>mod_proxy</module> extension for
+<code>CONNECT</code> request handling</description>
+<status>Extension</status>
+<sourcefile>proxy_connect.c</sourcefile>
+<identifier>proxy_connect_module</identifier>
+
+<summary>
+    <p>This module <em>requires</em> the service of <module
+    >mod_proxy</module>. It provides support for the <code>CONNECT</code>
+    HTTP method. This method is mainly used to tunnel SSL requests
+    through proxy servers.</p>
+
+    <p>Thus, in order to get the ability of handling <code>CONNECT</code>
+    requests, <module>mod_proxy</module> and
+    <module>mod_proxy_connect</module> have to be present in the server.</p>
+
+    <note type="warning"><title>Warning</title>
+      <p>Do not enable proxying until you have <a
+      href="mod_proxy.html#access">secured your server</a>. Open proxy
+      servers are dangerous both to your network and to the Internet at
+      large.</p>
+    </note>
+</summary>
+<seealso><directive module="mod_proxy">AllowCONNECT</directive></seealso>
+<seealso><module>mod_proxy</module></seealso>
+
+</modulesynopsis>
diff --git a/docs/manual/mod/mod_proxy_ftp.xml b/docs/manual/mod/mod_proxy_ftp.xml
new file mode 100644
index 0000000000..7e87d3239f
--- /dev/null
+++ b/docs/manual/mod/mod_proxy_ftp.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<modulesynopsis>
+
+<name>mod_proxy_ftp</name>
+<description>FTP support module for
+<module>mod_proxy</module></description>
+<status>Extension</status>
+<sourcefile>proxy_ftp.c</sourcefile>
+<identifier>proxy_ftp_module</identifier>
+
+<summary>
+    <p>This module <em>requires</em> the service of <module
+    >mod_proxy</module>. It provides support for the proxying
+    FTP sites.</p>
+
+    <p>Thus, in order to get the ability of handling FTP proxy requests,
+    <module>mod_proxy</module> and <module>mod_proxy_ftp</module>
+    have to be present in the server.</p>
+
+    <note type="warning"><title>Warning</title>
+      <p>Do not enable proxying until you have <a
+      href="mod_proxy.html#access">secured your server</a>. Open proxy
+      servers are dangerous both to your network and to the Internet at
+      large.</p>
+    </note>
+</summary>
+<seealso><module>mod_proxy</module></seealso>
+
+</modulesynopsis>
diff --git a/docs/manual/mod/mod_proxy_http.xml b/docs/manual/mod/mod_proxy_http.xml
new file mode 100644
index 0000000000..bc43bcdcaa
--- /dev/null
+++ b/docs/manual/mod/mod_proxy_http.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<modulesynopsis>
+
+<name>mod_proxy_http</name>
+<description>HTTP support module for
+<module>mod_proxy</module></description>
+<status>Extension</status>
+<sourcefile>proxy_http.c</sourcefile>
+<identifier>proxy_http_module</identifier>
+
+<summary>
+    <p>This module <em>requires</em> the service of <module
+    >mod_proxy</module>. It provides the features used for
+    proxying HTTP requests. <module>mod_proxy_http</module>
+    supports HTTP/0.9, HTTP/1.0 and HTTP/1.1. It does <em>not</em>
+    provide any caching abilities. If you want to set up a caching
+    proxy, you might want to use the additional service of the
+    <module>mod_cache</module> module.</p>
+
+    <p>Thus, in order to get the ability of handling HTTP proxy requests,
+    <module>mod_proxy</module> and <module>mod_proxy_http</module>
+    have to be present in the server.</p>
+
+    <note type="warning"><title>Warning</title>
+      <p>Do not enable proxying until you have <a
+      href="mod_proxy.html#access">secured your server</a>. Open proxy
+      servers are dangerous both to your network and to the Internet at
+      large.</p>
+    </note>
+</summary>
+<seealso><module>mod_proxy</module></seealso>
+<seealso><module>mod_proxy_connect</module></seealso>
+
+</modulesynopsis>
diff --git a/docs/manual/sitemap.xml b/docs/manual/sitemap.xml
index 7d67ade407..41cb1bf7e7 100644
--- a/docs/manual/sitemap.xml
+++ b/docs/manual/sitemap.xml
@@ -170,6 +170,9 @@ Server on HPUX</page>
   <modulefile>mod_mime_magic.xml</modulefile>
   <modulefile>mod_negotiation.xml</modulefile>
   <modulefile>mod_proxy.xml</modulefile>
+  <modulefile>mod_proxy_connect.xml</modulefile>
+  <modulefile>mod_proxy_ftp.xml</modulefile>
+  <modulefile>mod_proxy_http.xml</modulefile>
   <modulefile>mod_rewrite.xml</modulefile>
   <modulefile>mod_setenvif.xml</modulefile>
   <modulefile>mod_so.xml</modulefile>