Fix idmetaversion strips n SA-743

[metaproxy-moved-to-github.git] / doc / http_client.xml

diff --git a/doc/http_client.xml b/doc/http_client.xml
index 17d2355..50ef7b8 100644 (file)
--- a/doc/http_client.xml
+++ b/doc/http_client.xml
@@ -23,11 +23,60 @@
 
  <refsect1><title>DESCRIPTION</title>
   <para>
-   This module implements HTTP client functionality. By default,
-   if proxy element is not given, it should be used as an explicit
-   proxy (non-transparent mode). If proxy element is set, requests
-   will be relayed to the proxy given (transparent mode for HTTP clients
-   accessing this module).
+   This module implements HTTP client functionality. Filter frontend_net
+   + http_client in combo - acts as a normal, non-transparent, proxy.
+  </para>
+  <para>
+   The element default-host of configuration specifies the default host
+   in remote URL. If this is set, frontend_net + http_client acts as a
+   transparent HTTP proxy as well.
+  </para>
+  <para>
+   The configuration element, proxy, is optional and enables a remote
+   HTTP proxy to be in use.
+  </para>
+  <para>
+   <variablelist>
+    <varlistentry><term>default-host</term>
+    <listitem>
+     <para>
+      Specifies host for transparant proxy mode.
+     </para>
+    </listitem>
+    </varlistentry>
+    <varlistentry><term>max-redirects</term>
+     <listitem>
+      <para>
+       Maximum number of HTTP redirects. Default value is 0 (HTTP redirect
+       disabled).
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>proxy</term>
+     <listitem>
+      <para>
+       Specifies HTTP proxy for outgoing connections.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>x-forwarded-for</term>
+     <listitem>
+      <para>
+       Is a boolean value (false, true). If true, the peer
+       IP address as seen in frontend_net will be added to
+       x-forwarded HTTP header.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>bind_host</term>
+     <listitem>
+      <para>
+       Is a boolean value (false, true). If true, the out going
+       TCP connection will be bound to the same as listening IP.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
   </para>
  </refsect1>
 
@@ -44,7 +93,7 @@
    A typical configuration looks like this:
    <screen><![CDATA[
    <filter type="http_client">
-    <proxy>localhost:9999</proxy>
+    <proxy>localhost:3128</proxy>
    </filter>
 ]]>
    </screen>