doc/http_file.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_file">
   8  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <orgname>Index Data</orgname>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>http_file</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>http_file</refname>
  21   <refpurpose>Metaproxy HTTP File Server Module</refpurpose>
  22  </refnamediv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  26    This module enables file access via the HTTP protocol.
  27    All URLs with a given prefix are directed to a specific
  28    document root (on local file storage). The module only serves
  29    static content.
  30   </para>
  31  </refsect1>
  32
  33  <refsect1><title>SCHEMA</title>
  34    <literallayout><xi:include
  35                      xi:href="../xml/schema/filter_http_file.rnc"
  36                      xi:parse="text"
  37                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  38    </literallayout>
  39  </refsect1>
  40
  41  <refsect1><title>EXAMPLES</title>
  42   <para>
  43    A typical configuration looks like this:
  44    <screen><![CDATA[
  45    <filter type="http_file">
  46     <mimetypes>/etc/mime.types</mimetypes>
  47     <area>
  48      <documentroot>/var/www/metaproxy/html</documentroot>
  49      <prefix>/etc</prefix>
  50     </area>
  51    </filter>
  52 ]]>
  53    </screen>
  54   </para>
  55  </refsect1>
  56
  57  <refsect1><title>SEE ALSO</title>
  58   <para>
  59    <citerefentry>
  60     <refentrytitle>metaproxy</refentrytitle>
  61     <manvolnum>1</manvolnum>
  62    </citerefentry>
  63   </para>
  64  </refsect1>
  65
  66  &copyright;
  67 </refentry>
  68
  69 <!-- Keep this comment at the end of the file
  70 Local variables:
  71 mode: nxml
  72 nxml-child-indent: 1
  73 End:
  74 -->