Модуль http_core#

Директивы#

absolute_redirect#

Синтаксис:

absolute_redirect on | off;

Умолчание:

absolute_redirect on;

Контекст:

http, server, location

Если запрещено, то перенаправления, выдаваемые Angie, будут относительными.

См. также директивы server_name_in_redirect и port_in_redirect.

aio#

Синтаксис:

aio on | off | threads[=pool];

Умолчание:

aio off;

Контекст:

http, server, location

Разрешает или запрещает использование файлового асинхронного ввода-вывода (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;

По умолчанию поддержка многопоточности выключена, её сборку следует разрешить с помощью конфигурационного параметра –with-threads. В настоящий момент многопоточность совместима только с методами epoll, kqueue и eventport. Отправка файлов в многопоточном режиме поддерживается только на Linux.

См. также директиву sendfile.

aio_write#

Синтаксис:

aio_write on | off;

Умолчание:

aio_write off;

Контекст:

http, server, location

При включённом aio разрешает его использование для записи файлов. В настоящий момент это работает только при использовании aio threads и ограничено записью временных файлов с данными, полученными от проксируемых серверов.

alias#

Синтаксис:

alias путь;

Умолчание:

—

Контекст:

location

Задаёт замену для указанного 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;
}

auth_delay#

Синтаксис:

auth_delay время;

Умолчание:

auth_delay 0s;

Контекст:

http, server, location

Задерживает обработку неавторизованных запросов с кодом ответа 401 для предотвращения атак по времени в случае ограничения доступа по паролю или по результату подзапроса.

chunked_transfer_encoding#

Синтаксис:

chunked_transfer_encoding on | off;

Умолчание:

chunked_transfer_encoding on;

Контекст:

http, server, location

Позволяет запретить формат передачи данных частями (chunked transfer encoding) в HTTP/1.1. Это может понадобиться при использовании программ, не поддерживающих chunked encoding, несмотря на требования стандарта.

client_body_buffer_size#

Синтаксис:

client_body_buffer_size размер;

Умолчание:

client_body_buffer_size 8k|16k;

Контекст:

http, server, location

Задаёт размер буфера для чтения тела запроса клиента. Если тело запроса больше заданного буфера, то всё тело запроса или только его часть записывается во временный файл. По умолчанию размер одного буфера равен двум размерам страницы. На x86, других 32-битных платформах и x86-64 это 8K. На других 64-битных платформах это обычно 16K.

client_body_in_file_only#

Синтаксис:

client_body_in_file_only on | clean | off;

Умолчание:

client_body_in_file_only off;

Контекст:

http, server, location

Определяет, сохранять ли всё тело запроса клиента в файл. Директиву можно использовать для отладки и при использовании переменной $request_body_file или метода $r->request_body_file модуля http_perl.

on

временные файлы по окончании обработки запроса не удаляются

clean

разрешает удалять временные файлы, оставшиеся по окончании обработки запроса

client_body_in_single_buffer#

Синтаксис:

client_body_in_single_buffer on | off;

Умолчание:

client_body_in_single_buffer off;

Контекст:

http, server, location

Определяет, сохранять ли всё тело запроса клиента в одном буфере. Директива рекомендуется при использовании переменной $request_body для уменьшения требуемого числа операций копирования.

client_body_temp_path#

Синтаксис:

client_body_temp_path путь [уровень1 [уровень2 [уровень3]]];

Умолчание:

client_body_temp_path client_body_temp;

Контекст:

http, server, location

Задаёт каталог для хранения временных файлов с телами запросов клиентов. В каталоге может использоваться иерархия подкаталогов до трёх уровней. Например, при такой конфигурации

client_body_temp_path /spool/angie/client_temp 1 2;

путь к временному файлу будет следующего вида:

/spool/angie/client_temp/7/45/00000123457

client_body_timeout#

Синтаксис:

client_body_timeout время;

Умолчание:

client_body_timeout 60s;

Контекст:

http, server, location

Задаёт таймаут при чтении тела запроса клиента. Таймаут устанавливается не на всю передачу тела запроса, а только между двумя последовательными операциями чтения. Если по истечении этого времени клиент ничего не передаст, обработка запроса прекращается с ошибкой 408 (Request Time-out).

client_header_buffer_size#

Синтаксис:

client_header_buffer_size размер;

Умолчание:

client_header_buffer_size 1k;

Контекст:

http, server

Задаёт размер буфера для чтения заголовка запроса клиента. Для большинства запросов достаточно буфера размером в 1K байт. Однако если в запросе есть длинные cookies, или же запрос пришёл от WAP-клиента, то он может не поместиться в 1K. Поэтому, если строка запроса или поле заголовка запроса не помещаются полностью в этот буфер, то выделяются буферы большего размера, задаваемые директивой large_client_header_buffers.

Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию. Подробнее см. в разделе Выбор виртуального сервера.

client_header_timeout#

Синтаксис:

client_header_timeout время;

Умолчание:

client_header_timeout 60s;

Контекст:

http, server

Задаёт таймаут при чтении заголовка запроса клиента. Если по истечении этого времени клиент не передаст полностью заголовок, обработка запроса прекращается с ошибкой 408 (Request Time-out).

client_max_body_size#

Синтаксис:

client_max_body_size размер;

Умолчание:

client_max_body_size 1m;

Контекст:

http, server, location

Задаёт максимально допустимый размер тела запроса клиента. Если размер больше заданного, то клиенту возвращается ошибка 413 (Request Entity Too Large). Следует иметь в виду, что браузеры не умеют корректно показывать эту ошибку.

