Nginx Index模块详细说明

模块名称: ngx_http_index_module

功能: 该模块用于处理客户端请求目录时返回的默认文件（如index.html、index.htm等）。

配置指令:

  1. index: 定义默认文件列表。

    • 语法: index file ...;

    • 默认值: index index.html;

    • 上下文: http, server, location

  2. autoindex: 启用或禁用目录列表功能。

    • 语法: autoindex on | off;

    • 默认值: autoindex off;

    • 上下文: http, server, location

  3. autoindex_exact_size: 控制目录列表中的文件大小显示格式。

    • 语法: autoindex_exact_size on | off;

    • 默认值: autoindex_exact_size on;

    • 上下文: http, server, location

  4. autoindex_format: 设置目录列表的输出格式。

    • 语法: autoindex_format html | xml | json | jsonp;

    • 默认值: autoindex_format html;

    • 上下文: http, server, location

  5. autoindex_localtime: 控制目录列表中的文件时间显示格式。

    • 语法: autoindex_localtime on | off;

    • 默认值: autoindex_localtime off;

    • 上下文: http, server, location

案例

案例1: 配置默认首页文件

server {
    listen 80;
    server_name example.com;

    location / {
        index index.html index.htm index.php;
    }
}

解释: 当访问example.com时，Nginx会依次查找index.html、index.htm、index.php文件并返回第一个找到的文件。

案例2: 启用目录列表功能

server {
    listen 80;
    server_name example.com;

    location /files/ {
        autoindex on;
        autoindex_exact_size off;
        autoindex_localtime on;
    }
}

解释: 当访问example.com/files/时，Nginx会显示该目录下的文件列表，文件大小以易读格式显示，文件时间以本地时间显示。

案例3: 设置目录列表输出格式为JSON

server {
    listen 80;
    server_name example.com;

    location /files/ {
        autoindex on;
        autoindex_format json;
    }
}

解释: 当访问example.com/files/时，Nginx会以JSON格式返回目录列表。

总结

Nginx的index模块通过简单的配置即可实现默认首页文件的处理和目录列表的生成，适用于静态文件服务器或需要展示目录内容的场景。

本篇文章内容来源于：Nginxindex:首页处理模块详细说明以及案例