Модуль ngx_http_scgi_module

Модуль ngx_http_scgi_module позволяет передавать запросы SCGI-серверу.

location / {
    include   scgi_params;
    scgi_pass localhost:9000;
}

Задаёт локальный IP-адрес с необязательным портом (1.11.2), который будет использоваться в исходящих соединениях с SCGI-сервером. В значении параметра допустимо использование переменных (1.3.12). Специальное значение off (1.3.12) отменяет действие унаследованной с предыдущего уровня конфигурации директивы scgi_bind, позволяя системе самостоятельно выбирать локальный IP-адрес и порт.

Параметр transparent (1.11.0) позволяет задать нелокальный IP-aдрес, который будет использоваться в исходящих соединениях с SCGI-сервером, например, реальный IP-адрес клиента:

scgi_bind $remote_addr transparent;

Для работы параметра обычно требуется запустить рабочие процессы nginx с привилегиями суперпользователя. В Linux этого не требуется (1.13.8), так как если указан параметр transparent, то рабочие процессы наследуют capability CAP_NET_RAW из главного процесса. Также необходимо настроить таблицу маршрутизации ядра для перехвата сетевого трафика с SCGI-сервера.

scgi_buffer_size 4k|8k;

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

scgi_buffering on;

Разрешает или запрещает использовать буферизацию ответов SCGI-сервера.

Если буферизация включена, то nginx принимает ответ SCGI-сервера как можно быстрее, сохраняя его в буферы, заданные директивами scgi_buffer_size и scgi_buffers. Если ответ не вмещается целиком в память, то его часть может быть записана на диск во временный файл. Запись во временные файлы контролируется директивами scgi_max_temp_file_size и scgi_temp_file_write_size.

Если буферизация выключена, то ответ синхронно передаётся клиенту сразу же по мере его поступления. nginx не пытается считать весь ответ SCGI-сервера. Максимальный размер данных, который nginx может принять от сервера за один раз, задаётся директивой scgi_buffer_size.

Буферизация может быть также включена или выключена путём передачи значения “yes” или “no” в поле “X-Accel-Buffering” заголовка ответа. Эту возможность можно запретить с помощью директивы scgi_ignore_headers.

scgi_buffers 8 4k|8k;

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

scgi_busy_buffers_size 8k|16k;

При включённой буферизации ответов SCGI-сервера, ограничивает суммарный размер буферов, которые могут быть заняты для отправки ответа клиенту, пока ответ ещё не прочитан целиком. Оставшиеся буферы тем временем могут использоваться для чтения ответа и, при необходимости, буферизации части ответа во временный файл. По умолчанию размер ограничен двумя буферами, заданными директивами scgi_buffer_size и scgi_buffers.

scgi_cache off;

Задаёт зону разделяемой памяти, используемой для кэширования. Одна и та же зона может использоваться в нескольких местах. В значении параметра можно использовать переменные (1.7.9). Параметр off запрещает кэширование, унаследованное с предыдущего уровня конфигурации.

scgi_cache_background_update off;

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

Задаёт условия, при которых ответ не будет браться из кэша. Если значение хотя бы одного из строковых параметров непустое и не равно “0”, то ответ не берётся из кэша:

scgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
scgi_cache_bypass $http_pragma    $http_authorization;

Можно использовать совместно с директивой scgi_no_cache.

Задаёт ключ для кэширования, например,

scgi_cache_key localhost:9000$request_uri;

scgi_cache_lock off;

Если включено, одновременно только одному запросу будет позволено заполнить новый элемент кэша, идентифицируемый согласно директиве scgi_cache_key, передав запрос на SCGI-сервер. Остальные запросы этого же элемента будут либо ожидать появления ответа в кэше, либо освобождения блокировки этого элемента, в течение времени, заданного директивой scgi_cache_lock_timeout.

scgi_cache_lock_age 5s;

Если последний запрос, переданный на SCGI-сервер для заполнения нового элемента кэша, не завершился за указанное время, на SCGI-сервер может быть передан ещё один запрос.

scgi_cache_lock_timeout 5s;

Задаёт таймаут для scgi_cache_lock. По истечении указанного времени запрос будет передан на SCGI-сервер, однако ответ не будет закэширован.