0

отключает проверку размера тела запроса клиента

connection_pool_size#

Синтаксис:

connection_pool_size размер;

Умолчание:

connection_pool_size 256 | 512;

Контекст:

http, server, location

Позволяет производить точную настройку выделения памяти под конкретные соединения. Эта директива не оказывает существенного влияния на производительность, и её не следует использовать.
По умолчанию:

256 байт

на 32-битных платформах

512 байт

на 64-битных платформах

default_type#

Синтаксис:

default_type mime-тип;

Умолчание:

default_type text/plain;

Контекст:

http, server, location

Задаёт MIME-тип ответов по умолчанию. Соответствие расширений имён файлов MIME-типу ответов задаётся с помощью директивы types.

directio#

Синтаксис:

directio размер | off;

Умолчание:

directio off;

Контекст:

http, server, location

Разрешает использовать флаги O_DIRECT (FreeBSD, Linux), F_NOCACHE (macOS) или функцию directio() (Solaris) при чтении файлов, размер которых больше либо равен указанному. Директива автоматически запрещает использование sendfile для данного запроса. Рекомендуется использовать для больших файлов:

directio 4m;

или при использовании aio в Linux.

directio_alignment#

Синтаксис:

directio_alignment размер;

Умолчание:

directio_alignment 512;

Контекст:

http, server, location

Устанавливает выравнивание для directio. В большинстве случаев достаточно 512-байтового выравнивания, однако при использовании XFS под Linux его нужно увеличить до 4K.

error_page#

Синтаксис:

error_page код … [=[ответ]] uri;

Умолчание:

—

Контекст:

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 on | off;

Умолчание:

etag on;

Контекст:

http, server, location

Разрешает или запрещает автоматическую генерацию поля “ETag“ заголовка ответа для статических ресурсов.

http#

Синтаксис:

http { … }

Умолчание:

—

Контекст:

main

Предоставляет контекст конфигурационного файла, в котором указываются директивы HTTP-сервера.

if_modified_since#

Синтаксис:

if_modified_since off | exact | before;

Умолчание:

if_modified_since exact;

Контекст:

http, server, location

Определяет, как сравнивать время модификации ответа с временем в поле “If-Modified-Since“ заголовка запроса:

off

ответ всегда считается изменившимся

exact

точное совпадение

before

время модификации ответа меньше или равно времени, заданному в поле “If-Modified-Since“ заголовка запроса

ignore_invalid_headers#

Синтаксис:

ignore_invalid_headers on | off;

Умолчание:

ignore_invalid_headers on;

Контекст:

http, server

Если включено, Angie игнорирует поля заголовка с недопустимыми именами. Допустимыми считаются имена, состоящие из английских букв, цифр, дефисов и возможно знаков подчёркивания (последнее контролируется директивой underscores_in_headers).

Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию.

internal#

Синтаксис:

internal;

Умолчание:

—

Контекст:

location

Указывает, что location может использоваться только для внутренних запросов. Для внешних запросов клиенту будет возвращаться ошибка 404 (Not Found). Внутренними запросами являются:

  • запросы, перенаправленные директивами error_page, index, random_index и try_files;

  • запросы, перенаправленные с помощью поля “X-Accel-Redirect“ заголовка ответа вышестоящего сервера;

  • подзапросы, формируемые командой include virtual модуля Модуль http_ssi, директивами модуля http_addition, а также директивами auth_request и mirror;

  • запросы, изменённые директивой rewrite.

Пример:

error_page 404 /404.html;

location = /404.html {
  internal;
}

Примечание

Для предотвращения зацикливания, которое может возникнуть при использовании некорректных конфигураций, количество внутренних перенаправлений ограничено десятью. По достижении этого ограничения будет возвращена ошибка 500 (Internal Server Error). В таком случае в лог-файле ошибок можно увидеть сообщение rewrite or internal redirection cycle.

keepalive_disable#

Синтаксис:

keepalive_disable none | браузер …;

Умолчание:

keepalive_disable msie6;

Контекст:

http, server, location

Запрещает keep-alive соединения с некорректно ведущими себя браузерами. Параметры браузер указывают, на какие браузеры это распространяется.

none

разрешает keep-alive соединения со всеми браузерами

msie6

запрещает keep-alive соединения со старыми версиями MSIE после получения запроса POST

safari

запрещает keep-alive соединения с Safari и подобными им браузерами на macOS и подобных ей ОС

keepalive_requests#

Синтаксис:

keepalive_requests число;

Умолчание:

keepalive_requests 1000;

Контекст:

http, server, location

Задаёт максимальное число запросов, которые можно сделать по одному keep-alive соединению. После того, как сделано максимальное число запросов, соединение закрывается.

Периодическое закрытие соединений необходимо для освобождения памяти, выделенной под конкретные соединения. Поэтому использование слишком большого максимального числа запросов может приводить к чрезмерному потреблению памяти и не рекомендуется.

keepalive_time#

Синтаксис:

keepalive_time время;

Умолчание:

keepalive_time 1h;

Контекст:

http, server, location

Ограничивает максимальное время, в течение которого могут обрабатываться запросы в рамках keep-alive соединения. По достижении заданного времени соединение закрывается после обработки очередного запроса.

keepalive_timeout#

Синтаксис:

keepalive_timeout таймаут [заголовок_таймаута];

Умолчание:

keepalive_timeout 75s;

Контекст:

http, server, location

таймаут

задаёт время, в течение которого keep-alive соединение с клиентом не будет закрыто со стороны сервера

