HTTP-модуль#
Базовый HTTP-модуль реализует основную функциональность HTTP-сервера: это определение серверных блоков, настройка локаций для маршрутизации запросов, передача статических файлов и контроль доступа, настройка перенаправлений, поддержка соединений keep-alive и управление заголовками запросов и ответов.
Остальные модули этого раздела расширяют эту функциональность, позволяя гибко настраивать и оптимизировать работу HTTP-сервера под различные сценарии и требования.
При сборке из исходного кода HTTP-сервер и его модули
собираются по умолчанию; их можно полностью отключить с помощью
параметра сборки --without-http.
В пакетах и образах из наших репозиториев HTTP-сервер включен в сборку.
Директивы#
absolute_redirect#
Если запрещено, то перенаправления, выдаваемые Angie, будут относительными.
См. также директивы server_name_in_redirect и port_in_redirect.
aio#
Разрешает или запрещает использование файлового асинхронного ввода-вывода (AIO) во FreeBSD и Linux:
location /video/ {
aio on;
output_buffers 1 64k;
}
Во FreeBSD AIO можно использовать, начиная с FreeBSD 4.3. До FreeBSD 11.0 AIO можно либо собрать в ядре статически:
options VFS_AIO
либо загрузить динамически через загружаемый модуль ядра:
kldload aio
В Linux AIO можно использовать только начиная с версии ядра 2.6.22. Кроме того, необходимо также дополнительно включить directio, иначе чтение будет блокирующимся:
location /video/ {
aio on;
directio 512;
output_buffers 1 128k;
}
В Linux directio можно использовать только для чтения блоков, выравненных на границу 512 байт (или 4К для XFS). Невыравненный конец файла будет читаться блокированно. То же относится к запросам с указанием диапазона запрашиваемых байт (byte-range requests) и к запросам FLV не с начала файла: чтение невыравненных начала и конца ответа будет блокирующимся.
При одновременном включении AIO и sendfile в Linux для файлов, размер которых больше либо равен указанному в директиве directio, будет использоваться AIO, а для файлов меньшего размера или при выключенном directio — sendfile:
location /video/ {
sendfile on;
aio on;
directio 8m;
}
Кроме того, читать и отправлять файлы можно в многопоточном режиме, не блокируя при этом рабочий процесс:
location /video/ {
sendfile on;
aio threads;
}
Операции чтения или отправки файлов будут обрабатываться потоками из указанного пула. Если пул потоков не задан явно, используется пул с именем default. Имя пула может быть задано при помощи переменных:
aio threads=pool$disk;
Использование aio on требует сборки с конфигурационным параметром
--with-file-aio. Для использования aio threads требуется сборка
с параметром --with-threads.
В настоящий момент многопоточность совместима только с методами epoll, kqueue и eventport. Отправка файлов в многопоточном режиме поддерживается только на Linux.
См. также директиву sendfile.
aio_write#
При включенном aio разрешает его использование для записи файлов. В настоящий момент это работает только при использовании aio threads и ограничено записью временных файлов с данными, полученными от проксируемых серверов.
alias#
Задает замену для указанного location'а. Например, при такой конфигурации:
location /i/ {
alias /data/w3/images/;
}
на запрос /i/top.gif будет отдан файл /data/w3/images/top.gif.
В значении параметра путь можно использовать переменные, кроме $document_root и $realpath_root.
Если alias используется внутри location'а, заданного регулярным выражением, то регулярное выражение должно содержать группы захвата, а сам alias — ссылки на эти группы, например:
location ~ ^/users/(.+\.(?:gif|jpe?g|png))$ {
alias /data/w3/images/$1;
}
Если location и последняя часть значения директивы совпадают:
location /images/ {
alias /data/w3/images/;
}
то лучше воспользоваться директивой root:
location /images/ {
root /data/w3;
}
Предупреждение
При использовании alias совпавший префикс локации удаляется из URI по
его длине, причем сам префикс повторно не проверяется. Завершающие косые черты
у имени локации и у значения alias должны быть согласованы. Если в значении alias нет завершающей косой
черты, которая есть у локации, остаток дописывается вплотную (например,
/data/w3/imagestop.gif) и отдается не тот файл; в обратном случае
лишь удваивается косая черта, что обычно безвредно. Для
локации, совпадающей с последней частью пути, предпочтительнее директива
root, которая добавляет URI целиком и не подвержена этой проблеме.
auth_delay#
Задерживает обработку неавторизованных запросов с кодом ответа 401 для предотвращения атак по времени в случае ограничения доступа по паролю или по результату подзапроса.
auto_redirect#
| |
По умолчанию |
|
http, server, location |
Контролирует поведение перенаправления,
когда префикс location заканчивается косой чертой:
location /prefix/ {
auto_redirect on;
}
Здесь запрос к /prefix будет перенаправлен на /prefix/.
Значение on включает перенаправление в явном виде;
off отключает его.
Если указано default, перенаправление включается,
только если location обрабатывает запросы через api,
proxy_pass, fastcgi_pass, uwsgi_pass, scgi_pass,
memcached_pass, или grpc_pass.
chunked_transfer_encoding#
| |
По умолчанию |
|
http, server, location |
Позволяет запретить формат передачи данных частями (chunked transfer encoding) в HTTP/1.1. Это может понадобиться при использовании программ, не поддерживающих chunked encoding, несмотря на требования стандарта.
client#
Добавлено в версии 1.10.0.
Изменено в версии 1.10.1.
Создает специальный контекст client
для обработки внутренних HTTP-запросов,
которые Angie выполняет самостоятельно без участия внешних клиентов.
Контекст client изолирует служебный трафик
различных модулей Angie от пользовательского трафика,
позволяя дополнительно управлять им.
Внутри этого контекста можно определять только именованные location
(с префиксом @);
они недоступны для внешних HTTP-запросов
и могут вызываться только программно через внутренние механизмы сервера.
Контекст client используется для:
отправки запросов к центру сертификации в модуле ACME через предопределенный
location @acme, который можно дополнительно настроить с помощью директив модуля Proxy;запросов к Docker API в модуле Docker через предопределенные
location @docker_eventsи@docker_containers, которые можно дополнительно настроить с помощью директив модуля Proxy;проверки состояния проксируемых серверов через upstream_probe (PRO);
режима sticky learn с
remote_actionв потоковом модуле Upstream.
Поддержка нескольких блоков client
позволяет группировать общие настройки для нескольких блоков location
внутри каждого блока,
что помогает избежать дублирования конфигурации.
При этом директивы, указанные в каждом блоке client,
наследуются только явно объявленными внутри него блоками location.
В частности, поэтому они не влияют на конфигурацию других модулей,
которые неявно используют блок client для исходящих запросов
(например, ACME или Docker).
Пример использования нескольких блоков client
с наследованием настроек:
client {
proxy_set_header Host docker.example.com;
proxy_set_header Authorization "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==";
location @docker_events {
}
location @docker_containers {
}
}
client {
proxy_method GET;
proxy_set_header Host backend.example.com;
proxy_set_header X-Real-IP $remote_addr;
location @health_check {
proxy_pass http://upstream-server/health;
}
}
Примечание
Здесь допускаются те же директивы,
что и в обычных location,
однако реально работают только обработчики контента
(например, js_content или autoindex)
и переменных (например, map),
а также директивы, которые сами порождают запросы,
например upstream_probe.
Директивы, работающие на других стадиях обработки запроса (например, limit_req, auth_request, try_files, фильтры изображений, XSLT и т. д.), здесь не работают.
client_body_buffer_size#
| |
По умолчанию |
|
http, server, location |
Задает размер буфера для чтения тела запроса клиента. Если тело запроса больше заданного буфера, то все тело запроса или только его часть записывается во временный файл. По умолчанию размер одного буфера равен двум размерам страницы. На x86, других 32-битных платформах и x86-64 это 8K. На других 64-битных платформах это обычно 16K.
client_body_in_file_only#
| |
По умолчанию |
|
http, server, location |
Определяет, сохранять ли все тело запроса клиента в файл. Директиву можно использовать для отладки и при использовании переменной $request_body_file или метода $r->request_body_file модуля Perl.
| временные файлы по окончании обработки запроса не удаляются |
| разрешает удалять временные файлы, оставшиеся по окончании обработки запроса |
client_body_in_single_buffer#
| |
По умолчанию |
|
http, server, location |
Определяет, сохранять ли все тело запроса клиента в одном буфере. Директива рекомендуется при использовании переменной $request_body для уменьшения требуемого числа операций копирования.
client_body_temp_path#
| |
По умолчанию |
|
http, server, location |
Задает каталог для хранения временных файлов с телами запросов клиентов. В каталоге может использоваться иерархия подкаталогов до трех уровней. Например, при такой конфигурации
client_body_temp_path /spool/angie/client_temp 1 2;
путь к временному файлу будет следующего вида:
/spool/angie/client_temp/7/45/00000123457
client_body_timeout#
| |
По умолчанию |
|
http, server, location |
Задает таймаут при чтении тела запроса клиента. Таймаут устанавливается не на всю передачу тела запроса, а только между двумя последовательными операциями чтения. Если по истечении этого времени клиент ничего не передаст, обработка запроса прекращается с ошибкой 408 (Request Time-out).
client_header_buffer_size#
| |
По умолчанию |
|
http, server |
Задает размер буфера для чтения заголовка запроса клиента. Для большинства запросов достаточно буфера размером в 1K байт. Однако если в запросе есть длинные cookies, или же запрос пришел от WAP-клиента, то он может не поместиться в 1K. Поэтому, если строка запроса или поле заголовка запроса не помещаются полностью в этот буфер, то выделяются буферы большего размера, задаваемые директивой large_client_header_buffers.
Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию. Подробнее см. в разделе Выбор виртуального сервера.
client_header_timeout#
Задает таймаут при чтении заголовка запроса клиента. Если по истечении этого времени клиент не передаст полностью заголовок, обработка запроса прекращается с ошибкой 408 (Request Time-out).
client_max_body_size#
| |
По умолчанию |
|
http, server, location |
Задает максимально допустимый размер тела запроса клиента. Если размер больше заданного, то клиенту возвращается ошибка 413 (Request Entity Too Large). Следует иметь в виду, что браузеры не умеют корректно показывать эту ошибку.
| отключает проверку размера тела запроса клиента |
connection_pool_size#
| |
По умолчанию |
|
http, server, location |
Позволяет производить точную настройку выделения памяти под конкретные соединения. Эта директива не оказывает существенного влияния на производительность, и ее не следует использовать. По умолчанию:
| на 32-битных платформах |
| на 64-битных платформах |
default_type#
Задает MIME-тип ответов по умолчанию. Соответствие расширений имен файлов MIME-типу ответов задается с помощью директивы types.
directio#
Разрешает использовать флаги O_DIRECT (FreeBSD, Linux), F_NOCACHE (macOS) или функцию directio() (Solaris) при чтении файлов, размер которых больше либо равен указанному. Директива автоматически запрещает использование sendfile для данного запроса. Рекомендуется использовать для больших файлов:
directio 4m;
или при использовании aio в Linux.
directio_alignment#
| |
По умолчанию |
|
http, server, location |
Устанавливает выравнивание для directio. В большинстве случаев достаточно 512-байтового выравнивания, однако при использовании XFS под Linux его нужно увеличить до 4K.
disable_symlinks#
| |
По умолчанию |
|
http, server, location |
Определяет, как следует поступать с символическими ссылками при открытии файлов:
| Символические ссылки в пути допускаются и не проверяются. Это стандартное поведение. |
| Если любой компонент пути является символической ссылкой, доступ к файлу запрещается. |
| Доступ к файлу запрещается, если любой компонент пути является символической ссылкой, а ссылка и объект, на который она ссылается, имеют разных владельцев. |
| При проверке символических ссылок (параметры |
Пример:
disable_symlinks on from=$document_root;
Эта директива доступна только на системах, в которых есть интерфейсы openat() и fstatat(). К таким системам относятся современные версии FreeBSD, Linux и Solaris.
Предупреждение
Параметры on и if_not_owner требуют дополнительных затрат на обработку.
На системах, не поддерживающих операцию открытия каталогов только для поиска, для использования этих параметров требуется, чтобы рабочие процессы имели право читать все проверяемые каталоги.
Примечание
Модули AutoIndex, Random Index и DAV в настоящий момент игнорируют эту директиву.
early_hints#
Задает условия, при которых ответ с кодом "103 Early Hints" будет передан клиенту. Такой ответ может быть возвращен проксируемыми и gRPC-бэкендами. Если значение хотя бы одного из строковых параметров непустое и не равно 0, то ответ будет передан:
map $http_sec_fetch_mode $early_hints {
navigate $http2$http3;
}
server {
...
location / {
early_hints $early_hints;
proxy_pass http://example.com;
}
}
В значении параметров можно использовать переменные.
error_log_user_tag#
Добавлено в версии 1.12.0.
Добавляет тег, зависящий от запроса, в записи error_log. Значение может
содержать переменные. Директива может задаваться
несколько раз для добавления нескольких тегов. Теги используются в фильтрах
filter=tag: директивы error_log.
error_page#
| |
По умолчанию | — |
http, server, location, if в location |
Задает URI, который будет показываться для указанных ошибок. В значении uri можно использовать переменные.
Пример:
error_page 404 /404.html;
error_page 500 502 503 504 /50x.html;
При этом делается внутреннее перенаправление на указанный uri, а метод запроса клиента меняется на "GET" (для всех методов, отличных от "GET" и "HEAD").
Кроме того, можно поменять код ответа на другой, используя синтаксис вида =ответ, например:
error_page 404 =200 /empty.gif;
Если ошибочный ответ обрабатывается проксированным сервером или FastCGI/uwsgi/SCGI/gRPC-сервером, и этот сервер может вернуть разные коды ответов, например, 200, 302, 401 или 404, то можно выдавать возвращаемый им код:
error_page 404 = /404.php;
Если при внутреннем перенаправлении не нужно менять URI и метод, то можно передать обработку ошибки в именованный location:
location / {
error_page 404 = @fallback;
}
location @fallback {
proxy_pass http://backend;
}
Примечание
Если при обработке uri происходит ошибка, клиенту возвращается ответ с кодом последней случившейся ошибки.
Также существует возможность использовать перенаправления URL для обработки ошибок:
error_page 403 http://example.com/forbidden.html;
error_page 404 =301 http://example.com/notfound.html;
В этом случае по умолчанию клиенту возвращается код ответа 302. Его можно изменить только на один из кодов ответа, относящихся к перенаправлениям (301, 302, 303, 307 и 308).
etag#
Разрешает или запрещает автоматическую генерацию поля ETag заголовка ответа для статических ресурсов.
http#
Предоставляет контекст конфигурационного файла, в котором указываются директивы HTTP-сервера.
if_modified_since#
| |
По умолчанию |
|
http, server, location |
Определяет, как сравнивать время модификации ответа с временем в поле If-Modified-Since заголовка запроса:
| ответ всегда считается изменившимся |
| точное совпадение |
| время модификации ответа меньше или равно времени, заданному в поле |
ignore_invalid_headers#
Если включено, Angie игнорирует поля заголовка с недопустимыми именами. Допустимыми считаются имена, состоящие из английских букв, цифр, дефисов и возможно знаков подчеркивания (последнее контролируется директивой underscores_in_headers).
Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию.
internal#
Указывает, что location может использоваться только для внутренних
запросов. Для внешних запросов будет возвращаться ошибка 404 (Not Found) в
контексте данного location, что позволяет перенаправить такие запросы с
помощью error_page. Внутренними запросами являются:
запросы, перенаправленные директивами error_page, index, random_index и try_files;
запросы, перенаправленные с помощью поля
X-Accel-Redirectзаголовка ответа вышестоящего сервера;подзапросы, формируемые командой
include virtualмодуля SSI, директивами модуля Addition, а также директивами auth_request и mirror;запросы, измененные директивой rewrite;
запросы, перенаправленные директивой goto.
Пример:
error_page 404 /404.html;
location = /404.html {
internal;
}
Благодаря тому, что ошибка 404 возвращается в контексте location с
директивой internal, можно перенаправлять внешние запросы в другое
место. Это позволяет использовать один префикс как для внешнего, так и для
внутреннего запроса, но с разной обработкой, например:
location /path {
internal;
error_page 404 =@external;
proxy_pass https://internal;
}
location @external {
proxy_pass https://external;
}
Здесь внешний запрос GET /path будет проксирован на
https://external/path, а такой же внутренний запрос будет проксирован на
https://internal/path.
Примечание
Для предотвращения зацикливания, которое может возникнуть при использовании
некорректных конфигураций, количество внутренних перенаправлений ограничено
десятью. По достижении этого ограничения будет возвращена ошибка 500
(Internal Server Error). В таком случае в лог-файле ошибок можно увидеть
сообщение rewrite or internal redirection cycle.
keepalive_disable#
| |
По умолчанию |
|
http, server, location |
Запрещает соединения keep-alive с некорректно ведущими себя браузерами. Параметры браузер указывают, на какие браузеры это распространяется.
| разрешает соединения keep-alive со всеми браузерами |
| запрещает соединения keep-alive со старыми версиями MSIE после получения запроса POST |
| запрещает соединения keep-alive с Safari и подобными им браузерами на macOS и подобных ей ОС |
keepalive_requests#
| |
По умолчанию |
|
http, server, location |
Задает максимальное число запросов, которые можно сделать по одному keep-alive соединению. После того, как сделано максимальное число запросов, соединение закрывается.
Периодическое закрытие соединений необходимо для освобождения памяти, выделенной под конкретные соединения. Поэтому использование слишком большого максимального числа запросов может приводить к чрезмерному потреблению памяти и не рекомендуется.
keepalive_time#
Ограничивает максимальное время, в течение которого могут обрабатываться запросы в рамках соединения keep-alive. По достижении заданного времени соединение закрывается после обработки очередного запроса.
keepalive_timeout#
| |
По умолчанию |
|
http, server, location |
таймаут | задает время, в течение которого keep-alive соединение с клиентом не будет закрыто со стороны сервера |
| запрещает keep-alive соединения с клиентами |
Второй, необязательный, параметр задает значение в поле Keep‑Alive: timeout=время заголовка ответа. Два параметра могут отличаться друг от друга.
Поле Keep-Alive: timeout=время заголовка понимают Mozilla и Konqueror. MSIE сам закрывает keep-alive соединение примерно через 60 секунд.
large_client_header_buffers#
| |
По умолчанию |
|
http, server |
Задает максимальное число и размер буферов для чтения большого заголовка запроса клиента. Строка запроса не должна превышать размера одного буфера, иначе клиенту возвращается ошибка 414 (Request-URI Too Large). Поле заголовка запроса также не должно превышать размера одного буфера, иначе клиенту возвращается ошибка 400 (Bad Request). Буферы выделяются только по мере необходимости. По умолчанию размер одного буфера равен 8K байт. Если по окончании обработки запроса соединение переходит в состояние keep-alive, эти буферы освобождаются.
Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию.
limit_except#
Ограничивает HTTP-методы, доступные внутри location. Параметр метод может быть
одним из GET, HEAD, POST, PUT, DELETE,
MKCOL, COPY, MOVE, OPTIONS, PROPFIND,
PROPPATCH, LOCK, UNLOCK или PATCH. Если разрешен
метод GET, то метод HEAD также будет разрешен. Доступ к
остальным методам может быть ограничен при помощи директив модулей Access и Auth Basic.
limit_except GET {
allow 192.168.1.0/32;
deny all;
}
Примечание
Ограничение в примере действует для всех методов,
кроме GET и HEAD.
limit_rate#
Ограничивает скорость передачи ответа клиенту. Скорость задается в байтах в секунду. Значение 0 отключает ограничение скорости. Ограничение устанавливается на запрос, поэтому, если клиент одновременно откроет два соединения, суммарная скорость будет вдвое выше заданного ограничения.
В значении параметра можно использовать переменные. Это может быть полезно в случаях, когда скорость нужно ограничивать в зависимости от какого-либо условия:
map $slow $rate {
1 4k;
2 8k;
}
limit_rate $rate;
Ограничение скорости можно также задать в переменной $limit_rate, однако использовать данный метод не рекомендуется:
server {
if ($slow) {
set $limit_rate 4k;
}
}
Кроме того, ограничение скорости может быть задано в поле X-Accel-Limit-Rate заголовка ответа проксированного сервера. Эту возможность можно запретить с помощью директив proxy_ignore_headers, fastcgi_ignore_headers, uwsgi_ignore_headers и scgi_ignore_headers.
limit_rate_after#
| |
По умолчанию |
|
http, server, location, if в location |
Задает начальный объем данных, после передачи которого начинает ограничиваться скорость передачи ответа клиенту. В значении параметра можно использовать переменные.
Пример:
location /flv/ {
flv;
limit_rate_after 500k;
limit_rate 50k;
}
lingering_close#
| |
По умолчанию |
|
http, server, location |
Управляет закрытием соединений с клиентами.
| Angie будет ждать и обрабатывать дополнительные данные, поступающие от клиента, перед полным закрытием соединения, но только если эвристика указывает на то, что клиент может еще послать данные. |
| Angie всегда будет ждать и обрабатывать дополнительные данные, поступающие от клиента. |
| Angie не будет ждать поступления дополнительных данных и сразу же закроет соединение. Это поведение нарушает протокол и поэтому не должно использоваться без необходимости. |
Для управления закрытием HTTP/2-соединений директива должна быть задана на уровне server.
lingering_time#
Если действует lingering_close, эта директива задает максимальное время, в течение которого Angie будет обрабатывать (читать и игнорировать) дополнительные данные, поступающие от клиента. По прошествии этого времени соединение будет закрыто, даже если будут еще данные.
lingering_timeout#
Если действует lingering_close, эта директива задает максимальное время ожидания поступления дополнительных данных от клиента. Если в течение этого времени данные не были получены, соединение закрывается. В противном случае данные читаются и игнорируются, и Angie снова ждет поступления данных. Цикл "ждать-читать-игнорировать" повторяется, но не дольше чем задано директивой lingering_time.
При постепенном завершении клиентские постоянные соединения закрываются только в
случае, если они неактивны не менее времени, заданного в
lingering_timeout.
Примечание
В nginx аналогичная директива называется keepalive_min_timeout.
listen#
Изменено в версии 1.10.0.
| |
По умолчанию |
|
server |
Задает адрес и порт для прослушивающего сокета или путь к UNIX-доменному сокету, на котором сервер будет принимать запросы. Адрес также может быть именем хоста, например:
listen 127.0.0.1:8000;
listen 127.0.0.1;
listen 8000;
listen *:8000;
listen localhost:8000;
IPv6-адреса указываются в квадратных скобках:
listen [::]:8000;
listen [::1];
Диапазоны портов задаются при помощи указания первого и последнего порта через дефис:
listen 127.0.0.1:8000-8009;
listen 8000-8009;
UNIX-доменные сокеты задаются с префиксом unix::
listen unix:/var/run/angie.sock;
Можно указать адрес и порт вместе, только адрес или только порт. Если какие-либо параметры опущены, применяются следующие правила:
Если указан только адрес, используется порт 80.
Если указан только порт, Angie будет слушать на всех доступных интерфейсах IPv4 (и IPv6, если включен). Стоящий первым блок
serverна этом порту будет сервером по умолчанию для запросов с несопоставленным заголовкомHost.Если директива не указана вовсе, Angie использует
*:80, если запущен с правами суперпользователя, или*:8000в противном случае.
| сервер, в котором указан этот параметр, будет сервером по умолчанию для указанной пары адрес:порт (вместе они образуют cлушающий сокет). Если же директив с параметром |
| указывает на то, что все соединения, принимаемые на данном слушающем сокете, должны работать в режиме SSL. Это позволяет задать компактную конфигурацию для сервера, работающего сразу в двух режимах — HTTP и HTTPS. |
| позволяет принимать на слушающем сокете HTTP/2-соединения. Обычно, чтобы это работало, следует также указать параметр Устарело, начиная с версии 1.2.0: Используйте взамен директиву http2. |
| позволяет принимать на этом порту QUIC-соединения.
Для использования этой опции в Angie
должен быть включен и настроен модуль HTTP3.
Когда |
| указывает на то, что все соединения, принимаемые на данном слушающем сокете, должны использовать протокол PROXY. |
В директиве listen можно также указать несколько дополнительных
параметров, специфичных для связанных с сокетами системных вызовов. Следующие
параметры можно задать в любой директиве listen, но только один раз для
каждого слушающего сокета:
| задает таблицу маршрутизации, FIB (параметр |
| включает "TCP Fast Open" для слушающего сокета и ограничивает максимальную длину очереди соединений, которые еще не завершили процесс трехстороннего рукопожатия. Предупреждение Не включайте "TCP Fast Open", не убедившись, что сервер может адекватно обрабатывать многократное получение одного и того же SYN-пакета с данными. |
| задает параметр |
| задает размер буфера приема (параметр |
| задает размер буфера передачи (параметр |
| задает название accept-фильтра (параметр |
| указывает использовать отложенный |
| указывает, что для данного слушающего сокета нужно делать |
| определяет (через параметр сокета По умолчанию параметр включен. Установить его можно только один раз на старте. |
| указывает, что нужно создавать отдельный слушающий сокет для каждого рабочего процесса (через параметр сокета Предупреждение Ненадлежащее использование параметра |
| включает прием соединений по протоколу Multipath TCP (MPTCP),
поддерживаемому в ядре Linux с версии 5.6.
Параметр несовместим с |
so_keepalive=on | off | [keepidle]:[keepintvl]:[keepcnt]
Конфигурирует для слушающего сокета поведение "TCP keepalive".
| если параметр опущен, для сокета будут действовать настройки операционной системы |
| для сокета включается параметр |
| для сокета параметр |
Некоторые операционные системы поддерживают настройку параметров "TCP keepalive" на уровне сокета посредством параметров TCP_KEEPIDLE, TCP_KEEPINTVL и TCP_KEEPCNT. На таких системах (в настоящее время это Linux, NetBSD, Dragonfly, FreeBSD и macOS) их можно сконфигурировать с помощью параметров keepidle, keepintvl и keepcnt. Один или два параметра могут быть опущены, в таком случае для соответствующего параметра сокета будут действовать стандартные системные настройки. Например,
so_keepalive=30m::10
установит таймаут бездействия (TCP_KEEPIDLE) в 30 минут, для интервала проб (TCP_KEEPINTVL) будет действовать стандартная системная настройка, а счетчик проб (TCP_KEEPCNT) будет равен 10.
Пример:
listen 127.0.0.1 default_server accept_filter=dataready backlog=1024;
location#
Устанавливает конфигурацию в зависимости от того, соответствует ли URI запроса какому-либо из выражений сопоставления.
Для сопоставления используется URI запроса в нормализованном виде (значение
$uri), после
декодирования текста, заданного в виде %XX, преобразования относительных
элементов пути "." и ".." в реальные и возможной замены
двух и более подряд идущих косых черт на одну.
Задать location можно префиксной строкой или регулярным выражением.
Регулярные выражения задаются с модификатором:
| Для поиска совпадения без учета регистра символов |
| С учетом регистра |
Чтобы найти location, соответствующий запросу, вначале проверяются
location'ы, заданные префиксными строками (префиксные location'ы). Среди
них ищется location с совпадающим префиксом максимальной длины и
запоминается.
Примечание
Для операционных систем, нечувствительных к регистру символов, таких как
macOS, сравнение с префиксными строками производится без учета регистра.
Однако сравнение ограничено только однобайтными locale'ями.
Затем проверяются регулярные выражения в порядке их следования в
конфигурационном файле. Проверка регулярных выражений прекращается после
первого же совпадения, и используется соответствующая конфигурация. Если
совпадение с регулярным выражением не найдено, то используется конфигурация
запомненного ранее префиксного location'а.
За некоторыми исключениями, о которых говорится ниже,
блоки location могут быть вложенными.
Регулярные выражения могут создавать группы захвата, которые затем можно использовать в других директивах.
Если у совпавшего префиксного location'а указан модификатор ^~,
то регулярные выражения не проверяются.
Кроме того, с помощью модификатора = можно задать точное совпадение URI и
location. При точном совпадении поиск сразу же прекращается. Например, если
запрос / случается часто, можно ускорить обработку таких запросов, указав
location =/, так как поиск прекратится после первого же сравнения. Такой
location не может иметь вложенные location, так как он задает полное
совпадение.
После того как подходящий location выбран, запрос сопоставляется с файлом
с помощью директивы root или alias, а try_files может
проверять наличие файлов внутри него; общее описание см. в Выбор локаций.
Пример:
location =/ {
#конфигурация А
}
location / {
#конфигурация Б
}
location /documents/ {
#конфигурация В
}
location ^~/images/ {
#конфигурация Г
}
location ~*\.(gif|jpg|jpeg)$ {
#конфигурация Д
}
Для запроса
/будет выбрана конфигурация А,для запроса
/index.html— конфигурация Б,для запроса
/documents/document.html— конфигурация В,для запроса
/images/1.gif— конфигурация Г,а для запроса
/documents/1.jpg— конфигурация Д.
Примечание
Если префиксный location задан с косой чертой в конце
и включена директива auto_redirect, происходит следующее:
На запрос с URI без косой черты в конце, в остальном совпадающий с префиксом,
будет возвращено постоянное перенаправление с кодом 301, указывающее
на URI запроса с добавленной в конце косой чертой.
Если задать location с точным совпадением URI,
перенаправление не используется:
location /user/ {
proxy_pass http://user.example.com;
}
location =/user {
proxy_pass http://login.example.com;
}
Префикс @ задает именованный location. Такой location не используется
при обычной обработке запросов, а предназначен только для перенаправления в
него запросов. Такие location не могут быть вложенными и не могут содержать
вложенные location.
Комбинированные location#
Для удобства несколько location с одинаковой конфигурацией можно записать
компактно, перечислив в одном location сразу несколько выражений
сопоставления и задав для них единую конфигурацию. Такие location называются
комбинированными.
Если, например, предположить, что в предыдущем примере конфигурации А, Г и Д
совпадают, то их можно записать с помощью комбинированного location:
location =/
^~/images/
~*\.(gif|jpg|jpeg)$ {
#общая конфигурация
}
Именованный location также может быть частью комбинированного:
location =/
@named_combined {
#...
}
Предупреждение
В комбинированных location между модификатором выражения сопоставления и
самим выражением не может стоять пробел. Правильно: location
~*/match(ing|es|er)$ ....
Примечание
Сейчас комбинированные location не могут непосредственно содержать
директивы proxy_pass, в которых задан URI, а также api и alias.
При этом такие директивы можно использовать в других location,
вложенных в комбинированный.
log_not_found#
Разрешает или запрещает записывать в error_log ошибки о том, что файл не найден.
log_subrequest#
Разрешает или запрещает записывать в access_log подзапросы.
max_headers#
Устанавливает максимальное количество полей заголовков запроса клиента.
При превышении предела клиенту возвращается ошибка 400 (Bad Request).
Если эта директива задана на уровне server, может использоваться значение с сервера по умолчанию. Дополнительные сведения см. в разделе Выбор виртуального сервера.
max_ranges#
Ограничивает максимальное допустимое число диапазонов в запросах с указанием диапазона запрашиваемых байт (byte-range requests). Запросы, превышающие указанное ограничение, обрабатываются как если бы они не содержали указания диапазонов. По умолчанию число диапазонов не ограничено.
| полностью запрещает поддержку диапазонов |
merge_slashes#
Разрешает или запрещает преобразование URI путем замены двух и более подряд идущих косых черт ("/") на одну.
Необходимо иметь в виду, что это преобразование необходимо для корректной проверки префиксных строк и регулярных выражений. Если его не делать, то запрос //scripts/one.php не попадет в
location /scripts/ { }
и может быть обслужен как статический файл. Поэтому он преобразуется к виду /scripts/one.php.
Запрет преобразования может понадобиться, если в URI используются имена, закодированные методом base64, в котором задействован символ "/". Однако из соображений безопасности лучше избегать отключения преобразования.
Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию.
msie_padding#
Разрешает или запрещает добавлять в ответы для MSIE со статусом больше 400 комментарий для увеличения размера ответа до 512 байт.
msie_refresh#
Разрешает или запрещает выдавать для MSIE клиентов refresh'ы вместо перенаправлений.
open_file_cache#
| |
По умолчанию |
|
http, server, location |
Задает кэш, в котором могут храниться:
дескрипторы открытых файлов, информация об их размерах и времени модификации;
информация о существовании каталогов;
информация об ошибках поиска файла — "нет файла", "нет прав на чтение" и тому подобное.
Кэширование ошибок нужно разрешить отдельно директивой open_file_cache_errors.
| задает максимальное число элементов в кэше; при переполнении кэша удаляются наименее востребованные элементы (LRU) |
| задает время, после которого элемент кэша удаляется, если к нему не было обращений в течение этого времени. По умолчанию: 60 секунд. |
| запрещает кэш. |
Пример:
open_file_cache max=1000 inactive=20s;
open_file_cache_valid 30s;
open_file_cache_min_uses 2;
open_file_cache_errors on;
open_file_cache_errors#
| |
По умолчанию |
|
http, server, location |
Разрешает или запрещает кэширование ошибок поиска файлов в open_file_cache.
open_file_cache_events#
| |
По умолчанию |
|
http, server, location |
Разрешает использование событий ядра для проверки актуальности элементов open_file_cache. Директива работает только с методом kqueue. Обратите внимание, что только NetBSD 2.0+ и FreeBSD 6.0+ поддерживают события для произвольных типов файловых систем; остальные операционные системы поддерживают события только для основных файловых систем, таких как UFS или FFS.
open_file_cache_min_uses#
| |
По умолчанию |
|
http, server, location |
Задает минимальное число обращений к файлу в течение времени, заданного параметром inactive директивы open_file_cache, необходимых для того, чтобы дескриптор файла оставался открытым в кэше.
open_file_cache_valid#
| |
По умолчанию |
|
http, server, location |
Определяет время, через которое следует проверять актуальность информации об элементе в open_file_cache.
output_buffers#
| |
По умолчанию |
|
http, server, location |
Задает число и размер буферов, используемых при чтении ответа с диска.
port_in_redirect#
Разрешает или запрещает указывать порт в абсолютных перенаправлениях, выдаваемых Angie.
Использование в перенаправлениях основного имени сервера управляется директивой server_name_in_redirect.
postpone_output#
Если это возможно, то отправка данных клиенту будет отложена пока Angie не накопит по крайней мере указанное количество байт для отправки.
| запрещает отложенную отправку данных |
read_ahead#
Задает ядру размер предчтения при работе с файлами.
На Linux используется системный вызов posix_fadvise(0, 0, 0, POSIX_FADV_SEQUENTIAL), поэтому параметр размер там игнорируется.
На FreeBSD используется системный вызов fcntl(O_READAHEAD, размер ), появившийся во FreeBSD 9.0-CURRENT.
recursive_error_pages#
| |
По умолчанию |
|
http, server, location |
Разрешает или запрещает делать несколько перенаправлений через директиву error_page. Число таких перенаправлений ограничено.
request_pool_size#
Позволяет производить точную настройку выделения памяти под конкретные запросы. Эта директива не оказывает существенного влияния на производительность, и ее не следует использовать.
reset_timedout_connection#
| |
По умолчанию |
|
http, server, location |
Разрешает или запрещает сброс соединений по таймауту, а также при закрытии соединений с помощью нестандартного кода 444. Сброс делается следующим образом. Перед закрытием сокета для него задается параметр SO_LINGER с таймаутом 0. После этого при закрытии сокета клиенту отсылается TCP RST, а вся память, связанная с этим сокетом, освобождается. Это позволяет избежать длительного нахождения уже закрытого сокета в состоянии FIN_WAIT1 с заполненными буферами.
Примечание
соединения keep-alive по истечении таймаута закрываются обычным образом.
resolver#
Изменено в версии 1.12.0.
| |
По умолчанию |
|
http, server, location, upstream |
Задает серверы DNS, используемые для преобразования имен вышестоящих серверов в адреса, например:
resolver 127.0.0.53 [::1]:5353;
Адрес может быть указан в виде доменного имени или IP-адреса, и необязательного порта. Если порт не указан, используется порт 53. Серверы DNS опрашиваются циклически.
Необходимо указать хотя бы один адрес DNS-сервера или параметр conf,
кроме формы resolver off;.
Примечание
Рекомендуется использовать локальный доверенный резолвер, например
127.0.0.53 (systemd-resolved), а не публичный (например, 8.8.8.8).
Публичные резолверы раскрывают DNS-запросы третьим сторонам и повышают
риск атак с подменой кэша.
Примечание
Значение директивы наследуется вложенными блоками и может быть переопределено в них при необходимости. В пределах одного блока директиву допустимо указывать только один раз; повторное указание является ошибкой конфигурации.
Директива включает разрешение DNS-имен для вышестоящих серверов, задаваемых через переменные или настроенных с параметром resolve, а также для работы ACME-клиента и прикрепления OCSP-ответов.
Помимо явно заданных адресов серверов директива распознает:
| явно отключает разрешение DNS-имен |
| считывает адреса DNS-серверов из указанного файла или из
|
Файл может содержать строки nameserver в том же формате, что
использует системный резолвер:
nameserver 127.0.1.4
nameserver 127.0.1.5
Адреса, считанные из файла, добавляются к адресам, заданным явно в
директиве, и все они затем опрашиваются совместно циклическим образом. Если
файл отсутствует, недоступен для чтения или не содержит адресов, а явно ни
один сервер не задан, используется сервер по умолчанию 127.0.0.1:53.
Angie перечитывает файл автоматически при его изменении, обновляя набор активных серверов.
По умолчанию Angie кэширует каждый ответ на время, заданное значением TTL в
DNS-ответе. Необязательный параметр valid позволяет это
переопределить:
| необязательный параметр, позволяет переопределить срок кэширования ответа |
resolver 127.0.0.53 [::1]:5353 valid=30s;
По умолчанию Angie будет искать как IPv4-, так и IPv6-адреса при преобразовании имен в адреса.
| запрещает поиск IPv4-адресов |
| запрещает поиск IPv6-адресов |
| необязательный параметр; включает сбор метрик запросов и ответов DNS-сервера в указанной зоне, отображая их в /status/resolvers/<зона>, вкладке «DNS Resolvers» и в выводе Prometheus. Без него эти метрики не собираются, и предупреждение не выводится |
Совет
Для предотвращения DNS-спуфинга рекомендуется использовать DNS-серверы в защищенной доверенной локальной сети.
Совет
При запуске в Docker используйте соответствующий внутренний адрес DNS-сервера, например 127.0.0.11.
resolver_timeout#
| |
По умолчанию |
|
http, server, location, upstream |
Задает таймаут для преобразования имени в адрес, например:
resolver_timeout 5s;
root#
Задает корневой каталог для запросов. Например, при такой конфигурации
location /i/ {
root /data/w3;
}
в ответ на запрос /i/top.gif будет отдан файл /data/w3/i/top.gif.
В значении параметра путь можно использовать переменные, кроме $document_root и $realpath_root.
Путь к файлу формируется путем простого добавления URI к значению директивы root. Если же URI необходимо поменять, следует воспользоваться директивой alias. Завершающая косая черта в значении параметра путь отбрасывается, поскольку URI добавляется вместе со своей начальной косой чертой.
satisfy#
Разрешает доступ, если его разрешают все (all) или хотя бы один (any) из модулей Access, Auth Basic или Auth Request.
location / {
satisfy any;
allow 192.168.1.0/32;
deny all;
auth_basic "closed site";
auth_basic_user_file conf/htpasswd;
}
send_lowat#
При установке этой директивы в ненулевое значение Angie будет пытаться
минимизировать число операций отправки на клиентских сокетах либо при помощи
флага NOTE_LOWAT метода kqueue, либо при помощи
параметра сокета SO_SNDLOWAT. В обоих случаях будет использован
указанный размер.
send_timeout#
Задает таймаут при передаче ответа клиенту. Таймаут устанавливается не на всю передачу ответа, а только между двумя операциями записи. Если по истечении этого времени клиент ничего не примет, соединение будет закрыто.
sendfile#
Разрешает или запрещает использовать sendfile().
Возможно использование aio для подгрузки данных для sendfile():
location /video/ {
sendfile on;
tcp_nopush on;
aio on;
}
В такой конфигурации функция sendfile() вызывается с флагом SF_NODISKIO, в результате чего она не блокируется на диске, а сообщает об отсутствии данных в памяти. После этого Angie инициирует асинхронную подгрузку данных, читая один байт. При этом ядро FreeBSD подгружает в память первые 128K байт файла, однако при последующих чтениях файл подгружается частями только по 16K. Изменить это можно с помощью директивы read_ahead.
sendfile_max_chunk#
Ограничивает объем данных, который может передан за один вызов sendfile(). Без этого ограничения одно быстрое соединение может целиком захватить рабочий процесс.
server#
Задает конфигурацию для виртуального сервера. Четкого разделения виртуальных серверов на IP-based (на основании IP-адреса) и name-based (на основании поля "Host" заголовка запроса) нет. Вместо этого директивами listen описываются все адреса и порты, на которых нужно принимать соединения для этого сервера, а в директиве server_name указываются все имена серверов.
Подробнее: Как обрабатываются запросы
server_name#
Задает имена виртуального сервера, например:
server {
server_name example.com www.example.com;
}
Первое имя становится основным именем сервера.
В именах серверов можно использовать звездочку ("*") для замены первой или последней части имени:
server {
server_name example.com *.example.com www.example.*;
}
Такие имена называются именами с маской.
Два первых вышеприведенных имени можно объединить в одно:
server {
server_name .example.com;
}
В качестве имени сервера можно также использовать регулярное выражение, указав перед ним тильду ("~"):
server {
server_name ~^www\d+\.example\.com$ www.example.com;
}
Регулярное выражение может содержать группы захвата, которые могут затем использоваться в других директивах:
server {
server_name ~^(www\.)?(.+)$;
location / {
root /sites/$2;
}
}
server {
server_name _;
location / {
root /sites/default;
}
}
Именованные группы захвата в регулярном выражении создают переменные, которые могут затем использоваться в других директивах:
server {
server_name ~^(www\.)?(?<domain>.+)$;
location / {
root /sites/$domain;
}
}
server {
server_name _;
location / {
root /sites/default;
}
}
Примечание
Если параметр директивы задан как $hostname, используется имя хоста веб-сервера.
Можно также указать пустое имя сервера (""):
server {
server_name www.example.com "";
}
При поиске виртуального сервера по имени, которому соответствует несколько указанных вариантов (например, одновременно подходят и имя с маской, и регулярное выражение), будет выбран первый подходящий вариант в следующем порядке приоритета:
точное имя;
самое длинное имя с маской в начале, например
*.example.com;самое длинное имя с маской в конце, например
mail.*;первое подходящее регулярное выражение (в порядке следования в конфигурации), в том числе пустое имя.
Предупреждение
Чтобы использовать server_name с TLS,
необходима терминация TLS-соединения.
Эта директива сопоставляется с Host в HTTP-запросе,
поэтому рукопожатие должно быть закончено, а соединение расшифровано.
server_name_in_redirect#
| |
По умолчанию |
|
http, server, location |
Разрешает или запрещает использовать в абсолютных перенаправлениях, выдаваемых Angie, основное имя сервера, задаваемое директивой server_name.
| используется основное имя сервера, задаваемое директивой server_name |
| используется имя, указанное в поле "Host" заголовка запроса. Если же этого поля нет, то используется IP-адрес сервера. |
Использование в перенаправлениях порта управляется директивой port_in_redirect.
server_names_hash_bucket_size#
| |
По умолчанию |
|
http |
Задает размер корзины в хэш-таблицах имен серверов. Значение по умолчанию зависит от размера строки кэша процессора. Подробнее настройка хэш-таблиц обсуждается отдельно.
server_names_hash_max_size#
Задает максимальный размер хэш-таблиц имен серверов. Подробнее настройка хэш-таблиц обсуждается отдельно.
server_tokens#
| |
По умолчанию |
|
http, server, location |
Разрешает или запрещает указывать версию Angie
на страницах ошибок и в поле заголовка ответа Server.
Если указан параметр build,
то вместе с версией будет также указано имя сборки,
заданное соответствующим параметром скрипта configure.
В Angie PRO директива может быть задана строкой,
которая может также содержать переменные.
Тогда на страницах ошибок и в поле заголовка ответа Server
вместо имени сервера, версии и имени сборки
будет указываться значение этой строки с подставленными переменными.
Пустая строка запрещает выдачу поля Server.
status_zone#
Изменено в версии 1.12.0.
| |
По умолчанию | — |
server, location, if в location |
Выделяет зону разделяемой памяти для сбора метрик /status/http/location_zones/<зона> и /status/http/server_zones/<зона>.
Несколько контекстов server
могут совместно использовать одну и ту же зону для сбора данных;
особое значение off
выключает сбор данных во вложенных блоках location.
Синтаксис с одним значением зоны объединяет все метрики для текущего контекста в одну зону разделяемой памяти:
server {
listen 80;
server_name *.example.com;
status_zone single;
# ...
}
Альтернативный синтаксис позволяет задавать следующие параметры:
ключ | Строка с переменными, значение которой определяет группировку запросов в зоне. Все запросы, дающие одинаковые значения после подстановки, объединяются в одну группу. Если подстановка возвращает пустое значение, метрики не обновляются. |
зона | Имя зоны разделяемой памяти. |
число (необязательный) | Максимальное количество отдельных групп для сбора метрик.
Если новые значения ключа превышают этот лимит, они объединяются в группу Значение по умолчанию — 1. |
В следующем примере все запросы с одинаковым значением $host
группируются в host_zone. Метрики собираются отдельно для каждого
уникального значения $host до тех пор, пока количество групп метрик не
достигнет 10. После этого любые новые значения $host будут добавляться в
группу host_zone:
server {
listen 80;
server_name *.example.com;
status_zone $host zone=host_zone:10;
location / {
proxy_pass http://example.com;
}
}
Результирующие метрики разделяются по отдельным хостам в выводе API.
Примечание
Эти метрики собираются, только если задан status_zone. Без него
сервер или location не отображается в /status/http/server_zones/<зона>,
/status/http/location_zones/<зона>,
виджете «HTTP Zones»
и в выводе Prometheus,
и предупреждение при этом не выводится.
См. пример конфигурации.
subrequest_output_buffer_size#
| |
По умолчанию |
|
http, server, location |
Задает размер буфера, используемого для хранения тела ответа подзапроса. По умолчанию размер одного буфера равен размеру страницы памяти. В зависимости от платформы это или 4K, или 8K, однако его можно сделать меньше.
Примечание
Директива применима только для подзапросов, тело ответа которых сохраняется в памяти. Например, подобные подзапросы создаются при помощи SSI.
tcp_nodelay#
Разрешает или запрещает использование параметра TCP_NODELAY. Параметр включается при переходе соединения в состояние keep-alive. Также, он включается на SSL-соединениях, при небуферизованном проксировании и при проксировании WebSocket.
tcp_nopush#
Разрешает или запрещает использование параметра сокета TCP_NOPUSH во
FreeBSD или TCP_CORK в Linux. Параметр включается только при
использовании sendfile. Включение параметра позволяет:
передавать заголовок ответа и начало файла в одном пакете в Linux и во FreeBSD 4.*;
передавать файл полными пакетами.
time_format#
Добавлено в версии 1.12.0.
Определяет $переменную, содержащую текущее локальное время, отформатированное
в соответствии со строкой формата, которая поддерживает спецификаторы в стиле
strftime, а также %L для миллисекунд. Директива полезна, когда
возможностей $time_local и $time_iso8601 недостаточно — например, если требуется точность до
миллисекунд:
time_format $time_ms "%Y-%m-%dT%H:%M:%S.%L%Z";
log_format tf '$time_ms $remote_addr "$request" $status';
При таком формате переменная $time_ms принимает значение вида 2024-01-15T14:34:56.789+03:00.
Попытка переопределить переменную, не допускающую переопределения, например
$time_local, или повторно объявить time_format с
тем же именем приводит к ошибке загрузки конфигурации вида: "the duplicate
"..." variable".
Строка формата поддерживает следующие спецификаторы; все они вычисляются
в том же часовом поясе, что и $time_local:
| год, 4 цифры |
| год, 2 цифры |
| месяц, |
| день месяца, |
| день месяца, дополненный пробелом, |
| час, |
| час, |
| минута, |
| секунда, |
| миллисекунды, |
| обозначение AM/PM в верхнем регистре, |
| то же самое в нижнем регистре, |
| сокращенное название дня недели, |
| полное название дня недели, |
| сокращенное название месяца, |
| полное название месяца, |
| смещение часового пояса, |
| смещение часового пояса в формате ISO 8601, |
| перевод строки |
| табуляция |
| символ |
Примечание
Нераспознанный спецификатор копируется в вывод без изменений, включая ведущий
символ %; одиночный символ % в самом конце строки формата
отбрасывается.
try_files#
Проверяет существование файлов в заданном порядке и использует для обработки
запроса первый найденный файл, причем обработка делается в контексте этого же
location'а. Путь к файлу строится из параметра файл в соответствии с
директивами root и alias. С помощью косой черты в
конце имени можно проверить существование каталога, например, $uri/. В
случае, если ни один файл не найден, производится внутреннее перенаправление на
uri, заданный последним параметром.
В параметрах файл и uri можно использовать переменные.
Например:
location /images/ {
try_files $uri /images/default.gif;
}
location = /images/default.gif {
expires 30s;
}
Последний параметр может быть URI для внутреннего перенаправления,
ссылкой на именованный location (например, @drupal)
или кодом ответа в форме =код (например, =404):
location / {
try_files $uri $uri/index.html $uri.html =404;
}
Следует помнить, что чрезмерное использование директивы try_files
увеличивает число системных вызовов,
что может негативно сказаться на производительности.
Так, не следует использовать try_files для формирования поведения,
фактически дублирующего поведение по умолчанию, например:
location /bad_pattern {
# try_files $uri $uri/ =404; # не рекомендуется!
}
Также не следует использовать try_files
исключительно для перенаправления при отсутствии файла.
Дело в том, что директива try_files имеет две особенности:
Во-первых, она проверяет существование каждого файла, что увеличивает нагрузку на систему.
Во-вторых, любые ошибки открытия файла (например,
too many open files, ошибки прав доступа) также считаются отсутствием файла и вызывают переход к запасному обработчику, что может привести к подмене ошибок 5xx успешными ответами и некорректному кэшированию.
Так, на практике можно встретить следующую проблемную конструкцию:
location / {
try_files $uri $uri/ @drupal; # не рекомендуется!
}
Ее проблема в том, что единственная цель здесь — перенаправление.
Использование try_files приводит к перечисленным выше недостаткам,
но не дает никаких преимуществ,
поскольку проверка существования файлов не нужна.
Правильное решение — использовать директиву error_page,
которая лишена этих недостатков:
error_page 404 = @drupal;
log_not_found off;
Напротив, в следующем примере:
location ~ \.php$ {
try_files $uri @drupal;
fastcgi_pass ...;
fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
# ...
}
Директива try_files проверяет существование PHP-файла,
прежде чем передать запрос настроенному в том же блоке FastCGI-серверу;
здесь использование try_files оправдано.
Пример использования при проксировании Mongrel:
location / {
try_files /system/maintenance.html
$uri $uri/index.html $uri.html
@mongrel;
}
location @mongrel {
proxy_pass http://mongrel;
}
Пример использования вместе с Drupal/FastCGI:
location / {
error_page 404 = @drupal;
}
location ~ \.php$ {
try_files $uri @drupal;
fastcgi_pass ...;
fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
fastcgi_param SCRIPT_NAME $fastcgi_script_name;
fastcgi_param QUERY_STRING $args;
# ... прочие fastcgi_param
}
location @drupal {
fastcgi_pass ...;
fastcgi_param SCRIPT_FILENAME /path/to/index.php;
fastcgi_param SCRIPT_NAME /index.php;
fastcgi_param QUERY_STRING q=$uri&$args;
# ... прочие fastcgi_param
}
Пример использования вместе с Wordpress и Joomla:
location / {
error_page 404 = @wordpress;
}
location ~ \.php$ {
try_files $uri @wordpress;
fastcgi_pass ...;
fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
# ... прочие fastcgi_param
}
location @wordpress {
fastcgi_pass ...;
fastcgi_param SCRIPT_FILENAME /path/to/index.php;
# ... прочие fastcgi_param
}
types#
| |
По умолчанию |
|
http, server, location |
Задает соответствие расширений имен файлов и MIME-типов ответов. Расширения нечувствительны к регистру символов. Одному MIME-типу может соответствовать несколько расширений, например:
types {
application/octet-stream bin exe dll;
application/octet-stream deb;
application/octet-stream dmg;
}
Достаточно полная таблица соответствий входит в дистрибутив Angie и находится в файле conf/mime.types.
Для того чтобы для определенного location'а для всех ответов выдавался MIME-тип "application/octet-stream", можно использовать следующее:
location /download/ {
types { }
default_type application/octet-stream;
}
types_hash_bucket_size#
| |
По умолчанию |
|
http, server, location |
Задает размер корзины в хэш-таблицах типов. Подробнее настройка хэш-таблиц обсуждается отдельно.
types_hash_max_size#
| |
По умолчанию |
|
http, server, location |
Задает максимальный размер хэш-таблиц типов. Подробнее настройка хэш-таблиц обсуждается отдельно.
underscores_in_headers#
| |
По умолчанию |
|
http, server |
Разрешает или запрещает использование символов подчеркивания в полях заголовка запроса клиента. Если использование символов подчеркивания запрещено, поля заголовка запроса, в именах которых есть подчеркивания, помечаются как недопустимые и подпадают под действие директивы ignore_invalid_headers.
Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию.
variables_hash_bucket_size#
Задает размер корзины в хэш-таблице переменных. Подробнее настройка хэш-таблиц обсуждается отдельно.
variables_hash_max_size#
Изменено в версии 1.11.0.
Задает максимальный размер хэш-таблиц переменных. Подробнее настройка хэш-таблиц обсуждается отдельно.
Встроенные переменные#
Модуль http_core поддерживает встроенные переменные, имена которых совпадают с именами переменных веб-сервера Apache. Прежде всего, это переменные, представляющие из себя поля заголовка запроса клиента, такие как $http_user_agent, $http_cookie и тому подобное. Кроме того, есть и другие переменные:
$angie_version#
версия Angie
$arg_<имя>#
аргумент имя в строке запроса
$args#
аргументы в строке запроса
$binary_remote_addr#
адрес клиента в бинарном виде, длина значения всегда 4 байта для IPv4-адресов или 16 байт для IPv6-адресов
$body_bytes_sent#
число байт, переданное клиенту, без учета заголовка ответа; переменная совместима с параметром "%B" модуля Apache mod_log_config
$bytes_sent#
число байт, переданных клиенту
$connection#
порядковый номер соединения
$connection_requests#
текущее число запросов в соединении
$connection_time#
время соединения в секундах с точностью до миллисекунд
$content_length#
поле Content-Length заголовка запроса
$content_type#
поле Content-Type заголовка запроса
$document_root#
$document_uri#
то же, что и $uri
$host#
в порядке приоритета: имя хоста из строки запроса, или имя хоста из поля "Host" заголовка запроса, или имя сервера, соответствующего запросу
$hostname#
имя хоста
$http_<имя>#
Изменено в версии 1.11.0: В запросах по протоколу HTTP/3 переменная $http_host
инициализируется из значения псевдозаголовка :authority,
если заголовок Host не был передан клиентом.
произвольное поле заголовка запроса; последняя часть имени переменной соответствует имени поля, приведенному к нижнему регистру, с заменой символов тире на символы подчеркивания
$https#
on если соединение работает в режиме SSL, либо пустая строка
$is_args#
?, если в строке запроса есть аргументы, и пустая строка, если их нет
$is_request_port#
:, если значение $request_port непустое, либо пустая строка
$limit_rate#
установка этой переменной позволяет ограничивать скорость передачи ответа, см. limit_rate
$msec#
текущее время в секундах с точностью до миллисекунд
$nginx_version#
версия nginx
$pid#
номер (PID) рабочего процесса
$pipe#
p если запрос был pipelined, иначе .
$proxy_protocol_addr#
Адрес клиента, полученный из заголовка протокола PROXY.
Протокол PROXY должен быть предварительно включен при помощи установки параметра proxy_protocol в директиве listen.
$proxy_protocol_port#
Порт клиента, полученный из заголовка протокола PROXY.
Протокол PROXY должен быть предварительно включен при помощи установки параметра proxy_protocol в директиве listen.
$proxy_protocol_server_addr#
Адрес сервера, полученный из заголовка протокола PROXY.
Протокол PROXY должен быть предварительно включен при помощи установки параметра proxy_protocol в директиве listen.
$proxy_protocol_server_port#
Порт сервера, полученный из заголовка протокола PROXY.
Протокол PROXY должен быть предварительно включен при помощи установки параметра proxy_protocol в директиве listen.
$proxy_protocol_tlv_<имя>#
TLV, полученный из заголовка протокола PROXY. Имя может быть именем типа TLV или его числовым значением. В последнем случае значение задается в шестнадцатеричном виде и должно начинаться с 0x:
$proxy_protocol_tlv_alpn
$proxy_protocol_tlv_0x01
SSL TLV могут также быть доступны как по имени типа TLV, так и по его числовому значению, оба должны начинаться с ssl_:
$proxy_protocol_tlv_ssl_version
$proxy_protocol_tlv_ssl_0x21
Поддерживаются следующие имена типов TLV:
alpn (0x01)- протокол более высокого уровня, используемый поверх соединенияauthority (0x02)- значение имени хоста, передаваемое клиентомunique_id (0x05)- уникальный идентификатор соединенияnetns (0x30)- имя пространства именssl (0x20)- структура SSL TLV в бинарном виде
Поддерживаются следующие имена типов SSL TLV:
ssl_version (0x21)- версия SSL, используемая в клиентском соединенииssl_cn (0x22)- Common Name сертификатаssl_cipher (0x23)- имя используемого шифраssl_sig_alg (0x24)- алгоритм, используемый для подписи сертификатаssl_key_alg (0x25)- алгоритм публичного ключа
Также поддерживается следующее специальное имя типа SSL TLV:
ssl_verify- результат проверки клиентского сертификата:0, если клиент предоставил сертификат и он был успешно верифицирован, либо ненулевое значение
Протокол PROXY должен быть предварительно включен при помощи установки параметра proxy_protocol в директиве listen.
$query_string#
то же, что и $args
$realpath_root#
абсолютный путь, соответствующий значению директивы root или alias для текущего запроса, в котором все символические ссылки преобразованы в реальные пути
$remote_addr#
адрес клиента
$remote_port#
порт клиента
$remote_user#
имя пользователя, использованное в Basic аутентификации
$request#
первоначальная строка запроса целиком
$request_body#
Тело запроса. Значение переменной появляется в location'ах, обрабатываемых директивами proxy_pass, fastcgi_pass, uwsgi_pass и scgi_pass, когда тело было прочитано в буфер в памяти.
$request_body_file#
Имя временного файла, в котором хранится тело запроса. По завершении обработки файл необходимо удалить. Для того чтобы тело запроса всегда записывалось в файл, следует включить client_body_in_file_only. При передаче имени временного файла в проксированном запросе или в запросе к FastCGI/uwsgi/SCGI-серверу следует запретить передачу самого тела директивами proxy_pass_request_body off, fastcgi_pass_request_body off, uwsgi_pass_request_body off или scgi_pass_request_body off соответственно.
$request_completion#
OK, если запрос завершился, либо пустая строка
$request_filename#
путь к файлу для текущего запроса, формируемый из директив root или alias и URI запроса
$request_id#
уникальный идентификатор запроса, сформированный из 16 случайных байт, в шестнадцатеричном виде
$request_length#
длина запроса (включая строку запроса, заголовок и тело запроса)
$request_method#
метод запроса, обычно GET или POST
$request_port#
в порядке приоритета: номер порта из компонента authority URI, или номер порта из поля заголовка запроса Host
$request_time#
время обработки запроса в секундах с точностью до миллисекунд; время, прошедшее с момента чтения первых байт от клиента
$request_uri#
первоначальный URI запроса целиком (с аргументами), не изменяется в процессе обработки запроса; см. $uri — текущий URI с учётом всех преобразований
$scheme#
схема запроса, "http" или "https"
$sent_body#
Добавлено в версии 1.11.0.
тело ответа подзапроса или внешнего запроса, если оно сохранено в памяти; иначе пустая строка
$sent_http_<имя>#
произвольное поле заголовка ответа; последняя часть имени переменной соответствует имени поля, приведенному к нижнему регистру, с заменой символов тире на символы подчеркивания
$sent_trailer_<имя>#
произвольное поле, отправленное в конце ответа; последняя часть имени переменной соответствует имени поля, приведенному к нижнему регистру, с заменой символов тире на символы подчеркивания
$server_addr#
Адрес сервера, принявшего запрос.
Получение значения этой переменной обычно требует одного системного вызова. Чтобы избежать системного вызова, в директивах listen следует указывать адреса и использовать параметр bind.
$server_name#
имя сервера, принявшего запрос
$server_port#
порт сервера, принявшего запрос
$server_protocol#
протокол запроса, обычно "HTTP/1.0", "HTTP/1.1" или "HTTP/2.0"
$status#
статус ответа
$tcpinfo_rtt, $tcpinfo_rttvar, $tcpinfo_snd_cwnd, $tcpinfo_rcv_space#
информация о клиентском TCP-соединении; доступна на системах, поддерживающих параметр сокета TCP_INFO
$time_iso8601#
локальное время в формате по стандарту ISO 8601
$time_local#
локальное время в Common Log Format
$uri#
Текущий URI запроса в нормализованном виде.
Значение $uri может изменяться в процессе обработки запроса, например, при перезаписи с помощью rewrite, при внутренних перенаправлениях или при использовании индексных файлов. О том, как это значение сопоставляется с путем в файловой системе, см. Выбор локаций.