autoindex_format
Директива 'autoindex_format' определяет формат списков каталогов, создаваемых модулем autoindex в NGINX.
Описание
autoindex_format указывает формат вывода списков каталогов, когда включена функция autoindex в NGINX. Эта директива позволяет пользователям изменить внешний вид сгенерированного HTML для лучшей читаемости или кастомизации. NGINX поддерживает несколько предопределённых форматов, таких как html и json, каждый из которых соответствует своему стилю представления. Когда директива задана в конфигурационном файле, NGINX использует указанный формат вывода вместо значений по умолчанию, что повышает удобство использования индексов каталогов для клиентов или приложений, которые могут полагаться на определённые структуры данных в ответе.
В практических сценариях autoindex_format можно использовать для предоставления удобного для пользователя представления содержимого каталогов в формате HTML, например с ссылками и размерами файлов, или в формате JSON для потребления API, который легко парсится программно. Формат должен задаваться в допустимых контекстах, а именно на уровнях http, server или location, что позволяет гибко управлять поведением в зависимости от области действия конфигурации NGINX. Эта директива в первую очередь предназначена для интеграции с различными клиентскими приложениями, которые обрабатывают списки каталогов по-разному в зависимости от ожидаемого формата.
Пример конфига
location /files {
autoindex on;
autoindex_format json;
}Убедитесь, что модуль autoindex включён с помощью 'autoindex on;' перед использованием этой директивы.
Указание неизвестного формата приводит к ошибке; используйте только поддерживаемые форматы.