0

запрещает keep-alive соединения с клиентами

Второй, необязательный, параметр задаёт значение в поле “Keep‑Alive: timeout=время“ заголовка ответа. Два параметра могут отличаться друг от друга.

Поле “Keep-Alive: timeout=время“ заголовка понимают Mozilla и Konqueror. MSIE сам закрывает keep-alive соединение примерно через 60 секунд.

large_client_header_buffers#

Синтаксис:

large_client_header_buffers количество размер;

Умолчание:

large_client_header_buffers 4 8k;

Контекст:

http, server

Задаёт максимальное число и размер буферов для чтения большого заголовка запроса клиента. Строка запроса не должна превышать размера одного буфера, иначе клиенту возвращается ошибка 414 (Request-URI Too Large). Поле заголовка запроса также не должно превышать размера одного буфера, иначе клиенту возвращается ошибка 400 (Bad Request). Буферы выделяются только по мере необходимости. По умолчанию размер одного буфера равен 8K байт. Если по окончании обработки запроса соединение переходит в состояние keep-alive, эти буферы освобождаются.

Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию.

limit_except#

Синтаксис:

limit_except метод1 [метод2…] { … };

Умолчание:

—

Контекст:

location

Ограничивает HTTP-методы, доступные внутри location. Параметр метод может быть одним из GET, HEAD, POST, PUT, DELETE, MKCOL, COPY, MOVE, OPTIONS, PROPFIND, PROPPATCH, LOCK, UNLOCK или PATCH. Если разрешён метод GET, то метод HEAD также будет разрешён. Доступ к остальным методам может быть ограничен при помощи директив модулей http_access и http_auth_basic.

limit_except GET {
  allow 192.168.1.0/32;
  deny  all;
}

Примечание

Ограничение в примере действует для всех методов, кроме GET и HEAD.

limit_rate#

Синтаксис:

limit_rate скорость;

Умолчание:

limit_rate 0;

Контекст:

http, server, location, if в location

Ограничивает скорость передачи ответа клиенту. Скорость задаётся в байтах в секунду. Значение 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#

Синтаксис:

limit_rate_after размер;

Умолчание:

limit_rate_after 0;

Контекст:

http, server, location, if в location

Задаёт начальный объём данных, после передачи которого начинает ограничиваться скорость передачи ответа клиенту. В значении параметра можно использовать переменные.

Пример:

location /flv/ {
 flv;
 limit_rate_after 500k;
 limit_rate       50k;
}

lingering_close#

Синтаксис:

lingering_close on | always | off;

Умолчание:

lingering_close on;

Контекст:

http, server, location

Управляет закрытием соединений с клиентами.

on

Angie будет ждать и обрабатывать дополнительные данные, поступающие от клиента, перед полным закрытием соединения, но только если эвристика указывает на то, что клиент может ещё послать данные.

always

Angie всегда будет ждать и обрабатывать дополнительные данные, поступающие от клиента.

off

Angie не будет ждать поступления дополнительных данных и сразу же закроет соединение. Это поведение нарушает протокол и поэтому не должно использоваться без необходимости.

Для управления закрытием HTTP/2-соединений директива должна быть задана на уровне server.

lingering_time#

Синтаксис:

lingering_time время;

Умолчание:

lingering_time 30s;

Контекст:

http, server, location

Если действует lingering_close, эта директива задаёт максимальное время, в течение которого Angie будет обрабатывать (читать и игнорировать) дополнительные данные, поступающие от клиента. По прошествии этого времени соединение будет закрыто, даже если будут ещё данные.

lingering_timeout#

Синтаксис:

lingering_timeout время;

Умолчание:

lingering_timeout 5s;

Контекст:

http, server, location

Если действует lingering_close, эта директива задаёт максимальное время ожидания поступления дополнительных данных от клиента. Если в течение этого времени данные не были получены, соединение закрывается. В противном случае данные читаются и игнорируются, и Angie снова ждёт поступления данных. Цикл “ждать-читать-игнорировать” повторяется, но не дольше чем задано директивой lingering_time.

listen#

Синтаксис:

listen адрес[:порт] [default_server] [ssl] [http2 | quic] [proxy_protocol] [setfib=число] [fastopen=число] [backlog=число] [rcvbuf=размер] [sndbuf=размер] [accept_filter=фильтр] [deferred] [bind] [ipv6only=on|off] [reuseport] [so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]];

listen порт [default_server] [ssl] [http2 | quic] [proxy_protocol] [setfib=число] [fastopen=число] [backlog=число] [rcvbuf=размер] [sndbuf=размер] [accept_filter=фильтр] [deferred] [bind] [ipv6only=on|off] [reuseport] [so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]];

listen unix:путь [default_server] [ssl] [http2 | quic] [proxy_protocol] [backlog=число] [rcvbuf=размер] [sndbuf=размер] [accept_filter=фильтр] [deferred] [bind] [so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]];

Умолчание:

listen *:80 | *:8000;

Контекст:

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];

UNIX-сокеты задаются при помощи префикса unix::

listen unix:/var/run/angie.sock;

Если указан только адрес, то используется порт 80.

Если директива не указана, то используется либо *:80, если Angie работает с привилегиями суперпользователя, либо *:8000.

default_server

сервер, в котором указан этот параметр, будет сервером по умолчанию для указанной пары адрес:порт (cлушающий сокет). Если же директив с параметром default_server нет, сервером по умолчанию для слущающего сокета будет первый встречающийся в конфигурации сервер, в котором описан этот слушающий сокет.

