doc/http_client.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % idcommon SYSTEM "common/common.ent">
   5      %idcommon;
   6 ]>
   7 <refentry id="ref-http_client">
   8  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <orgname>Index Data</orgname>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>http_client</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>http_client</refname>
  21   <refpurpose>Metaproxy HTTP File Server Module</refpurpose>
  22  </refnamediv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  26    This module implements HTTP client functionality. Filter frontend_net
  27    + http_client in combo - acts as a normal, non-transparent, proxy.
  28   </para>
  29   <para>
  30    The element default-host of configuration specifies the default host
  31    in remote URL. If this is set, frontend_net + http_client acts as a
  32    transparent HTTP proxy as well.
  33   </para>
  34   <para>
  35    The configuration element, proxy, is optional and enables a remote
  36    HTTP proxy to be in use.
  37   </para>
  38   <para>
  39    <variablelist>
  40     <varlistentry><term>default-host</term>
  41     <listitem>
  42      <para>
  43       Specifies host for transparant proxy mode.
  44      </para>
  45     </listitem>
  46     </varlistentry>
  47     <varlistentry><term>max-redirects</term>
  48      <listitem>
  49       <para>
  50        Maximum number of HTTP redirects. Default value is 0 (HTTP redirect
  51        disabled).
  52       </para>
  53      </listitem>
  54     </varlistentry>
  55     <varlistentry><term>proxy</term>
  56      <listitem>
  57       <para>
  58        Specifies HTTP proxy for outgoing connections.
  59       </para>
  60      </listitem>
  61     </varlistentry>
  62     <varlistentry><term>x-forwarded-for</term>
  63      <listitem>
  64       <para>
  65        Is a boolean value (false, true). If true, the peer
  66        IP address as seen in frontend_net will be added to
  67        x-forwarded HTTP header.
  68       </para>
  69      </listitem>
  70     </varlistentry>
  71     <varlistentry><term>bind_host</term>
  72      <listitem>
  73       <para>
  74        Is a boolean value (false, true). If true, the out going
  75        TCP connection will be bound to the same as listening IP.
  76       </para>
  77      </listitem>
  78     </varlistentry>
  79    </variablelist>
  80   </para>
  81  </refsect1>
  82
  83  <refsect1><title>SCHEMA</title>
  84    <literallayout><xi:include
  85                      xi:href="../xml/schema/filter_http_client.rnc"
  86                      xi:parse="text"
  87                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  88    </literallayout>
  89  </refsect1>
  90
  91  <refsect1><title>EXAMPLES</title>
  92   <para>
  93    A typical configuration looks like this:
  94    <screen><![CDATA[
  95    <filter type="http_client">
  96     <proxy>localhost:3128</proxy>
  97    </filter>
  98 ]]>
  99    </screen>
 100   </para>
 101  </refsect1>
 102
 103  <refsect1><title>SEE ALSO</title>
 104   <para>
 105    <citerefentry>
 106     <refentrytitle>metaproxy</refentrytitle>
 107     <manvolnum>1</manvolnum>
 108    </citerefentry>
 109   </para>
 110  </refsect1>
 111
 112  &copyright;
 113 </refentry>
 114
 115 <!-- Keep this comment at the end of the file
 116 Local variables:
 117 mode: nxml
 118 nxml-child-indent: 1
 119 End:
 120 -->