Apache 模块 mod_autoindex

Summary

目录的索引可以来自以下两个来源之一：

• 位于该目录中的文件，通常称为index.html。 DirectoryIndex伪指令设置要使用的一个或多个文件的名称。由mod_dir控制。

• 否则，服务器生成的列表。其他指令控制此 Lists 的格式。 AddIcon，AddIconByEncoding和AddIconByType用于设置图标列表以显示各种文件类型。对于列出的每个文件，将显示列出的与该文件匹配的第一个图标。这些由mod_autoindex控制。

这两个功能是分开的，因此您可以根据需要完全删除(或替换)自动索引生成。

使用Options +Indexes可启用自动索引生成。有关更多详细信息，请参见Options指令。

如果FancyIndexing选项与IndexOptions指令一起提供，则列标题是控制显示 Sequences 的链接。如果选择标题链接，将重新生成列表，并按该列中的值排序。重复选择相同的标题会在升序和降序之间切换。 IndexOptions指令的SuppressColumnSorting选项禁止显示这些列标题链接。

请注意，按“大小”对显示进行排序时，它是使用的文件的“实际”大小，而不是显示的值-因此，将始终在 1011 字节的文件之前显示 1010 字节的文件(如果按升序排列) )，即使它们都显示为“ 1K”。

自动索引请求查询参数

可以使用各种查询字符串参数来使 Client 端对目录列表的 Sequences 以及列出的文件有一些控制。如果您不希望向 Client 端提供此控制，则IndexOptions IgnoreClient选项将禁用该功能。

列排序标题本身就是自引用超链接，这些超链接添加了如下所示的排序查询选项。可以将以下任何选项添加到对目录资源的任何请求中。

• C=N按文件名对目录进行排序

• C=M按最后修改日期对目录进行排序，然后按文件名排序

• C=S按大小排序目录，然后按文件名排序

• C=D按描述对目录进行排序，然后按文件名排序

• O=A按升序对列表进行排序

• O=D按降序对列表进行排序

• F=0将列表格式化为简单列表(不是 FancyIndexed)

• F=1将列表格式化为 FancyIndexed 列表

• F=2将 Lists 格式化为 HTMLTable FancyIndexed Lists

• V=0禁用版本排序

• V=1启用版本排序

• P=pattern仅列出与给定模式匹配的文件

请注意，在处理了常规的IndexIgnore指令之后*，将测试'P'attern 查询参数，并且所有文件名仍与其他任何自动索引列表一样受相同的条件约束。遇到无法识别的选项时，mod_autoindex中的查询参数解析器将突然停止。根据上表，查询参数必须格式正确。

下面的简单示例可以裁剪并保存在 header.html 文件中，它说明了这些查询选项。请注意，最后一个列出了“提交”按钮的未知“ X”参数，以确保在 mod_autoindex 遇到 X = Go Importing 之前已对所有参数进行了解析。

<form action="" method="get"> Show me a <select name="F"> <option value="0"> Plain list</option> <option value="1" selected="selected"> Fancy list</option> <option value="2"> Table list</option> </select> Sorted by <select name="C"> <option value="N" selected="selected"> Name</option> <option value="M"> Date Modified</option> <option value="S"> Size</option> <option value="D"> Description</option> </select> <select name="O"> <option value="A" selected="selected"> Ascending</option> <option value="D"> Descending</option> </select> <select name="V"> <option value="0" selected="selected"> in Normal order</option> <option value="1"> in Version order</option> </select> Matching <input type="text" name="P" value="*" /> <input type="submit" name="X" value="Go" /> </form>

AddAlt Directive