До версии 1.7.8 такой ответ мог быть закэширован.

Задаёт смещение в байтах для запросов с указанием диапазона запрашиваемых байт (byte-range requests). Если диапазон находится за указанным смещением, range-запрос будет передан на SCGI-сервер и ответ не будет закэширован.

scgi_cache_methods GET HEAD;

Если метод запроса клиента указан в этой директиве, то ответ будет закэширован. Методы “GET” и “HEAD” всегда добавляются в список, но тем не менее рекомендуется перечислять их явно. См. также директиву scgi_no_cache.

scgi_cache_min_uses 1;

Задаёт число запросов, после которого ответ будет закэширован.

Задаёт путь и другие параметры кэша. Данные кэша хранятся в файлах. Именем файла в кэше является результат функции MD5 от ключа кэширования. Параметр levels задаёт уровни иерархии кэша: можно задать от 1 до 3 уровней, на каждом уровне допускаются значения 1 или 2. Например, при использовании

scgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m;

имена файлов в кэше будут такого вида:

/data/nginx/cache/c/29/b7f54b2df7773722d382f4809d65029c

Кэшируемый ответ сначала записывается во временный файл, а потом этот файл переименовывается. Начиная с версии 0.8.9 временные файлы и кэш могут располагаться на разных файловых системах. Однако нужно учитывать, что в этом случае вместо дешёвой операции переименовывания в пределах одной файловой системы файл копируется с одной файловой системы на другую. Поэтому лучше, если кэш будет находиться на той же файловой системе, что и каталог с временными файлами. Какой из каталогов будет использоваться для временных файлов определяется параметром use_temp_path (1.7.10). Если параметр не задан или установлен в значение “on”, то будет использоваться каталог, задаваемый директивой scgi_temp_path для данного location. Если параметр установлен в значение “off”, то временные файлы будут располагаться непосредственно в каталоге кэша.

Кроме того, все активные ключи и информация о данных хранятся в зоне разделяемой памяти, имя и размер которой задаются параметром keys_zone. Зоны размером в 1 мегабайт достаточно для хранения около 8 тысяч ключей.

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

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

Специальный процесс “cache manager” следит за максимальным размером кэша, заданным параметром max_size, а также за минимальным объёмом свободного места на файловой системе с кэшем, заданным параметром min_free (1.19.1). При превышении максимального размера кэша или недостаточном объёме свободного места процесс удаляет наименее востребованные данные. Удаление данных происходит итерациями, настраиваемыми параметрами (1.11.5) manager_files, manager_threshold и manager_sleep. За одну итерацию загружается не более manager_files элементов (по умолчанию 100). Время работы одной итерации ограничено параметром manager_threshold (по умолчанию 200 миллисекунд). Между итерациями делается пауза на время, заданное параметром manager_sleep (по умолчанию 50 миллисекунд).

Через минуту после старта активируется специальный процесс “cache loader”, который загружает в зону кэша информацию о ранее закэшированных данных, хранящихся на файловой системе. Загрузка также происходит итерациями. За одну итерацию загружается не более loader_files элементов (по умолчанию 100). Кроме того, время работы одной итерации ограничено параметром loader_threshold (по умолчанию 200 миллисекунд). Между итерациями делается пауза на время, заданное параметром loader_sleep (по умолчанию 50 миллисекунд).

Кроме того, следующие параметры доступны как часть коммерческой подписки:

purger=on|off

Указывает, будут ли записи в кэше, соответствующие маске, удалены с диска при помощи процесса “cache purger” (1.7.12). Установка параметра в значение on (по умолчанию off) активирует процесс “cache purger”, который проходит по всем записям в кэше и удаляет записи, соответствующие этой маске.

purger_files=число

Задаёт число элементов, которые будут сканироваться за одну итерацию (1.7.12). По умолчанию purger_files равен 10.

purger_threshold=время

Задаёт продолжительность одной итерации (1.7.12). По умолчанию purger_threshold равен 50 миллисекундам.

purger_sleep=время

Задаёт паузу между итерациями (1.7.12). По умолчанию purger_sleep равен 50 миллисекундам.

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

