Apache Module mod_autoindex

HEADER* README* RCS CVS *,v *,t

HEADER* README* RCS CVS *,v *,t IndexIgnoreReset ON IndexIgnore .??* *

HEADER* README* RCS CVS *,v *,t

Example 1 ReadmeName FOOTER.html

Example 2 ReadmeName /include/FOOTER.html

command or the Win32 dir

shell commandThe index of a directory can come from one of two sources:

directive sets the name of the file or files to be used. This is controlled by mod_dir

are used to set a list of icons to display for various file types; for each file listed, the first icon listed that matches the file is displayed. These are controlled by mod_autoindex

.The two functions are separated so that you can completely remove (or replace) automatic index generation should you want to.

Automatic index generation is enabled with using Options +Indexes

directive for more details.Options

directive, the column headers are links that control the order of the display. If you select a header link, the listing will be regenerated, sorted by the values in that column. Selecting the same header repeatedly toggles between ascending and descending order. These column header links are suppressed with the IndexOptions

Note that when the display is sorted by "Size", it's the actual size of the files that's used, not the displayed value - so a 1010-byte file will always be displayed before a 1011-byte file (if in ascending order) even though they both are shown as "1K".

The column sorting headers themselves are self-referencing hyperlinks that add the sort query options shown below. Any option below may be added to any request for the directory resource.

sorts the directory by file nameC=M

sorts the directory by last-modified date, then file nameC=S

formats the listing as a simple list (not FancyIndexed)F=1

formats the listing as an HTMLTable FancyIndexed listV=0

enables version sortingP=pattern

lists only files matching the given Note that the 'P'attern query argument is tested after the usual

directives are processed, and all file names are still subjected to the same criteria as any other autoindex listing. The Query Arguments parser in IndexIgnore

will stop abruptly when an unrecognized option is encountered. The Query Arguments must be well formed, according to the table above.mod_autoindex

The simple example below, which can be clipped and saved in a header.html file, illustrates these query options. Note that the unknown "X" argument, for the submit button, is listed last to assure the arguments are all parsed before mod_autoindex encounters the X=Go input.

Fancy list

). This alternate text is displayed if the client is image-incapable, has image loading disabled, or fails to retrieve the icon.

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

AddAltByEncoding gzip x-gzip

AddAltByType 'plain text' text/plain

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

The typical, default description field is 23 bytes wide. 6 more bytes are added by the

option. Therefore, the widest default the description column is ever assigned is 55 bytes.IndexOptions SuppressLastModified

Since the File argument may be a partial file name, please remember that a too-short partial filename may match unintended files. For example, le.html

. In the event that there may be ambiguity, use as complete a filename as you can, but keep in mind that the first match encountered will be used, and order your list of AddDescription

keyword for details on overriding the size of this column, or allowing descriptions of unlimited length.IndexOptions

Descriptive text defined with AddDescription

may contain HTML markup, such as tags and character entities. If the width of the description column should happen to truncate a tagged element (such as cutting off the end of a bolded phrase), the results may affect the rest of the directory listing.

Absolute paths are not currently supported and do not match anything at runtime. Arguments with relative path information, which would normally only be used in htaccess context, are implicitly prefixed with '*/' to avoid matching partial directory names.

for blank lines (to format the list correctly), a file extension, a wildcard expression, a partial filename or a complete filename.

is only used for formatting, and so is unnecessary if you're using IndexOptions HTMLTable

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

should be used in preference to AddIconByTypeAddIcon

now treat ReadmeNameFilename as a URI path relative to the one used to access the directory being indexed. If Filename begins with a slash, it will be taken to be relative to the