AddAlt为文件FancyIndexing提供要显示的替代文本，而不是图标。 File 是文件 extensions，部分文件名，通配符表达式或完整文件名，用于描述文件。如果 String 包含任何空格，则必须将其用引号引起来("或')。如果 Client 端没有图像，禁用了图像加载或无法检索图标，则会显示此备用文本。

AddAlt "PDF file" *.pdf
AddAlt Compressed *.gz *.zip *.Z

AddAltByEncoding Directive

AddAltByEncoding为文件FancyIndexing提供要显示的替代文本，而不是图标。 MIME 编码是有效的内容编码，例如x-compress。如果 String 包含任何空格，则必须将其用引号引起来("或')。如果 Client 端没有图像，禁用了图像加载或无法检索图标，则会显示此备用文本。

AddAltByEncoding gzip x-gzip

AddAltByType Directive

AddAltByType将FancyIndexing设置为显示文件的替代文本，而不是图标。 MIME-type 是有效的 Content Type，例如text/html。如果 String 包含任何空格，则必须将其用引号引起来("或')。如果 Client 端没有图像，禁用了图像加载或无法检索图标，则会显示此备用文本。

AddAltByType 'plain text' text/plain

AddDescription Directive

这将设置描述显示为文件FancyIndexing。 File 是文件 extensions，部分文件名，通配符表达式或完整文件名，用于描述文件。字符串用双引号(")括起来。

AddDescription "The planet Mars" mars.gif
AddDescription "My friend Marshall" friends/mars.gif

典型的默认描述字段为 23 个字节宽。 IndexOptions SuppressIcon选项添加了 6 个字节，IndexOptions SuppressSize选项添加了 7 个字节，IndexOptions SuppressLastModified选项添加了 19 个字节。因此，描述列分配的最宽默认值是 55 个字节。

由于 File 参数可能是部分文件名，因此请记住，部分文件名太短可能会与意外文件匹配。例如，le.html将与文件le.html匹配，但也将与文件example.html匹配。如果可能存在歧义，请尽可能完整地使用文件名，但请记住，将使用遇到的第一个匹配项，并相应地对AddDescription指令列表进行排序。

有关覆盖此列的大小或允许描述长度不受限制的详细信息，请参见DescriptionWidth IndexOptions关键字。

AddIcon Directive

这会将图标设置为显示在名称以FancyIndexing结尾的文件旁边。 Icon 可以是图标的(％转义)相对 URL，完全限定的远程 URL，也可以是(alttext,url)格式，其中 alttext 是为非图形浏览器的图标提供的文本标签。

名称对于目录是^^DIRECTORY^^，对于空白行是^^BLANKICON^^(以正确格式化列表)，文件 extensions，通配符表达式，部分文件名或完整文件名。

^^BLANKICON^^仅用于格式化，因此如果使用IndexOptions HTMLTable则不需要。

#Examples
AddIcon (IMG,/icons/image.png) .gif .jpg .png
AddIcon /icons/dir.png ^^DIRECTORY^^
AddIcon /icons/backup.png *~

尽可能使用AddIconByType优先于AddIcon。

AddIconByEncoding Directive

设置图标以显示在带有FancyIndexing的文件旁边。 Icon 可以是图标的(％转义)相对 URL，完全限定的远程 URL，也可以是(alttext,url)格式，其中 alttext 是为非图形浏览器的图标提供的文本标签。

MIME 编码是有效的内容编码，例如x-compress。

AddIconByEncoding /icons/compress.png x-compress

AddIconByType Directive

这会将图标设置为显示在FancyIndexing的 MIME 类型的文件旁边。 Icon 可以是图标的(％转义)相对 URL，完全限定的远程 URL，也可以是(alttext,url)格式，其中 alttext 是为非图形浏览器的图标提供的文本标签。

MIME-type 是与必需的 mime 类型匹配的通配符表达式。

AddIconByType (IMG,/icons/image.png) image/*

DefaultIcon Directive

DefaultIcon指令将图标FancyIndexing设置为在没有特定图标时显示文件。网址路径是图标的(％转义)相对 URL，或完全合格的远程 URL。

DefaultIcon /icon/unknown.png

HeaderName Directive

HeaderName伪指令设置将插入索引列表顶部的文件的名称。 Filename 是要包含的文件的名称。

HeaderName HEADER.html

HeaderName /include/HEADER.html

AddType text/html .cgi

如果HeaderName指定的文件包含 HTML 文档的开头(，等)，则您可能需要设置IndexOptions +SuppressHTMLPreamble，以便不重复这些标签。

See also

• ReadmeName

IndexHeadInsert Directive

IndexHeadInsert伪指令指定要在为索引页生成的 HTML 的部分中插入的字符串。

IndexHeadInsert "<link rel=\"sitemap\" href=\"/sitemap.html\">"

IndexIgnore Directive

IndexIgnore伪指令添加到列出目录时隐藏的文件列表中。文件是 Shell 样式的通配符表达式或完整文件名。多个 IndexIgnore 伪指令添加到列表中，而不是替换被忽略文件的列表。默认情况下，列表包含.(当前目录)。

IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

IndexIgnoreReset Directive

IndexIgnoreReset指令删除IndexIgnore忽略的所有文件，否则这些文件将从其他配置节继承。

<Directory "/var/www">
    IndexIgnore *.bak .??* *~ *# HEADER* README* RCS CVS *,v *,t
</Directory>
<Directory "/var/www/backups">
    IndexIgnoreReset ON
    IndexIgnore .??* *# HEADER* README* RCS CVS *,v *,t
</Directory>

IndexOptions Directive

IndexOptions伪指令指定目录索引的行为。选项可以是以下之一

• AddAltClass

  • 当IndexOptions HTMLTable有效并且定义了IndexStyleSheet时，向目录列表的每一行添加一个附加的 CSS 类声明。而不是将标准的even和odd类应用于表的每一行，而是even-ALT或odd-ALT的类，其中* ALT 是与文件样式关联的标准 alt 文本(例如 snd ， txt ， img *等)或由各种AddAlt*指令之一定义的替代文本。

• Charset=character-set(* Apache HTTP Server 2.0.61 及更高版本*)

  • Charset关键字使您可以指定所生成页面的字符集。在 Windows 和 Mac OS X 上，默认值为UTF-8，在其他位置为ISO-8859-1。 (这取决于基础文件系统是否使用 Unicode 文件名.)

IndexOptions Charset=UTF-8

• DescriptionWidth=[n | *]

  • DescriptionWidth关键字使您可以指定描述列的宽度(以字符为单位)。

• -DescriptionWidth(或未设置)允许mod_autoindex计算最佳宽度。

  • DescriptionWidth=n将列宽固定为 n 个字节宽。

  • DescriptionWidth=*将列增长到容纳最长描述字符串所需的宽度。 请参见AddDescription部分，了解截断说明中固有的危险.

• FancyIndexing

  • 这将打开目录的精美索引。

• FoldersFirst

  • 如果启用此选项，子目录列表将总是首先出现，然后是目录中的普通文件。Lists 基本上分为两个部分，文件和子目录，分别进行分类，然后显示子目录-第一个。例如，如果排序 Sequences 按名称降序，并且启用了FoldersFirst，则子目录Zed将在子目录Beta之前列出，子目录Beta将在普通文件Gamma和Alpha之前列出。 只有同时启用了FancyIndexing，此选项才有效.

• HTMLTable

  • 带有FancyIndexing的此选项为精美目录列表构造了一个简单表。对于启用了 utf-8 的平台，或者文件名或描述文本在从左到右和从右到左的阅读 Sequences 之间交替变化，这是必要的。

• IconsAreLinks

  • 这使得图标成为文件名锚点的一部分，以进行精美索引。

• IconHeight[=pixels]

  • 与IconWidth一起使用时，此选项的存在将导致服务器在文件图标的img标记中包含height和width属性。这使浏览器可以预先计算页面布局，而不必等到所有图像都加载完毕。如果未为该选项提供值，则默认为 Apache httpd 软件随附的图标的标准高度。 只有同时启用了FancyIndexing，此选项才有效.

• IconWidth[=pixels]

  • 与IconHeight一起使用时，此选项的存在将导致服务器在文件图标的img标记中包含height和width属性。这使浏览器可以预先计算页面布局，而不必等到所有图像都加载完毕。如果没有为该选项提供值，则默认为 Apache httpd 软件随附的图标的标准宽度。

• IgnoreCase

  • 如果启用此选项，则名称以不区分大小写的方式排序。例如，如果排序 Sequences 按名称升序，并且启用了IgnoreCase，则文件 Zeta 将在文件 alfa 之后列出(注意：文件 GAMMA 将始终在文件 gamma 之前列出)。

• IgnoreClient

  • 此选项使mod_autoindex忽略来自 Client 端的所有查询变量，包括排序 Sequences(隐含SuppressColumnSorting)。

• NameWidth=[n | *]

  • NameWidth关键字使您可以指定文件名列的宽度(以字节为单位)。

  • -NameWidth(或未设置)允许mod_autoindex计算最佳宽度，但最大宽度不能超过 20 个字节。

  • NameWidth=n将列宽固定为 n 个字节宽。

  • NameWidth=*将列增长到必要的宽度。

• ScanHTMLTitles

  • 这使得能够从 HTML 文档中提取标题以进行花式索引。如果该文件没有AddDescription给出的描述，则 httpd 将读取文档中title元素的值。这会占用大量 CPU 和磁盘。

• ShowForbidden

  • 如果指定，Apache httpd 将显示通常隐藏的文件，因为子请求返回了HTTP_UNAUTHORIZED或HTTP_FORBIDDEN

• SuppressColumnSorting

  • 如果指定，Apache httpd 将不会使 FancyIndexed 目录中的列标题成为用于排序的链接。默认行为是使它们成为链接。选择列标题将按该列中的值对目录列表进行排序。但是，仍将保留附加到 URL 的查询字符串参数。该行为由IndexOptions IgnoreClient控制。

• SuppressDescription

  • 这将取消花式索引列表中的文件描述。默认情况下，没有定义文件描述，因此使用此选项将重新获得 23 个字符的屏幕空间以用于其他用途。有关设置文件说明的信息，请参见AddDescription。另请参见DescriptionWidth索引选项以限制描述列的大小。 仅当同时启用FancyIndexing时，此选项才有效.

• SuppressHTMLPreamble

  • 如果目录实际上包含由HeaderName指令指定的文件，则该模块通常在标准 HTML 前导码(<html>，<head>，* et cetera *)之后包含文件的内容。 SuppressHTMLPreamble选项禁用此行为，从而使模块以头文件内容开始显示。在这种情况下，头文件必须包含适当的 HTML 指令。如果没有头文件，则照常生成前同步码。如果您还指定了ReadmeName，并且该文件存在，则假设您可能会将结束标记放在该文件中，那么在输出中也将省略</ body> </ html>标记。

• SuppressIcon

  • 这将取消在豪华索引列表中的图标。组合SuppressIcon和SuppressRules会产生适当的 HTML 3.2 输出，根据最终规范，该输出禁止pre块中的img和hr元素(用于格式化 FancyIndexed 列表)。

• SuppressLastModified

  • 这将禁止在花式索引列表中显示最后修改日期。 只有同时启用了FancyIndexing，此选项才有效.

• SuppressRules

  • 这将取消目录列表中的水平线(hr元素)。组合SuppressIcon和SuppressRules会产生正确的 HTML 3.2 输出，根据最终规范，该输出禁止pre块中的img和hr元素(用于格式化 FancyIndexed 列表.) 仅当同时启用了FancyIndexing时，此选项才有效.

• SuppressSize

  • 这将抑制花式索引列表中的文件大小。 只有同时启用了FancyIndexing，此选项才有效.

• TrackModified

  • 这将返回 HTTP Headers 中列出的目录的Last-Modified和ETag值。仅当 os 和文件系统返回适当的 stat()结果时才有效。某些 Unix 系统会这样做，OS2 的 JFS 和 Win32 的 NTFS 卷也是如此。例如，没有 OS2 和 Win32 FAT 卷。启用此功能后，Client 端或代理执行HEAD请求时就可以跟踪对文件列表的更改。请注意，某些 os 可以正确跟踪新文件和已删除文件，但不能跟踪目录中文件大小或日期的更改。 更改现有文件的大小或日期戳不会在所有 Unix 平台上更新Last-ModifiedHeaders. 如果您对此有所关注，请禁用此选项。

• Type=MIME content-type(* Apache HTTP Server 2.0.61 及更高版本*)

  • Type关键字使您可以指定所生成页面的 MIME Content Type。默认值为 text/html。

IndexOptions Type=text/plain

• UseOldDateFormat(* Apache HTTP Server 2.4.26 及更高版本*)

  • Last Modified字段使用的日期格式无意中从 2.4.0 中的"%d-%b-%Y %H:%M"更改为"%Y-%m-%d %H:%M"。设置此选项可将日期格式从 2.2 或更早版本恢复。

• VersionSort(* Apache HTTP Server 2.0a3 及更高版本*)

  • VersionSort关键字使包含版本号的文件以自然方式排序。字符串按常规排序，只是名称和描述中的数字子字符串根据其数字值进行比较。

Example:

foo-1.7 foo-1.7.2 foo-1.7.12 foo-1.8.2 foo-1.8.2a foo-1.12

如果数字以零开头，则认为是分数：

foo-1.001 foo-1.002 foo-1.030 foo-1.04

• XHTML(* Apache HTTP Server 2.0.49 及更高版本*)

  • 关键字XHTML强制mod_autoindex发出 XHTML 1.0 代码而不是 HTML 3.2. 只有同时启用了FancyIndexing，此选项才有效.

• Incremental IndexOptions

  • 请注意如何处理多个IndexOptions。

• 现在，单个目录的多个IndexOptions指令合并在一起。的结果：

<Directory "/foo">
    IndexOptions HTMLTable
    IndexOptions SuppressColumnsorting
</Directory>

将等于

IndexOptions HTMLTable SuppressColumnsorting

• 增加了增量语法(* i.e. *，前缀为+或-的关键字)。

每当遇到带有''或'-'前缀的关键字时，它将应用于当前的IndexOptions设置(该设置可能是从上一级目录继承的)。但是，每当处理一个无前缀的关键字时，它都会清除所有继承的选项以及到目前为止遇到的所有增量设置。考虑以下示例：

IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
IndexOptions +SuppressSize

净效果等同于IndexOptions FancyIndexing +SuppressSize，因为未前缀FancyIndexing丢弃了它之前的增量关键字，但允许它们随后再次开始累加。

要无条件为特定目录设置IndexOptions，清除继承的设置，请指定没有任何+或-前缀的关键字。

IndexOrderDefault Directive

IndexOrderDefault指令与FancyIndexing索引选项结合使用。默认情况下，fancyindexed 目录列表按文件名升序显示； IndexOrderDefault允许您更改此初始显示 Sequences。

IndexOrderDefault接受两个参数。第一个必须是Ascending或Descending，指示排序的方向。第二个参数必须是关键字Name，Date，Size或Description之一，并且标识主键。次要键始终是升序文件名。

如果需要，您还可以通过添加SuppressColumnSorting索引选项以删除列顶部的排序链接以及IgnoreClient索引选项以防止 Client 端手动将排序选项添加到查询字符串中，来防止 Client 端重新排序列表为了覆盖您的 Order 偏好。

IndexStyleSheet Directive

IndexStyleSheet指令设置将用作索引列表的 CSS 的文件的名称。

IndexStyleSheet "/css/style.css"

将此指令与IndexOptions HTMLTable结合使用，会在结果 HTML 中添加许多 CSS 类。整个表的 CSS ID 为indexlist，并且以下类别与 Lists 的各个部分相关联：

ReadmeName Directive

ReadmeName指令设置将添加到索引列表末尾的文件的名称。 Filename 是要包含的文件的名称，并被视为相对于要构建索引的位置而言。如果 Filename 以斜杠开头，如示例 2 所示，它将被视为相对于DocumentRoot。

# Example 1
ReadmeName FOOTER.html

# Example 2
ReadmeName /include/FOOTER.html

另请参见HeaderName，其中详细描述了此行为。