Mercurial > hg > nginx-site
view xml/en/docs/http/ngx_http_autoindex_module.xml @ 2846:fdf1464e1977
Moved banner to the external file to make partial rollout possible.
An idea is to have several banners and show them with different probability
specified by split directive in the nginx.conf
author | Sergey Budnevitch <sb@waeme.net> |
---|---|
date | Tue, 10 May 2022 18:07:27 +0400 |
parents | 6866a74393e0 |
children |
line wrap: on
line source
<?xml version="1.0"?> <!-- Copyright (C) Igor Sysoev Copyright (C) Nginx, Inc. --> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> <module name="Module ngx_http_autoindex_module" link="/en/docs/http/ngx_http_autoindex_module.html" lang="en" rev="4"> <section id="summary"> <para> The <literal>ngx_http_autoindex_module</literal> module processes requests ending with the slash character (‘<literal>/</literal>’) and produces a directory listing. Usually a request is passed to the <literal>ngx_http_autoindex_module</literal> module when the <link doc="ngx_http_index_module.xml">ngx_http_index_module</link> module cannot find an index file. </para> </section> <section id="example" name="Example Configuration"> <para> <example> location / { autoindex on; } </example> </para> </section> <section id="directives" name="Directives"> <directive name="autoindex"> <syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> <context>location</context> <para> Enables or disables the directory listing output. </para> </directive> <directive name="autoindex_exact_size"> <syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> <context>location</context> <para> For the HTML <link id="autoindex_format">format</link>, specifies whether exact file sizes should be output in the directory listing, or rather rounded to kilobytes, megabytes, and gigabytes. </para> </directive> <directive name="autoindex_format"> <syntax> <literal>html</literal> | <literal>xml</literal> | <literal>json</literal> | <literal>jsonp</literal></syntax> <default>html</default> <context>http</context> <context>server</context> <context>location</context> <appeared-in>1.7.9</appeared-in> <para> Sets the format of a directory listing. </para> <para> When the JSONP format is used, the name of a callback function is set with the <literal>callback</literal> request argument. If the argument is missing or has an empty value, then the JSON format is used. </para> <para> The XML output can be transformed using the <link doc="ngx_http_xslt_module.xml">ngx_http_xslt_module</link> module. </para> </directive> <directive name="autoindex_localtime"> <syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> <context>location</context> <para> For the HTML <link id="autoindex_format">format</link>, specifies whether times in the directory listing should be output in the local time zone or UTC. </para> </directive> </section> </module>