Задаёт условия, при которых запрос будет считаться запросом на очистку кэша. Если значение хотя бы одного из строковых параметров непустое и не равно “0”, то запись в кэше с соответствующим ключом кэширования удаляется. В результате успешной операции возвращается ответ с кодом 204 (No Content).

Если ключ кэширования запроса на очистку заканчивается звёздочкой (“*”), то все записи в кэше, соответствующие этой маске, будут удалены из кэша. Тем не менее, эти записи будут оставаться на диске или до момента удаления из-за отсутствия обращения к данным, или до обработки их процессом “cache purger” (1.7.12), или до попытки клиента получить к ним доступ.

Пример конфигурации:

scgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m;

map $request_method $purge_method {
    PURGE   1;
    default 0;
}

server {
    ...
    location / {
        scgi_pass        http://backend;
        scgi_cache       cache_zone;
        scgi_cache_key   $uri;
        scgi_cache_purge $purge_method;
    }
}

Функциональность доступна как часть коммерческой подписки.

scgi_cache_revalidate off;

Разрешает ревалидацию просроченных элементов кэша при помощи условных запросов с полями заголовка “If-Modified-Since” и “If-None-Match”.

scgi_cache_use_stale off;

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

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

Кроме того, дополнительный параметр updating разрешает использовать устаревший закэшированный ответ, если на данный момент он уже обновляется. Это позволяет минимизировать число обращений к SCGI-серверам при обновлении закэшированных данных.

Использование устаревшего закэшированного ответа может также быть разрешено непосредственно в заголовке ответа на определённое количество секунд после того, как ответ устарел (1.11.10). Такой способ менее приоритетен, чем задание параметров директивы.

• Расширение “stale-while-revalidate” поля заголовка “Cache-Control” разрешает использовать устаревший закэшированный ответ, если на данный момент он уже обновляется.
• Расширение “stale-if-error” поля заголовка “Cache-Control” разрешает использовать устаревший закэшированный ответ в случае ошибки.

Чтобы минимизировать число обращений к SCGI-серверам при заполнении нового элемента кэша, можно воспользоваться директивой scgi_cache_lock.

Задаёт время кэширования для разных кодов ответа. Например, директивы

scgi_cache_valid 200 302 10m;
scgi_cache_valid 404      1m;

задают время кэширования 10 минут для ответов с кодами 200 и 302 и 1 минуту для ответов с кодом 404.

Если указано только время кэширования,

scgi_cache_valid 5m;

то кэшируются только ответы 200, 301 и 302.

Кроме того, можно кэшировать любые ответы с помощью параметра any:

scgi_cache_valid 200 302 10m;
scgi_cache_valid 301      1h;
scgi_cache_valid any      1m;

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

• Поле заголовка “X-Accel-Expires” задаёт время кэширования ответа в секундах. Значение 0 запрещает кэшировать ответ. Если значение начинается с префикса @, оно задаёт абсолютное время в секундах с начала эпохи, до которого ответ может быть закэширован.
• Если в заголовке нет поля “X-Accel-Expires”, параметры кэширования определяются по полям заголовка “Expires” или “Cache-Control”.
• Ответ, в заголовке которого есть поле “Set-Cookie”, не будет кэшироваться.
• Ответ, в заголовке которого есть поле “Vary” со специальным значением “*”, не будет кэшироваться (1.7.7). Ответ, в заголовке которого есть поле “Vary” с другим значением, будет закэширован с учётом соответствующих полей заголовка запроса (1.7.7).

Обработка одного или более из этих полей заголовка может быть отключена при помощи директивы scgi_ignore_headers.

scgi_connect_timeout 60s;

Задаёт таймаут для установления соединения с SCGI-сервером. Необходимо иметь в виду, что этот таймаут обычно не может превышать 75 секунд.

scgi_force_ranges off;

Включает поддержку диапазонов запрашиваемых байт (byte-range) для кэшированных и некэшированных ответов SCGI-сервера вне зависимости от наличия поля “Accept-Ranges” в заголовках этих ответов.

По умолчанию nginx не передаёт клиенту поля заголовка “Status” и “X-Accel-...” из ответа SCGI-сервера. Директива scgi_hide_header задаёт дополнительные поля, которые не будут передаваться. Если же передачу полей нужно разрешить, можно воспользоваться директивой scgi_pass_header.