ssl

указывает на то, что все соединения, принимаемые на данном слушающем сокете, должны работать в режиме SSL. Это позволяет задать компактную конфигурацию для сервера, работающего сразу в двух режимах — HTTP и HTTPS.

http2

позволяет принимать на слушающем сокете HTTP/2-соединения. Обычно, чтобы это работало, следует также указать параметр ssl, однако Angie можно также настроить и на приём HTTP/2-соединений без SSL.

Не рекомендуется, начиная с версии 1.2.0.

Используйте взамен директиву http2.

quic

позволяет принимать на этом порту QUIC-соединения. Вместе с параметром quic можно также указать параметр reuseport для правильной работы с несколькими рабочими процессами.

proxy_protocol

указывает на то, что все соединения, принимаемые на данном слушающем сокете, должны использовать протокол PROXY.

В директиве listen можно также указать несколько дополнительных параметров, специфичных для связанных с сокетами системных вызовов. Эти параметры можно задать в любой директиве listen, но только один раз для слушающего сокета.

setfib=число

задаёт таблицу маршрутизации, FIB (параметр SO_SETFIB) для слушающего сокета. В настоящий момент это работает только на FreeBSD.

fastopen=число

включает “TCP Fast Open” для слушающего сокета и ограничивает максимальную длину очереди соединений, которые ещё не завершили процесс three-way handshake.

Осторожно

Не включайте “TCP Fast Open”, не убедившись, что сервер может адекватно обрабатывать многократное получение одного и того же SYN-пакета с данными.

backlog=число

задаёт параметр backlog в вызове listen(), который ограничивает максимальный размер очереди ожидающих приёма соединений. По умолчанию backlog устанавливается равным -1 для FreeBSD, DragonFly BSD и macOS, и 511 для других платформ.

rcvbuf=размер

задаёт размер буфера приёма (параметр SO_RCVBUF) для слушающего сокета.

sndbuf=размер

задаёт размер буфера передачи (параметр SO_SNDBUF) для слушающего сокета.

accept_filter=фильтр

задаёт название accept-фильтра (параметр SO_ACCEPTFILTER) для слушающего сокета, который включается для фильтрации входящих соединений перед передачей их в accept(). Работает только на FreeBSD и NetBSD 5.0+. Можно использовать два фильтра: dataready и httpready.

deferred

указывает использовать отложенный accept() (параметр TCP_DEFER_ACCEPT сокета) на Linux.

bind

указывает, что для данного слушающего сокета нужно делать bind() отдельно. Это нужно потому, что если описаны несколько директив listen с одинаковым портом, но разными адресами, и одна из директив listen слушает на всех адресах для данного порта (*:порт), то Angie сделает bind() только на *:порт. Необходимо заметить, что в этом случае для определения адреса, на который пришло соединение, делается системный вызов getsockname(). Если же используются параметры setfib, fastopen, backlog, rcvbuf, sndbuf, accept_filter, deferred, ipv6only, reuseport или so_keepalive, то для данной пары адрес:порт всегда делается отдельный вызов bind().

ipv6only=on | off

определяет (через параметр сокета IPV6_V6ONLY), будет ли слушающий на wildcard-адресе [::] IPv6-сокет принимать только IPv6-соединения, или же одновременно IPv6- и IPv4-соединения.
По умолчанию параметр включён. Установить его можно только один раз на старте.

reuseport

указывает, что нужно создавать отдельный слушающий сокет для каждого рабочего процесса (через параметр сокета SO_REUSEPORT для Linux 3.9+ и DragonFly BSD или SO_REUSEPORT_LB для FreeBSD 12+), позволяя ядру распределять входящие соединения между рабочими процессами. В настоящий момент это работает только на Linux 3.9+, DragonFly BSD и FreeBSD 12+.

Осторожно

Ненадлежащее использование параметра reuseport может быть небезопасно.

so_keepalive=on | off | [keepidle]:[keepintvl]:[keepcnt]
конфигурирует для слушающего сокета поведение “TCP keepalive”.

''

если параметр опущен, для сокета будут действовать настройки операционной системы

on

для сокета включается параметр SO_KEEPALIVE

off

для сокета параметр SO_KEEPALIVE выключается

Некоторые операционные системы поддерживают настройку параметров “TCP keepalive” на уровне сокета посредством параметров TCP_KEEPIDLE, TCP_KEEPINTVL и TCP_KEEPCNT. На таких системах их можно сконфигурировать с помощью параметров 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#

Синтаксис:

location [ = | ~ | ~* | ^~ ] uri { … }
location @имя { … }

Умолчание:

—

Контекст:

server, location

Устанавливает конфигурацию в зависимости от URI запроса.

Для сопоставления используется URI запроса в нормализованном виде, после декодирования текста, заданного в виде %XX, преобразования относительных элементов пути «.» и «..» в реальные и возможной замены двух и более подряд идущих слэшей на один.

location можно задать префиксной строкой или регулярным выражением.

Регулярные выражения задаются с модификатором:

~*

для поиска совпадения без учёта регистра символов

~

с учётом регистра

Чтобы найти location, соответствующий запросу, вначале проверяются location’ы, заданные префиксными строками (префиксные location’ы). Среди них ищется location с совпадающим префиксом максимальной длины и запоминается. Затем проверяются регулярные выражения, в порядке их следования в конфигурационном файле. Проверка регулярных выражений прекращается после первого же совпадения, и используется соответствующая конфигурация. Если совпадение с регулярным выражением не найдено, то используется конфигурация запомненного ранее префиксного location’а.

