Модуль ngx_http_scgi_module

Разделы

Пример конфигурации
Директивы
     scgi_bind
     scgi_buffer_size
     scgi_buffering
     scgi_buffers
     scgi_busy_buffers_size
     scgi_cache
     scgi_cache_bypass
     scgi_cache_key
     scgi_cache_lock
     scgi_cache_lock_timeout
     scgi_cache_methods
     scgi_cache_min_uses
     scgi_cache_path
     scgi_cache_purge
     scgi_cache_revalidate
     scgi_cache_use_stale
     scgi_cache_valid
     scgi_connect_timeout
     scgi_hide_header
     scgi_ignore_client_abort
     scgi_ignore_headers
     scgi_intercept_errors
     scgi_max_temp_file_size
     scgi_next_upstream
     scgi_no_cache
     scgi_param
     scgi_pass
     scgi_pass_header
     scgi_read_timeout
     scgi_pass_request_body
     scgi_pass_request_headers
     scgi_send_timeout
     scgi_store
     scgi_store_access
     scgi_temp_file_write_size
     scgi_temp_path

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

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

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

Директивы

синтаксис: scgi_bind адрес | off;
умолчание:
контекст: http, server, location

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

синтаксис: scgi_buffer_size размер;
умолчание:
scgi_buffer_size 4k|8k;
контекст: http, server, location

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

синтаксис: scgi_buffering on | off;
умолчание:
scgi_buffering on;
контекст: http, server, location

Разрешает или запрещает использовать буферизацию ответов 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 число размер;
умолчание:
scgi_buffers 8 4k|8k;
контекст: http, server, location

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

синтаксис: scgi_busy_buffers_size размер;
умолчание:
scgi_busy_buffers_size 8k|16k;
контекст: http, server, location

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

синтаксис: scgi_cache зона | off;
умолчание:
scgi_cache off;
контекст: http, server, location

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

синтаксис: scgi_cache_bypass строка ...;
умолчание:
контекст: http, server, location

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

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

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

синтаксис: scgi_cache_key строка;
умолчание:
контекст: http, server, location

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

scgi_cache_key localhost:9000$request_uri;

синтаксис: scgi_cache_lock on | off;
умолчание:
scgi_cache_lock off;
контекст: http, server, location

Эта директива появилась в версии 1.1.12.

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

синтаксис: scgi_cache_lock_timeout время;
умолчание:
scgi_cache_lock_timeout 5s;
контекст: http, server, location

Эта директива появилась в версии 1.1.12.

Задаёт таймаут для scgi_cache_lock.

синтаксис: scgi_cache_methods GET | HEAD | POST ...;
умолчание:
scgi_cache_methods GET HEAD;
контекст: http, server, location

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

синтаксис: scgi_cache_min_uses число;
умолчание:
scgi_cache_min_uses 1;
контекст: http, server, location

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

синтаксис: scgi_cache_path путь [levels=уровни] keys_zone=имя:размер [inactive=время] [max_size=размер] [loader_files=число] [loader_sleep=время] [loader_threshold=время];
умолчание:
контекст: http

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

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

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

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

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

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

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

Специальный процесс “cache manager” следит за максимальным размером кэша, заданным параметром max_size, и при превышении его размеров удаляет наименее востребованные данные.

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

синтаксис: scgi_cache_purge строка ...;
умолчание:
контекст: http, server, location

Эта директива появилась в версии 1.5.7.

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

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

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

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 on | off;
умолчание:
scgi_cache_revalidate off;
контекст: http, server, location

Эта директива появилась в версии 1.5.7.

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

синтаксис: scgi_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_503 | http_403 | http_404 | off ...;
умолчание:
scgi_cache_use_stale off;
контекст: http, server, location

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

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

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

синтаксис: scgi_cache_valid [код ...] время;
умолчание:
контекст: http, server, location

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

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”, не будет кэшироваться. Обработка одного или более из этих полей заголовка может быть отключена при помощи директивы scgi_ignore_headers.

синтаксис: scgi_connect_timeout время;
умолчание:
scgi_connect_timeout 60s;
контекст: http, server, location

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

синтаксис: scgi_hide_header поле;
умолчание:
контекст: http, server, location

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

синтаксис: scgi_ignore_client_abort on | off;
умолчание:
scgi_ignore_client_abort off;
контекст: http, server, location

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

синтаксис: scgi_ignore_headers поле ...;
умолчание:
контекст: http, server, location

Запрещает обработку некоторых полей заголовка из ответа 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).

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

синтаксис: scgi_intercept_errors on | off;
умолчание:
scgi_intercept_errors off;
контекст: http, server, location

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

синтаксис: scgi_max_temp_file_size размер;
умолчание:
scgi_max_temp_file_size 1024m;
контекст: http, server, location

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

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

синтаксис: scgi_next_upstream error | timeout | invalid_header | http_500 | http_503 | http_403 | http_404 | off ...;
умолчание:
scgi_next_upstream error timeout;
контекст: http, server, location

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

error
произошла ошибка соединения с сервером, передачи ему запроса или чтения заголовка ответа сервера;
timeout
произошёл таймаут во время соединения с сервером, передачи ему запроса или чтения заголовка ответа сервера;
invalid_header
сервер вернул пустой или неверный ответ;
http_500
сервер вернул ответ с кодом 500;
http_503
сервер вернул ответ с кодом 503;
http_403
сервер вернул ответ с кодом 403;
http_404
сервер вернул ответ с кодом 404;
off
запрещает передачу запроса следующему серверу.

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

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

синтаксис: scgi_no_cache строка ...;
умолчание:
контекст: http, server, location

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

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

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

синтаксис: scgi_param параметр значение [if_not_empty];
умолчание:
контекст: http, server, location

Задаёт параметр, который будет передаваться 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_pass адрес;
умолчание:
контекст: location, if в location

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

scgi_pass localhost:9000;

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

scgi_pass unix:/tmp/scgi.socket;

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

синтаксис: scgi_pass_header поле;
умолчание:
контекст: http, server, location

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

синтаксис: scgi_read_timeout время;
умолчание:
scgi_read_timeout 60s;
контекст: http, server, location

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

синтаксис: scgi_pass_request_body on | off;
умолчание:
scgi_pass_request_body on;
контекст: http, server, location

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

синтаксис: scgi_pass_request_headers on | off;
умолчание:
scgi_pass_request_headers on;
контекст: http, server, location

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

синтаксис: scgi_send_timeout время;
умолчание:
scgi_send_timeout 60s;
контекст: http, server, location

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

синтаксис: scgi_store on | off | строка;
умолчание:
scgi_store off;
контекст: http, server, location

Разрешает сохранение на диск файлов. Параметр 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 пользователи:права ...;
умолчание:
scgi_store_access user:rw;
контекст: http, server, location

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

scgi_store_access user:rw group:rw all:r;

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

scgi_store_access group:rw all:r;

синтаксис: scgi_temp_file_write_size размер;
умолчание:
scgi_temp_file_write_size 8k|16k;
контекст: http, server, location

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

синтаксис: scgi_temp_path путь [уровень1 [уровень2 [уровень3]]];
умолчание:
scgi_temp_path scgi_temp;
контекст: http, server, location

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

scgi_temp_path /spool/nginx/scgi_temp 1 2;

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

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

    Поддержать сайт на родительском проекте КГБ