scgi_ignore_client_abort off;

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

Запрещает обработку некоторых полей заголовка из ответа SCGI-сервера. В директиве можно указать поля “X-Accel-Redirect”, “X-Accel-Expires”, “X-Accel-Limit-Rate” (1.1.6), “X-Accel-Buffering” (1.1.6), “X-Accel-Charset” (1.1.6), “Expires”, “Cache-Control”, “Set-Cookie” (0.8.44) и “Vary” (1.7.7).

Если не запрещено, обработка этих полей заголовка заключается в следующем:

• “X-Accel-Expires”, “Expires”, “Cache-Control”, “Set-Cookie” и “Vary” задают параметры кэширования ответа;
• “X-Accel-Redirect” производит внутреннее перенаправление на указанный URI;
• “X-Accel-Limit-Rate” задаёт ограничение скорости передачи ответа клиенту;
• “X-Accel-Buffering” включает или выключает буферизацию ответа;
• “X-Accel-Charset” задаёт желаемую кодировку ответа.

scgi_intercept_errors off;

Определяет, передавать ли клиенту ответы SCGI-сервера с кодом больше либо равным 300, или же перехватывать их и перенаправлять на обработку nginx’у с помощью директивы error_page.

scgi_limit_rate 0;

Ограничивает скорость чтения ответа от SCGI-сервера. Скорость задаётся в байтах в секунду. Значение 0 отключает ограничение скорости. Ограничение устанавливается на запрос, поэтому, если nginx одновременно откроет два соединения к SCGI-серверу, суммарная скорость будет вдвое выше заданного ограничения. Ограничение работает только в случае, если включена буферизация ответов SCGI-сервера.

scgi_max_temp_file_size 1024m;

Если включена буферизация ответов SCGI-сервера, и ответ не вмещается целиком в буферы, заданные директивами scgi_buffer_size и scgi_buffers, часть ответа может быть записана во временный файл. Эта директива задаёт максимальный размер временного файла. Размер данных, сбрасываемых во временный файл за один раз, задаётся директивой scgi_temp_file_write_size.

Значение 0 отключает возможность буферизации ответов во временные файлы.

Данное ограничение не распространяется на ответы, которые будут закэшированы или сохранены на диске.

scgi_next_upstream error timeout;

Определяет, в каких случаях запрос будет передан следующему серверу:

error

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

timeout

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

invalid_header

сервер вернул пустой или неверный ответ;

http_500

сервер вернул ответ с кодом 500;

http_503

сервер вернул ответ с кодом 503;

http_403

сервер вернул ответ с кодом 403;

http_404

сервер вернул ответ с кодом 404;

http_429

сервер вернул ответ с кодом 429 (1.11.13);

non_idempotent

обычно запросы с неидемпотентным методом (POST, LOCK, PATCH) не передаются на другой сервер, если запрос серверу группы уже был отправлен (1.9.13); включение параметра явно разрешает повторять подобные запросы;

off

запрещает передачу запроса следующему серверу.

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

Директива также определяет, что считается неудачной попыткой работы с сервером. Случаи error, timeout и invalid_header всегда считаются неудачными попытками, даже если они не указаны в директиве. Случаи http_500, http_503 и http_429 считаются неудачными попытками, только если они указаны в директиве. Случаи http_403 и http_404 никогда не считаются неудачными попытками.

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

scgi_next_upstream_timeout 0;

Ограничивает время, в течение которого возможна передача запроса следующему серверу. Значение 0 отключает это ограничение.

scgi_next_upstream_tries 0;

Ограничивает число допустимых попыток для передачи запроса следующему серверу. Значение 0 отключает это ограничение.

Задаёт условия, при которых ответ не будет сохраняться в кэш. Если значение хотя бы одного из строковых параметров непустое и не равно “0”, то ответ не будет сохранён:

scgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
scgi_no_cache $http_pragma    $http_authorization;

Можно использовать совместно с директивой scgi_cache_bypass.