Блоки location могут быть вложенными, с некоторыми исключениями, о которых говорится ниже.

Для операционных систем, нечувствительных к регистру символов, таких как macOS и Cygwin, сравнение с префиксными строками производится без учёта регистра. Однако сравнение ограничено только однобайтными locale’ями.

Регулярные выражения могут содержать выделения, которые могут затем использоваться в других директивах.

Если у совпавшего префиксного location’а максимальной длины указан модификатор ^~, то регулярные выражения не проверяются.

Кроме того, с помощью модификатора = можно задать точное совпадение URI и location. При точном совпадении поиск сразу же прекращается. Например, если запрос / случается часто, то указав location = /, можно ускорить обработку этих запросов, так как поиск прекратится после первого же сравнения. Очевидно, что такой location не может иметь вложенные location’ы.

Проиллюстрируем вышесказанное примером:

location = / {
   #конфигурация А
}

location / {
   #конфигурация Б
}

location /documents/ {
   #конфигурация В
}

location ^~ /images/ {
   #конфигурация Г
}

location ~* \.(gif|jpg|jpeg)$ {
   #конфигурация Д
}

Для запроса / будет выбрана конфигурация А,
для запроса /index.html — конфигурация Б,
для запроса /documents/document.html — конфигурация В,
для запроса /images/1.gif — конфигурация Г,
а для запроса /documents/1.jpg — конфигурация Д.

Префикс @ задаёт именованный location. Такой location не используется при обычной обработке запросов, а предназначен только для перенаправления в него запросов. Такие location’ы не могут быть вложенными и не могут содержать вложенные location’ы.

Если location задан префиксной строкой со слэшом в конце и запросы обрабатываются при помощи proxy_pass, fastcgi_pass, uwsgi_pass, scgi_pass, memcached_pass или grpc_pass, происходит специальная обработка. В ответ на запрос с URI равным этой строке, но без завершающего слэша, будет возвращено постоянное перенаправление с кодом 301 на URI с добавленным в конец слэшом. Если такое поведение нежелательно, можно задать точное совпадение URI и location, например:

location /user/ {
  proxy_pass http://user.example.com;
}

location = /user {
  proxy_pass http://login.example.com;
}

log_not_found#

Синтаксис:

log_not_found on | off;

Умолчание:

log_not_found on;

Контекст:

http, server, location

Разрешает или запрещает записывать в error_log ошибки о том, что файл не найден.

log_subrequest#

Синтаксис:

log_subrequest on | off;

Умолчание:

log_subrequest off;

Контекст:

http, server, location

Разрешает или запрещает записывать в access_log подзапросы.

max_ranges#

Синтаксис:

max_ranges число

Умолчание:

—

Контекст:

http, server, location

Ограничивает максимальное допустимое число диапазонов в запросах с указанием диапазона запрашиваемых байт (byte-range requests). Запросы, превышающие указанное ограничение, обрабатываются как если бы они не содержали указания диапазонов. По умолчанию число диапазонов не ограничено.

0

полностью запрещает поддержку диапазонов

merge_slashes#

Синтаксис:

merge_slashes on | off;

Умолчание:

merge_slashes on;

Контекст:

http, server

Разрешает или запрещает преобразование URI путём замены двух и более подряд идущих слэшей (“/”) на один.

Необходимо иметь в виду, что это преобразование необходимо для корректной проверки префиксных строк и регулярных выражений. Если его не делать, то запрос //scripts/one.php не попадёт в

location /scripts/ { }

и может быть обслужен как статический файл. Поэтому он преобразуется к виду /scripts/one.php.

Запрет преобразования может понадобиться, если в URI используются имена, закодированные методом base64, в котором задействован символ “/”. Однако из соображений безопасности лучше избегать отключения преобразования.

Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию.

msie_padding#

Синтаксис:

msie_padding on | off;

Умолчание:

msie_padding on;

Контекст:

http, server, location

Разрешает или запрещает добавлять в ответы для MSIE со статусом больше 400 комментарий для увеличения размера ответа до 512 байт.

msie_refresh#

Синтаксис:

msie_refresh on | off;

Умолчание:

msie_refresh off;

Контекст:

http, server, location

Разрешает или запрещает выдавать для MSIE клиентов refresh’ы вместо перенаправлений.

open_file_cache#

Синтаксис:

open_file_cache off;
open_file_cache max=N [inactive=время];

Умолчание:

open_file_cache off;

Контекст:

http, server, location

Задаёт кэш, в котором могут храниться:

  • дескрипторы открытых файлов, информация об их размерах и времени модификации;

  • информация о существовании каталогов;

  • информация об ошибках поиска файла — “нет файла”, “нет прав на чтение” и тому подобное.

Кэширование ошибок нужно разрешить отдельно директивой open_file_cache_errors.

max

задаёт максимальное число элементов в кэше; при переполнении кэша удаляются наименее востребованные элементы (LRU);

inactive

задаёт время, после которого элемент кэша удаляется, если к нему не было обращений в течение этого времени;
по умолчанию 60 секунд;

off

запрещает кэш.

Пример:

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#

Синтаксис:

open_file_cache_errors on | off;

Умолчание:

open_file_cache_errors off;

Контекст:

http, server, location

Разрешает или запрещает кэширование ошибок поиска файлов в open_file_cache.

open_file_cache_min_uses#

Синтаксис:

open_file_cache_min_uses число;

Умолчание:

open_file_cache_min_uses 1;

Контекст:

http, server, location

