2510a20414d48747adb222d76d4a8925529bc612
[metaproxy-moved-to-github.git] / doc / http_file.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
2     "http://www.oasis-open.org/docbook/xml/4.1/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  <refmeta>
9   <refentrytitle>http_file</refentrytitle>
10   <manvolnum>3mp</manvolnum>
11    <refmiscinfo>Metaproxy Module</refmiscinfo>
12 </refmeta>
13  
14  <refnamediv>
15   <refname>http_file</refname>
16   <refpurpose>Metaproxy HTTP File Server Module</refpurpose>
17  </refnamediv>
18  
19  <refsect1><title>DESCRIPTION</title>
20   <para>
21    This module enables file access via the HTTP protocol.
22    All URLs with a given prefix are directed to a specific
23    document root (on local file storage). The module only serves
24    static content.
25   </para>
26  </refsect1>
27  
28  <refsect1><title>EXAMPLES</title>
29   <para>
30    A typical configuration looks like this:
31    <screen><![CDATA[
32    <filter type="http_file">
33     <mimetypes>/etc/mime.types</mimetypes>
34     <area>
35      <documentroot>/var/www/metaproxy/html</port>
36      <prefix>/etc</prefixs>
37     </area>
38    </filter>
39 ]]>
40    </screen>
41   </para>
42  </refsect1> 
43  
44  <refsect1><title>SEE ALSO</title>
45   <para>
46    <citerefentry>
47     <refentrytitle>metaproxy</refentrytitle>
48     <manvolnum>1</manvolnum>
49    </citerefentry>
50   </para>
51  </refsect1>
52  
53  &copyright;
54 </refentry>
55
56 <!-- Keep this comment at the end of the file
57 Local variables:
58 mode: sgml
59 sgml-omittag:t
60 sgml-shorttag:t
61 sgml-minimize-attributes:nil
62 sgml-always-quote-attributes:t
63 sgml-indent-step:1
64 sgml-indent-data:t
65 sgml-parent-document:nil
66 sgml-local-catalogs: nil
67 sgml-namecase-general:t
68 End:
69 -->