Задаёт параметр, который будет передаваться SCGI-серверу. В качестве значения можно использовать текст, переменные и их комбинации. Директивы наследуются с предыдущего уровня конфигурации при условии, что на данном уровне не описаны свои директивы scgi_param.

Стандартные переменные окружения CGI должны передаваться как заголовки SCGI, см. файл scgi_params из дистрибутива:

location / {
    include scgi_params;
    ...
}

Если директива указана с if_not_empty (1.1.11), то такой параметр с пустым значением передаваться на сервер не будет:

scgi_param HTTPS $https if_not_empty;

Задаёт адрес SCGI-сервера. Адрес может быть указан в виде доменного имени или IP-адреса, и порта:

scgi_pass localhost:9000;

или в виде пути UNIX-сокета:

scgi_pass unix:/tmp/scgi.socket;

Если доменному имени соответствует несколько адресов, то все они будут использоваться по очереди (round-robin). И, кроме того, адрес может быть группой серверов.

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

Разрешает передавать от SCGI-сервера клиенту запрещённые для передачи поля заголовка.

scgi_pass_request_body on;

Позволяет запретить передачу исходного тела запроса на SCGI-сервер. См. также директиву scgi_pass_request_headers.

scgi_pass_request_headers on;

Позволяет запретить передачу полей заголовка исходного запроса на SCGI-сервер. См. также директивы scgi_pass_request_body.

scgi_read_timeout 60s;

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

scgi_request_buffering on;

Разрешает или запрещает использовать буферизацию тела запроса клиента.

Если буферизация включена, то тело запроса полностью читается от клиента перед отправкой запроса на SCGI-сервер.

Если буферизация выключена, то тело запроса отправляется на SCGI-сервер сразу же по мере его поступления. В этом случае запрос не может быть передан следующему серверу, если nginx уже начал отправку тела запроса.

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

scgi_send_timeout 60s;

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

scgi_socket_keepalive off;

Конфигурирует поведение “TCP keepalive” для исходящих соединений к SCGI-серверу. По умолчанию для сокета действуют настройки операционной системы. Если указано значение “on”, то для сокета включается параметр SO_KEEPALIVE.

scgi_store off;

Разрешает сохранение на диск файлов. Параметр on сохраняет файлы в соответствии с путями, указанными в директивах alias или root. Параметр off запрещает сохранение файлов. Кроме того, имя файла можно задать явно с помощью строки с переменными:

scgi_store /data/www$original_uri;

Время изменения файлов выставляется согласно полученному полю “Last-Modified” в заголовке ответа. Ответ сначала записывается во временный файл, а потом этот файл переименовывается. Начиная с версии 0.8.9 временный файл и постоянное место хранения ответа могут располагаться на разных файловых системах. Однако нужно учитывать, что в этом случае вместо дешёвой операции переименовывания в пределах одной файловой системы файл копируется с одной файловой системы на другую. Поэтому лучше, если сохраняемые файлы будут находиться на той же файловой системе, что и каталог с временными файлами, задаваемый директивой scgi_temp_path для данного location.

Директиву можно использовать для создания локальных копий статических неизменяемых файлов, например, так:

location /images/ {
    root              /data/www;
    error_page        404 = /fetch$uri;
}

location /fetch/ {
    internal;

    scgi_pass         backend:9000;
    ...

    scgi_store        on;
    scgi_store_access user:rw group:rw all:r;
    scgi_temp_path    /data/temp;

    alias             /data/www/;
}

scgi_store_access user:rw;

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

scgi_store_access user:rw group:rw all:r;

Если заданы какие-либо права для group или all, то права для user указывать необязательно:

scgi_store_access group:rw all:r;

scgi_temp_file_write_size 8k|16k;

Ограничивает размер данных, сбрасываемых во временный файл за один раз, при включённой буферизации ответов SCGI-сервера во временные файлы. По умолчанию размер ограничен двумя буферами, заданными директивами scgi_buffer_size и scgi_buffers. Максимальный размер временного файла задаётся директивой scgi_max_temp_file_size.

scgi_temp_path scgi_temp;

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

scgi_temp_path /spool/nginx/scgi_temp 1 2;

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

/spool/nginx/scgi_temp/7/45/00000123457

См. также параметр use_temp_path директивы scgi_cache_path.