Задаёт минимальное число обращений к файлу в течение времени, заданного параметром inactive директивы open_file_cache, необходимых для того, чтобы дескриптор файла оставался открытым в кэше.

open_file_cache_valid#

Синтаксис:

open_file_cache_valid время;

Умолчание:

open_file_cache_valid 60s;

Контекст:

http, server, location

Определяет время, через которое следует проверять актуальность информации об элементе в open_file_cache.

output_buffers#

Синтаксис:

output_buffers число размер;

Умолчание:

output_buffers 2 32k;

Контекст:

http, server, location

Задаёт число и размер буферов, используемых при чтении ответа с диска.

port_in_redirect#

Синтаксис:

port_in_redirect on | off;

Умолчание:

port_in_redirect on;

Контекст:

http, server, location

Разрешает или запрещает указывать порт в абсолютных перенаправлениях, выдаваемых Angie.

Использование в перенаправлениях основного имени сервера управляется директивой server_name_in_redirect.

postpone_output#

Синтаксис:

postpone_output размер;

Умолчание:

postpone_output 1460;

Контекст:

http, server, location

Если это возможно, то отправка данных клиенту будет отложена пока Angie не накопит по крайней мере указанное количество байт для отправки.

0

запрещает отложенную отправку данных

read_ahead#

Синтаксис:

read_ahead размер;

Умолчание:

read_ahead 0;

Контекст:

http, server, location

Задаёт ядру размер предчтения при работе с файлами.

На Linux используется системный вызов posix_fadvise(0, 0, 0, POSIX_FADV_SEQUENTIAL), поэтому параметр размер там игнорируется.

На FreeBSD используется системный вызов fcntl(O_READAHEAD, размер ), появившийся во FreeBSD 9.0-CURRENT.

recursive_error_pages#

Синтаксис:

recursive_error_pages on | off;

Умолчание:

recursive_error_pages off;

Контекст:

http, server, location

Разрешает или запрещает делать несколько перенаправлений через директиву error_page. Число таких перенаправлений ограничено.

request_pool_size#

Синтаксис:

request_pool_size размер;

Умолчание:

request_pool_size 4k;

Контекст:

http, server

Позволяет производить точную настройку выделений памяти под конкретные запросы. Эта директива не оказывает существенного влияния на производительность, и её не следует использовать.

reset_timedout_connection#

Синтаксис:

reset_timedout_connection on | off;

Умолчание:

reset_timedout_connection off;

Контекст:

http, server, location

Разрешает или запрещает сброс соединений по таймауту, а также при закрытии соединений с помощью нестандартного кода 444. Сброс делается следующим образом. Перед закрытием сокета для него задаётся параметр SO_LINGER с таймаутом 0. После этого при закрытии сокета клиенту отсылается TCP RST, а вся память, связанная с этим сокетом, освобождается. Это позволяет избежать длительного нахождения уже закрытого сокета в состоянии FIN_WAIT1 с заполненными буферами.

Примечание

keep-alive соединения по истечении таймаута закрываются обычным образом.

resolver#

Синтаксис:

resolver адрес … [valid=время] [ipv4=on|off] [ipv6=on|off] [status_zone=зона];

Умолчание:

—

Контекст:

http, server, location

Задаёт серверы DNS, используемые для преобразования имён вышестоящих серверов в адреса, например:

resolver 127.0.0.53 [::1]:5353;

Адрес может быть указан в виде доменного имени или IP-адреса, и необязательного порта. Если порт не указан, используется порт 53. Серверы DNS опрашиваются циклически.

По умолчанию Angie кэширует ответы, используя значение TTL из ответа.

valid

необязательный параметр, позволяет переопределить срок кэширования ответа

 
resolver 127.0.0.53 [::1]:5353 valid=30s;

По умолчанию Angie будет искать как IPv4-, так и IPv6-адреса при преобразовании имён в адреса.

ipv4=off

запрещает поиск IPv4-адресов

ipv6=off

запрещает поиск IPv6-адресов

Добавлено в версии 1.0.0.

status_zone

необязательный параметр, включает сбор информации о запросах и ответах сервера DNS в указанной зоне

Совет

Для предотвращения DNS-спуфинга рекомендуется использовать DNS-серверы в защищённой доверенной локальной сети.

resolver_timeout#

Синтаксис:

resolver_timeout время;

Умолчание:

resolver_timeout 30s;

Контекст:

http, server, location

Задаёт таймаут для преобразования имени в адрес, например:

resolver_timeout 5s;

root#

Синтаксис:

root путь;

Умолчание:

root html;

Контекст:

http, server, location, if в location

Задаёт корневой каталог для запросов. Например, при такой конфигурации

location /i/ {
  root /data/w3;
}

в ответ на запрос /i/top.gif будет отдан файл /data/w3/i/top.gif.

В значении параметра путь можно использовать переменные, кроме $document_root и $realpath_root.

Путь к файлу формируется путём простого добавления URI к значению директивы root. Если же URI необходимо поменять, следует воспользоваться директивой alias.

satisfy#

Синтаксис:

satisfy all | any;

Умолчание:

satisfy all;

Контекст:

http, server, location

Разрешает доступ, если все (all) или хотя бы один (any) из модулей http_access, http_auth_basic или http_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#

Синтаксис:

send_lowat размер;

Умолчание:

send_lowat 0;

Контекст:

http, server, location

При установке этой директивы в ненулевое значение Angie будет пытаться минимизировать число операций отправки на клиентских сокетах либо при помощи флага NOTE_LOWAT метода kqueue, либо при помощи параметра сокета SO_SNDLOWAT. В обоих случаях будет использован указанный размер.