Filename must resolve to a document with a major content type of text/*

(e.g., text/html

, etc.). This means that filename may refer to a CGI script if the script's actual file type (as opposed to its output) is marked as text/html

Content negotiation will be performed if OptionsMultiViews

is in effect. If filename resolves to a static text/html

is enabled, the file will be processed for server-side includes (see the

contains the beginnings of an HTML document (, , etc.) then you will probably want to set IndexOptions +SuppressHTMLPreamble, so that these tags are not repeated.

This directive does not currently work in configuration sections that have regular expression arguments, such as

Review the default configuration for a list of patterns that you might want to explicitly ignore after using this directive.

classes that would otherwise be applied to each row of the table, a class of even-ALT

on Windows and Mac OS X, and ISO-8859-1

elsewhere. (It depends on whether the underlying file system uses Unicode filenames or not.) IndexOptions Charset=UTF-8

keyword allows you to specify the width of the description column in characters.-DescriptionWidth

to calculate the best width.DescriptionWidth=n

grows the column to the width necessary to accommodate the longest description string.AddDescription

for dangers inherent in truncating descriptions.FoldersFirst

is enabled, subdirectory Zed

, which will be listed before normal files Gamma

constructs a simple table for the fancy directory listing. It is necessary for utf-8 enabled platforms or if file names or description text will alternate between left-to-right and right-to-left reading order.IconWidth

, will cause the server to include height

tag for the file icon. This allows browser to precalculate the page layout without having to wait until all the images have been loaded. If no value is given for the option, it defaults to the standard height of the icons supplied with the Apache httpd software.IconHeight

is enabled, file Zeta will be listed after file alfa (Note: file GAMMA will always be listed before file gamma). mod_autoindex

to ignore all query variables from the client, including sort order (implies SuppressColumnSorting

fixes the column width to NameWidth=*

then httpd will read the document for the value of the title

element. This is CPU and disk intensive.HTTP_UNAUTHORIZED

for information about setting the file description. See also the DescriptionWidth

directive, the module usually includes the contents of the file after a standard HTML preamble (

option disables this behaviour, causing the module to start the display with the header file contents. The header file must contain appropriate HTML instructions in this case. If there is no header file, the preamble is generated as usual. If you also specify a ReadmeName

, and if that file exists, The closing

yields proper HTML 3.2 output, which by the final specification prohibits img

elements from the pre

values for the listed directory in the HTTP header. It is only valid if the operating system and file system return appropriate stat() results. Some Unix systems do so, as do OS2's JFS and Win32's NTFS volumes. OS2 and Win32 FAT volumes, for example, do not. Once this feature is enabled, the client or proxy can track changes to the list of files when they perform a HEAD

request. Note some operating systems correctly track new and removed files, but do not track changes for sizes or dates of the files within the directory. Last-Modified

keyword causes files containing version numbers to sort in a natural way. Strings are sorted as usual, except that substrings of digits in the name and description are compared according to their numeric value. foo-1.7

If the number starts with a zero, then it is considered to be a fraction:

to emit XHTML 1.0 code instead of HTML 3.2.Be aware of how multiple IndexOptions

directives for a single directory are now merged together. The result of: IndexOptions HTMLTable IndexOptions SuppressColumnsorting

settings (which may have been inherited from an upper-level directory). However, whenever an unprefixed keyword is processed, it clears all inherited options and any incremental settings encountered so far. Consider the following example:

IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing

The net effect is equivalent to IndexOptions FancyIndexing +SuppressSize

discarded the incremental keywords before it, but allowed them to start accumulating again afterward.

for a particular directory, clearing the inherited settings, specify keywords without any +

, indicating the direction of the sort. The second argument must be one of the keywords Name

, and identifies the primary key. The secondary key is always the ascending filename.

You can, if desired, prevent the client from reordering the list by also adding the

index option to prevent them from manually adding sort options to the query string in order to override your ordering preferences.IgnoreClient

adds a number of CSS classes to the resulting HTML. The entire table is given a CSS id of indexlist

and the following classes are associated with the various parts of the listing:

| Class | Definition | |---|---| | tr.indexhead | Header row of listing | | th.indexcolicon and td.indexcolicon | Icon column | | th.indexcolname and td.indexcolname | File name column | | th.indexcollastmod and td.indexcollastmod | Last modified column | | th.indexcolsize and td.indexcolsize | File size column | | th.indexcoldesc and td.indexcoldesc | Description column | | tr.breakrow | Horizontal rule at the bottom of the table | | tr.odd and tr.even | Alternating even and odd rows |

, where this behavior is described in greater detail.HeaderName

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.4