granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_express.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_proxy_express - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.5</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_proxy_express</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_express.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Dynamic mass reverse proxy extension for
  27 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_express_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_express.c</td></tr></table>
  31 <h3>Summary</h3>
  32
  33     <p>This module creates dynamically configured mass reverse
  34     proxies, by mapping the Host: header of the HTTP request to
  35     a server name and backend URL stored in a DBM file.
  36     This allows for easy use of a huge number of reverse proxies
  37     with no configuration changes. It is much less feature-full
  38     than <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code>, which also provides
  39     dynamic growth, but is intended to handle much, much
  40     larger numbers of backends. It is ideally suited as a
  41     front-end HTTP switch.</p>
  42
  43     <p>This module <em>requires</em> the service of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>.</p>
  44
  45     <div class="warning"><h3>Warning</h3>
  46       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  47       servers are dangerous both to your network and to the Internet at
  48       large.</p>
  49     </div>
  50
  51 <div class="note"><h3>Limitations</h3>
  52   <ul>
  53     <li>This module is not intended to replace the dynamic capability of
  54       <code class="module"><a href="../mod/mod_proxy_balancer.html">mod_proxy_balancer</a></code>. Instead, it is intended to be mostly
  55       a lightweight and fast alternative to using <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
  56       with <code class="directive">RewriteMap</code> and the <code>[P]</code> flag
  57       for mapped reverse proxying.
  58     </li>
  59     <li>It does not support regex or pattern matching at all.
  60     </li>
  61     <li>It emulates:
  62       <div class="example"><p><code>
  63         ProxyPass / backend.server:port<br />
  64         ProxyPassReverse / backend.server:port<br />
  65       </code></p></div>
  66       That is, the entire URL is appended to the mapped backend
  67       URL. This is in keeping with the intent of being a simple
  68       but fast reverse proxy switch.
  69     </li>
  70   </ul>
  71 </div>
  72
  73 </div>
  74 <div id="quickview"><h3 class="directives">Directives</h3>
  75 <ul id="toc">
  76 <li><img alt="" src="../images/down.gif" /> <a href="#proxyexpressdbmfile">ProxyExpressDBMFile</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#proxyexpressdbmtype">ProxyExpressDBMType</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#proxyexpressenable">ProxyExpressEnable</a></li>
  79 </ul>
  80 <h3>See also</h3>
  81 <ul class="seealso">
  82 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  83 </ul></div>
  84
  85 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  86 <div class="directive-section"><h2><a name="ProxyExpressDBMFile" id="ProxyExpressDBMFile">ProxyExpressDBMFile</a> <a name="proxyexpressdbmfile" id="proxyexpressdbmfile">Directive</a></h2>
  87 <table class="directive">
  88 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pathname to DBM file.</td></tr>
  89 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyExpressDBMFile &lt;pathname&gt;</code></td></tr>
  90 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None</code></td></tr>
  91 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  92 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  93 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_express</td></tr>
  94 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.13 and later</td></tr>
  95 </table>
  96   <p>The <code class="directive">ProxyExpressDBMFile</code> directive
  97     points to the location of the Express map DBM file. This
  98     file serves to map the incoming server name, obtained from
  99     the Host: header, to a backend URL.</p>
 100
 101     <div class="note"><h3>Note</h3>
 102       <p>The file is constructed from a plain text file format using
 103         the <code><a href="../programs/httxt2dbm.html">httxt2dbm</a></code>
 104         utility.</p>
 105
 106       <div class="example"><h3>ProxyExpress map file</h3><p><code>
 107         ##<br />
 108         ##express-map.txt:<br />
 109         ##<br />
 110         <br />
 111         www1.example.com    http://192.168.211.2:8080<br />
 112         www2.example.com   http://192.168.211.12:8088<br />
 113         www3.example.com   http://192.168.212.10<br />
 114       </code></p></div>
 115
 116       <div class="example"><h3>Create DBM file</h3><p><code>
 117         httxt2dbm -i express-map.txt -o emap<br />
 118         </code></p></div>
 119
 120       <div class="example"><h3>Configuration</h3><p><code>
 121         ProxyExpressDBMFile emap<br />
 122         </code></p></div>
 123     </div>
 124
 125 </div>
 126 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 127 <div class="directive-section"><h2><a name="ProxyExpressDBMType" id="ProxyExpressDBMType">ProxyExpressDBMType</a> <a name="proxyexpressdbmtype" id="proxyexpressdbmtype">Directive</a></h2>
 128 <table class="directive">
 129 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>DBM type of file.</td></tr>
 130 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyExpressDBMFile &lt;type&gt;</code></td></tr>
 131 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>"default"</code></td></tr>
 132 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 133 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 134 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_express</td></tr>
 135 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.13 and later</td></tr>
 136 </table>
 137   <p>The <code class="directive">ProxyExpressDBMType</code> directive
 138     controls the DBM type expected by the module. The default
 139     is the default DBM type created with <code>
 140     <a href="../programs/httxt2dbm.html">httxt2dbm</a></code></p>
 141
 142 </div>
 143 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 144 <div class="directive-section"><h2><a name="ProxyExpressEnable" id="ProxyExpressEnable">ProxyExpressEnable</a> <a name="proxyexpressenable" id="proxyexpressenable">Directive</a></h2>
 145 <table class="directive">
 146 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable the module functionality.</td></tr>
 147 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyExpressEnable [on|off]</code></td></tr>
 148 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>off</code></td></tr>
 149 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 150 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 151 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_express</td></tr>
 152 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.13 and later</td></tr>
 153 </table>
 154   <p>The <code class="directive">ProxyExpressEnable</code> directive
 155     controls whether the module will be active.</p>
 156
 157 </div>
 158 </div>
 159 <div class="bottomlang">
 160 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_express.html" title="English">&nbsp;en&nbsp;</a></p>
 161 </div><div id="footer">
 162 <p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 163 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 164 </body></html>