send_timeout#

Синтаксис:

send_timeout время;

Умолчание:

send_timeout 60s;

Контекст:

http, server, location

Задаёт таймаут при передаче ответа клиенту. Таймаут устанавливается не на всю передачу ответа, а только между двумя операциями записи. Если по истечении этого времени клиент ничего не примет, соединение будет закрыто.

sendfile#

Синтаксис:

sendfile on | off;

Умолчание:

sendfile off;

Контекст:

http, server, location, if в location

Разрешает или запрещает использовать 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_max_chunk размер;

Умолчание:

sendfile_max_chunk 2m;

Контекст:

http, server, location

Ограничивает объём данных, который может передан за один вызов sendfile(). Без этого ограничения одно быстрое соединение может целиком захватить рабочий процесс.

server#

Синтаксис:

server { … }

Умолчание:

—

Контекст:

http

Задаёт конфигурацию для виртуального сервера. Чёткого разделения виртуальных серверов на IP-based (на основании IP-адреса) и name-based (на основании поля “Host” заголовка запроса) нет. Вместо этого директивами listen описываются все адреса и порты, на которых нужно принимать соединения для этого сервера, а в директиве server_name указываются все имена серверов.

Подробнее: Как обрабатываются запросы

server_name#

Синтаксис:

server_name имя …;

Умолчание:

server_name "";

Контекст:

server

Задаёт имена виртуального сервера, например:

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, то подставляется имя хоста (hostname) машины.

При поиске виртуального сервера по имени, если имени соответствует несколько из указанных вариантов, например, одновременно подходят и имя с маской, и регулярное выражение, будет выбран первый подходящий вариант в следующем порядке приоритета:

  • точное имя

  • самое длинное имя с маской в начале, например “*.example.com”

  • самое длинное имя с маской в конце, например “mail.*”

  • первое подходящее регулярное выражение (в порядке следования в конфигурационном файле)

server_name_in_redirect#

Синтаксис:

server_name_in_redirect on | off;

Умолчание:

server_name_in_redirect off;

Контекст:

http, server, location

Разрешает или запрещает использовать в абсолютных перенаправлениях, выдаваемых Angie, основное имя сервера, задаваемое директивой server_name.

on

используется основное имя сервера, задаваемое директивой server_name

off

используется имя, указанное в поле “Host” заголовка запроса. Если же этого поля нет, то используется IP-адрес сервера.

Использование в перенаправлениях порта управляется директивой port_in_redirect.

server_names_hash_bucket_size#

Синтаксис:

server_names_hash_bucket_size размер;

Умолчание:

server_names_hash_bucket_size 32 | 64 | 128;

Контекст:

http

Задаёт размер корзины в хэш-таблицах имён серверов. Значение по умолчанию зависит от размера строки кэша процессора. Подробнее настройка хэш-таблиц обсуждается отдельно.

server_names_hash_max_size#

Синтаксис:

server_names_hash_max_size размер;

Умолчание:

server_names_hash_max_size 512;

Контекст:

http

Задаёт максимальный размер хэш-таблиц имён серверов. Подробнее настройка хэш-таблиц обсуждается отдельно.

server_tokens#

Синтаксис:

server_tokens on | off | build | строка;

Умолчание:

server_tokens on;

Контекст:

http, server, location

Разрешает или запрещает выдавать версию Angie на страницах ошибок и в поле “Server” заголовка ответа.

Если указан параметр build, то наряду с версией Angie будет также выдаваться имя сборки.

Добавлено в версии 1.1.0.

С помощью параметра строка подписи на страницах ошибок и значение поля “Server” заголовка ответа можно задать явно строкой с переменными. Пустая строка запрещает выдачу поля “Server”.

status_zone#

Добавлено в версии 1.0.0.

Синтаксис:

status_zone зона;

Умолчание:

—

Конеткст:

server, location, if в location

Указанная в любом из допустимых контекстов конфигурации, директива включает выделение зоны в разделяемой памяти для сбора метрик, соответствующих контексту. Несколько server могут разделять одну зону для сбора данных.

subrequest_output_buffer_size#

Синтаксис:

subrequest_output_buffer_size размер;

Умолчание:

subrequest_output_buffer_size 4k | 8k;

Контекст:

http, server, location

Задаёт размер буфера, используемого для хранения тела ответа подзапроса. По умолчанию размер одного буфера равен размеру страницы памяти. В зависимости от платформы это или 4K, или 8K, однако его можно сделать меньше.

Примечание

Директива применима только для подзапросов, тело ответа которых сохраняется в памяти. Например, подобные подзапросы создаются при помощи SSI.

tcp_nodelay#

Синтаксис:

tcp_nodelay on | off;

Умолчание:

tcp_nodelay on;

Контекст:

http, server, location

Разрешает или запрещает использование параметра TCP_NODELAY. Параметр включается при переходе соединения в состояние keep-alive. Также, он включается на SSL-соединениях, при небуферизованном проксировании и при проксировании WebSocket.

tcp_nopush#

Синтаксис:

tcp_nopush on | off;

Умолчание:

tcp_nopush off;

Контекст:

http, server, location

Разрешает или запрещает использование параметра сокета TCP_NOPUSH во FreeBSD или TCP_CORK в Linux. Параметр включаются только при использовании sendfile. Включение параметра позволяет

  • передавать заголовок ответа и начало файла в одном пакете в Linux и во FreeBSD 4.*;

  • передавать файл полными пакетами.

try_files#

Синтаксис:

try_files файл … uri;
try_files файл … =код;

Умолчание:

—

Контекст:

server, location

Проверяет существование файлов в заданном порядке и использует для обработки запроса первый найденный файл, причём обработка делается в контексте этого же location’а. Путь к файлу строится из параметра файл в соответствии с директивами root и alias. С помощью слэша в конце имени можно проверить существование каталога, например, $uri/. В случае, если ни один файл не найден, то делается внутреннее перенаправление на uri, заданный последним параметром. Например:

location /images/ {
  try_files $uri /images/default.gif;
}

location = /images/default.gif {
  expires 30s;
}

Последний параметр может также указывать на именованный location, может также быть кодом:

location / {
  try_files $uri $uri/index.html $uri.html =404;
}

В следующем примере директива try_files

location / {
  try_files $uri $uri/ @drupal;
}

аналогична директивам

location / {
  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-серверу.

Пример использования при проксировании Mongrel:
location / {
  try_files /system/maintenance.html
           $uri $uri/index.html $uri.html
           @mongrel;
}

location @mongrel {
  proxy_pass http://mongrel;
}
Пример использования вместе с Drupal/FastCGI:
location / {
  try_files $uri $uri/ @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 / {
  try_files $uri $uri/ @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#

Синтаксис:

types { … }

Умолчание:

types { text/html html; image/gif gif; image/jpeg jpg; }

Контекст:

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#

Синтаксис:

types_hash_bucket_size размер;

Умолчание:

types_hash_bucket_size 64;

Контекст:

http, server, location

Задаёт размер корзины в хэш-таблицах типов. Подробнее настройка хэш-таблиц обсуждается отдельно.

types_hash_max_size#

Синтаксис:

types_hash_max_size размер;

Умолчание:

types_hash_max_size 1024;

Контекст:

http, server, location

Задаёт максимальный размер хэш-таблиц типов. Подробнее настройка хэш-таблиц обсуждается отдельно.

underscores_in_headers#

Синтаксис:

underscores_in_headers on | off;

Умолчание:

underscores_in_headers off;

Контекст:

http, server

Разрешает или запрещает использование символов подчёркивания в полях заголовка запроса клиента. Если использование символов подчёркивания запрещено, поля заголовка запроса, в именах которых есть подчёркивания, помечаются как недопустимые и подпадают под действие директивы ignore_invalid_headers.

Если директива указана на уровне server, то может использоваться значение из сервера по умолчанию.

variables_hash_bucket_size#

Синтаксис:

variables_hash_bucket_size размер;

Умолчание:

variables_hash_bucket_size 64;

Контекст:

http

Задаёт размер корзины в хэш-таблице переменных. Подробнее настройка хэш-таблиц обсуждается отдельно.

variables_hash_max_size#

Синтаксис:

variables_hash_max_size размер;

Умолчание:

variables_hash_max_size 1024;

Контекст:

http

Задаёт максимальный размер хэш-таблиц переменных. Подробнее настройка хэш-таблиц обсуждается отдельно.

Встроенные переменные#

Модуль 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#

значение директивы root или alias для текущего запроса

$document_uri#

то же, что и $uri

$host#

в порядке приоритета: имя хоста из строки запроса, или имя хоста из поля “Host” заголовка запроса, или имя сервера, соответствующего запросу

$hostname#

имя хоста

$http_ имя#

произвольное поле заголовка запроса; последняя часть имени переменной соответствует имени поля, приведённому к нижнему регистру, с заменой символов тире на символы подчёркивания

$https#

on если соединение работает в режиме SSL, либо пустая строка

$is_args#

?, если в строке запроса есть аргументы, и пустая строка, если их нет

$limit_rate#

установка этой переменной позволяет ограничивать скорость передачи ответа, см. limit_rate

$msec#

текущее время в секундах с точностью до миллисекунд

$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_time#

время обработки запроса в секундах с точностью до миллисекунд; время, прошедшее с момента чтения первых байт от клиента

$request_uri#

первоначальный URI запроса целиком (с аргументами)

$scheme#

схема запроса, “http” или “https”

$sent_http_ имя#

произвольное поле заголовка ответа; последняя часть имени переменной соответствует имени поля, приведённому к нижнему регистру, с заменой символов тире на символы подчёркивания

$sent_trailer_ имя#

произвольное поле, отправленное в конце ответа; последняя часть имени переменной соответствует имени поля, приведённому к нижнему регистру, с заменой символов тире на символы подчёркивания

$server_addr#

адрес сервера, принявшего запрос
Получение значения этой переменной обычно требует одного системного вызова. Чтобы избежать системного вызова, в директивах listen следует указывать адреса и использовать параметр bind.

$server_name#

имя сервера, принявшего запрос

$server_port#

порт сервера, принявшего запрос

$server_protocol#

протокол запроса, обычно “HTTP/1.0”, “HTTP/1.1” или “HTTP/2.0”

$status#

статус ответа

$time_iso8601#

локальное время в формате по стандарту ISO 8601

$time_local#

локальное время в Common Log Format

$tcpinfo_rtt, $tcpinfo_rttvar, $tcpinfo_snd_cwnd, $tcpinfo_rcv_space#

информация о клиентском TCP-соединении; доступна на системах, поддерживающих параметр сокета TCP_INFO

$uri#

текущий URI запроса в нормализованном виде
Значение $uri может изменяться в процессе обработки запроса, например, при внутренних перенаправлениях или при использовании индексных файлов.