SCGI#
Позволяет передавать запросы SCGI-серверу.
Пример конфигурации#
location / {
include scgi_params;
scgi_pass localhost:9000;
}
Директивы#
scgi_bind#
Задает локальный IP-адрес с необязательным портом, который будет использоваться в исходящих соединениях с SCGI-сервером. В значении параметра допустимо использование переменных. Специальное значение off отменяет действие унаследованной с предыдущего уровня конфигурации директивы scgi_bind, позволяя системе самостоятельно выбирать локальный IP-адрес и порт.
Параметр transparent позволяет задать нелокальный IP-aдрес, который будет использоваться в исходящих соединениях с SCGI-сервером, например, реальный IP-адрес клиента:
scgi_bind $remote_addr transparent;
Для работы параметра обычно требуется запустить рабочие процессы Angie с привилегиями суперпользователя. В Linux это не требуется, так как если указан параметр transparent, то рабочие процессы наследуют capability CAP_NET_RAW из главного процесса.
Важно
Необходимо настроить таблицу маршрутизации ядра для перехвата сетевого трафика с SCGI-сервера.
scgi_buffer_size#
|
|
По умолчанию |
|
http, server, location |
Задает размер буфера, в который будет читаться первая часть ответа, получаемого от SCGI-сервера. В этой части ответа обычно находится небольшой заголовок ответа. По умолчанию размер одного буфера равен размеру страницы памяти. В зависимости от платформы это или 4K, или 8K, однако его можно сделать меньше.
scgi_buffering#
|
Angie принимает ответ SCGI-сервера как можно быстрее, сохраняя его в буферы, заданные директивами scgi_buffer_size и scgi_buffers. Если ответ не вмещается целиком в память, то его часть может быть записана на диск во временный файл. Запись во временные файлы контролируется директивами scgi_max_temp_file_size и scgi_temp_file_write_size. |
|
Ответ синхронно передается клиенту сразу же по мере его поступления. Angie не пытается считать весь ответ SCGI-сервера. Максимальный размер данных, который Angie может принять от сервера за один раз, задается директивой scgi_buffer_size. |
Буферизация может быть также включена или выключена путем передачи значения "yes" или "no" в поле "X-Accel-Buffering" заголовка ответа. Эту возможность можно запретить с помощью директивы scgi_ignore_headers.
scgi_buffers#
|
|
По умолчанию |
|
http, server, location |
Задает число и размер буферов для одного соединения, в которые будет читаться ответ, получаемый от SCGI-сервера.
По умолчанию размер одного буфера равен размеру страницы. В зависимости от платформы это или 4K, или 8K.
scgi_busy_buffers_size#
|
|
По умолчанию |
|
http, server, location |
При включенной буферизации ответов SCGI-сервера, ограничивает суммарный размер буферов, которые могут быть заняты для отправки ответа клиенту, пока ответ еще не прочитан целиком. Оставшиеся буферы тем временем могут использоваться для чтения ответа и, при необходимости, буферизации части ответа во временный файл.
По умолчанию размер ограничен величиной двух буферов, заданных директивами scgi_buffer_size и scgi_buffers.
scgi_cache#
Задает зону разделяемой памяти, используемой для кэширования. Одна и та же зона может использоваться в нескольких местах. В значении параметра можно использовать переменные.
|
запрещает кэширование, унаследованное с предыдущего уровня конфигурации. |
scgi_cache_background_update#
|
|
По умолчанию |
|
http, server, location |
Позволяет запустить фоновый подзапрос для обновления просроченного элемента кэша, в то время как клиенту возвращается устаревший кэшированный ответ.
Внимание
Использование устаревшего кэшированного ответа в момент его обновления должно быть разрешено.
scgi_cache_bypass#
Задает условия, при которых ответ не будет браться из кэша. Если значение хотя бы одного из строковых параметров непустое и не равно "0", то ответ не берется из кэша:
scgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
scgi_cache_bypass $http_pragma $http_authorization;
Можно использовать совместно с директивой scgi_no_cache.
scgi_cache_key#
Задает ключ для кэширования, например,
scgi_cache_key localhost:9000$request_uri;
scgi_cache_lock#
|
|
По умолчанию |
|
http, server, location |
Если включено, одновременно только одному запросу будет позволено заполнить новый элемент кэша, идентифицируемый согласно директиве scgi_cache_key, передав запрос на SCGI-сервер. Остальные запросы этого же элемента будут либо ожидать появления ответа в кэше, либо освобождения блокировки этого элемента, в течение времени, заданного директивой scgi_cache_lock_timeout.
scgi_cache_lock_age#
|
|
По умолчанию |
|
http, server, location |
Если последний запрос, переданный на SCGI-сервер для заполнения нового элемента кэша, не завершился за указанное время, на SCGI-сервер может быть передан еще один запрос.
scgi_cache_lock_timeout#
|
|
По умолчанию |
|
http, server, location |
Задает таймаут для scgi_cache_lock. По истечении указанного времени запрос будет передан на SCGI-сервер, однако ответ не будет кэширован.
scgi_cache_max_range_offset#
Задает смещение в байтах для запросов с указанием диапазона запрашиваемых байт (byte-range requests). Если диапазон находится за указанным смещением, range-запрос будет передан на SCGI-сервер и ответ не будет кэширован.
scgi_cache_methods#
|
|
По умолчанию |
|
http, server, location |
Если метод запроса клиента указан в этой директиве, то ответ будет кэширован. Методы "GET" и "HEAD" всегда добавляются в список, но тем не менее рекомендуется перечислять их явно. См. также директиву scgi_no_cache.
scgi_cache_min_uses#
|
|
По умолчанию |
|
http, server, location |
Задает число запросов, после которого ответ будет кэширован.
scgi_cache_path#
|
|
По умолчанию |
— |
http |
Задает путь и другие параметры кэша. Данные кэша хранятся в файлах. Именем файла в кэше является результат функции MD5 от ключа кэширования.
Параметр levels задает уровни иерархии кэша: можно задать от 1 до 3 уровней, на каждом уровне допускаются значения 1 или 2.
Например, при использовании
scgi_cache_path /data/angie/cache levels=1:2 keys_zone=one:10m;
имена файлов в кэше будут такого вида:
/data/angie/cache/c/29/b7f54b2df7773722d382f4809d65029c
Кэшируемый ответ сначала записывается во временный файл, а потом этот файл переименовывается. Временные файлы и кэш могут располагаться на разных файловых системах. Однако нужно учитывать, что в этом случае вместо дешевой операции переименовывания в пределах одной файловой системы файл копируется с одной файловой системы на другую. Поэтому лучше, если кэш будет находиться на той же файловой системе, что и каталог с временными файлами.
Какой из каталогов будет использоваться для временных файлов, определяется параметром use_temp_path.
|
Если параметр не задан или установлен в значение "on", будет использоваться каталог, задаваемый директивой scgi_temp_path для данного location |
|
временные файлы будут располагаться непосредственно в каталоге кэша |
Кроме того, все активные ключи и информация о данных хранятся в зоне разделяемой памяти, имя и размер которой задаются параметром keys_zone. Зоны размером в 1 мегабайт достаточно для хранения около 8 тысяч ключей.
Если к данным кэша не обращаются в течение времени, заданного параметром inactive, то данные удаляются, независимо от их свежести.
По умолчанию inactive равен 10 минутам.
Специальный процесс cache manager следит за максимальным размером кэша, а также за минимальным объемом свободного места на файловой системе с кэшем, и удаляет наименее востребованные данные при превышении максимального размера кэша или недостаточном объеме свободного места. Удаление данных происходит итерациями.
|
максимальное пороговое значение размера кэша |
|
минимальное пороговое значение объема свободного места на файловой системе с кэшем |
|
максимальное количество удаляемых элементов кэша за одну итерацию |
|
ограничивает время работы одной итерации |
|
время, в течение которого выдерживается пауза между итерациями |
Через минуту после старта Angie активируется специальный процесс cache loader, который загружает в зону кэша информацию о ранее кэшированных данных, хранящихся на файловой системе. Загрузка также происходит итерациями.
|
максимальное количество элементов кэша к загрузке в одну итерацию |
|
ограничивает время работы одной итерации |
|
время, в течение которого выдерживается пауза между итерациями |
scgi_cache_revalidate#
|
|
По умолчанию |
|
http, server, location |
Разрешает ревалидацию просроченных элементов кэша при помощи условных запросов с полями заголовка "If-Modified-Since" и "If-None-Match".
scgi_cache_use_stale#
|
|
По умолчанию |
|
http, server, location |
Определяет, в каких случаях можно использовать устаревший кэшированный ответ. Параметры директивы совпадают с параметрами директивы scgi_next_upstream.
|
Позволяет использовать устаревший кэшированный ответ при невозможности выбора SCGI-сервера для обработки запроса. |
|
Дополнительный параметр, разрешает использовать устаревший кэшированный ответ, если на данный момент он уже обновляется. Это позволяет минимизировать число обращений к SCGI-серверам при обновлении кэшированных данных. |
Использование устаревшего кэшированного ответа может также быть разрешено непосредственно в заголовке ответа на определенное количество секунд после того, как ответ устарел:
Расширение stale-while-revalidate поля заголовка "Cache-Control" разрешает использовать устаревший кэшированный ответ, если на данный момент он уже обновляется.
Расширение stale-if-error поля заголовка "Cache-Control" разрешает использовать устаревший кэшированный ответ в случае ошибки.
Примечание
Такой способ менее приоритетен, чем задание параметров директивы.
Чтобы минимизировать число обращений к SCGI-серверам при заполнении нового элемента кэша, можно воспользоваться директивой scgi_cache_lock.
scgi_cache_valid#
Задает время кэширования для разных кодов ответа. Например, директивы
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" со специальным значением "*", не будет кэшироваться. Ответ, в заголовке которого есть поле "Vary" с другим значением, будет кэширован с учетом соответствующих полей заголовка запроса.
Обработка одного или более из этих полей заголовка может быть отключена при помощи директивы scgi_ignore_headers.
scgi_connect_timeout#
|
|
По умолчанию |
|
http, server, location |
Задает таймаут для установления соединения с SCGI-сервером. Необходимо иметь в виду, что этот таймаут обычно не может превышать 75 секунд.
scgi_connection_drop#
|
|
По умолчанию |
|
http, server, location |
Настраивает завершение всех соединений с проксируемым сервером,
если он был удален из группы или помечен как постоянно недоступный
в результате процесса reresolve
или команды API DELETE.
Соединение завершается, когда обрабатывается следующее событие чтения или записи для клиента или проксируемого сервера.
Установка времени включает таймаут до завершения соединения;
при выборе значения on соединения завершаются немедленно.
scgi_force_ranges#
|
|
По умолчанию |
|
http, server, location |
Включает поддержку диапазонов запрашиваемых байт (byte-range) для кэшированных и некэшированных ответов SCGI-сервера вне зависимости от наличия поля "Accept-Ranges" в заголовках этих ответов.
scgi_hide_header#
По умолчанию Angie не передает клиенту поля заголовка "Status" и "X-Accel-..." из ответа SCGI-сервера. Директива scgi_hide_header задает дополнительные поля, которые не будут передаваться. Если же передачу полей нужно разрешить, можно воспользоваться директивой scgi_pass_header.
scgi_ignore_client_abort#
|
|
По умолчанию |
|
http, server, location |
Определяет, закрывать ли соединение с SCGI-сервером в случае, если клиент закрыл соединение, не дождавшись ответа.
scgi_ignore_headers#
Запрещает обработку некоторых полей заголовка из ответа SCGI-сервера. В директиве можно указать поля "X-Accel-Redirect", "X-Accel-Expires", "X-Accel-Limit-Rate", "X-Accel-Buffering", "X-Accel-Charset", "Expires", "Cache-Control", "Set-Cookie" и "Vary".
Если не запрещено, обработка этих полей заголовка заключается в следующем:
"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#
|
|
По умолчанию |
|
http, server, location |
Определяет, передавать ли клиенту ответы SCGI-сервера с кодом больше либо равным 300, или же перехватывать их и перенаправлять на обработку Angie с помощью директивы error_page.
scgi_limit_rate#
Ограничивает скорость чтения ответа от SCGI-сервера. Скорость задается в байтах в секунду; можно использовать переменные.
|
отключает ограничение скорости |
Примечание
Ограничение устанавливается на запрос, поэтому, если Angie одновременно откроет два соединения к SCGI-серверу, суммарная скорость будет вдвое выше заданного ограничения. Ограничение работает только в случае, если включена буферизация ответов SCGI-сервера.
scgi_max_temp_file_size#
|
|
По умолчанию |
|
http, server, location |
Если включена буферизация ответов SCGI-сервера, и ответ не вмещается целиком в буферы, заданные директивами scgi_buffer_size и scgi_buffers, часть ответа может быть записана во временный файл. Эта директива задает максимальный размер временного файла. Размер данных, сбрасываемых во временный файл за один раз, задается директивой scgi_temp_file_write_size.
|
отключает возможность буферизации ответов во временные файлы |
Примечание
Данное ограничение не распространяется на ответы, которые будут кэшированы или сохранены на диске.
scgi_next_upstream#
|
|
По умолчанию |
|
http, server, location |
Определяет, в каких случаях запрос будет передан следующему серверу:
|
произошла ошибка соединения с сервером, передачи ему запроса или чтения заголовка ответа сервера; |
|
произошел таймаут во время соединения с сервером, передачи ему запроса или чтения заголовка ответа сервера; |
|
сервер вернул пустой или неверный ответ; |
|
сервер вернул ответ с кодом 500; |
|
сервер вернул ответ с кодом 503; |
|
сервер вернул ответ с кодом 403; |
|
сервер вернул ответ с кодом 404; |
|
сервер вернул ответ с кодом 429; |
|
обычно запросы с неидемпотентным методом (POST, LOCK, PATCH) не передаются на другой сервер, если запрос серверу группы уже был отправлен; включение параметра явно разрешает повторять подобные запросы; |
|
запрещает передачу запроса следующему серверу. |
Примечание
Необходимо понимать, что передача запроса следующему серверу возможна только при условии, что клиенту еще ничего не передавалось. То есть, если ошибка или таймаут возникли в середине передачи ответа клиенту, то действие директивы на такой запрос не распространяется.
Директива также определяет, что считается неудачной попыткой работы с сервером.
|
всегда считаются неудачными попытками, даже если они не указаны в директиве |
|
считаются неудачными попытками, только если они указаны в директиве |
|
никогда не считаются неудачными попытками |
Передача запроса следующему серверу может быть ограничена по количеству попыток и по времени.
scgi_next_upstream_timeout#
|
|
По умолчанию |
|
http, server, location |
Ограничивает время, в течение которого возможна передача запроса следующему серверу.
|
отключает это ограничение |
scgi_next_upstream_tries#
|
|
По умолчанию |
|
http, server, location |
Ограничивает число допустимых попыток для передачи запроса следующему серверу.
|
отключает это ограничение |
scgi_no_cache#
Задает условия, при которых ответ не будет сохраняться в кэш. Если значение хотя бы одного из строковых параметров непустое и не равно "0", то ответ не будет сохранен:
scgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
scgi_no_cache $http_pragma $http_authorization;
Можно использовать совместно с директивой scgi_cache_bypass.
scgi_param#
|
|
По умолчанию |
— |
http, server, location |
Задает параметр, который будет передаваться SCGI-серверу. В качестве значения можно использовать текст, переменные и их комбинации. Директивы наследуются с предыдущего уровня конфигурации при условии, что на данном уровне не описаны свои директивы SCGI-param.
Стандартные переменные окружения CGI должны передаваться как заголовки SCGI, см. файл scgi_params из дистрибутива:
location / {
include scgi_params;
# ...
}
Если директива указана с if_not_empty, то такой параметр с пустым значением передаваться на сервер не будет:
scgi_param HTTPS $https if_not_empty;
scgi_pass#
Задает адрес SCGI-сервера. Адрес может быть указан в виде доменного имени или IP-адреса, и порта:
scgi_pass localhost:9000;
или в виде пути UNIX-сокета:
scgi_pass unix:/tmp/scgi.socket;
Если доменному имени соответствует несколько адресов, то все они будут использоваться по очереди (round-robin). Кроме того, в качестве адреса можно указать группу серверов.
В значении параметра можно использовать переменные. В этом случае, если адрес указан в виде доменного имени, имя ищется среди описанных групп серверов и если не найдено, то определяется с помощью resolver'а.
scgi_pass_header#
Разрешает передавать от SCGI-сервера клиенту запрещенные для передачи поля заголовка.
scgi_pass_request_body#
|
|
По умолчанию |
|
http, server, location |
Позволяет запретить передачу исходного тела запроса на SCGI-сервер. См. также директиву scgi_pass_request_headers.
scgi_pass_request_headers#
|
|
По умолчанию |
|
http, server, location |
Позволяет запретить передачу полей заголовка исходного запроса на SCGI-сервер. См. также директиву scgi_pass_request_body.
scgi_read_timeout#
|
|
По умолчанию |
|
http, server, location |
Задает таймаут при чтении ответа SCGI-сервера. Таймаут устанавливается не на всю передачу ответа, а только между двумя операциями чтения. Если по истечении этого времени SCGI-сервер ничего не передаст, соединение закрывается.
scgi_request_buffering#
|
|
По умолчанию |
|
http, server, location |
Разрешает или запрещает использовать буферизацию тела запроса клиента.
|
тело запроса полностью читается от клиента перед отправкой запроса на SCGI-сервер. |
|
тело запроса отправляется на SCGI-сервер сразу же по мере его поступления. В этом случае запрос не может быть передан следующему серверу, если Angie уже начал отправку тела запроса. |
Если для отправки тела исходного запроса используется HTTP/1.1 и передача данных частями (chunked transfer encoding), то тело запроса буферизуется независимо от значения директивы.
scgi_send_timeout#
|
|
По умолчанию |
|
http, server, location |
Задает таймаут при передаче запроса SCGI-серверу. Таймаут устанавливается не на всю передачу запроса, а только между двумя операциями записи. Если по истечении этого времени SCGI-сервер не примет новых данных, соединение закрывается.
scgi_socket_keepalive#
|
|
По умолчанию |
|
http, server, location |
Конфигурирует поведение "TCP keepalive" для исходящих соединений к SCGI-серверу.
|
По умолчанию для сокета действуют настройки операционной системы. |
|
для сокета включается параметр SO_KEEPALIVE |
scgi_store#
|
|
По умолчанию |
|
http, server, location |
Разрешает сохранение на диск файлов.
|
сохраняет файлы в соответствии с путями, указанными в директивах alias или root |
|
запрещает сохранение файлов |
Имя файла можно задать явно с помощью строки с переменными:
scgi_store /data/www$original_uri;
Время изменения файлов выставляется согласно полученному полю "Last-Modified" в заголовке ответа. Ответ сначала записывается во временный файл, а потом этот файл переименовывается. Временный файл и постоянное место хранения ответа могут располагаться на разных файловых системах. Однако нужно учитывать, что в этом случае вместо дешевой операции переименовывания в пределах одной файловой системы файл копируется с одной файловой системы на другую. Поэтому лучше, если сохраняемые файлы будут находиться на той же файловой системе, что и каталог с временными файлами, задаваемый директивой 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#
|
|
По умолчанию |
|
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#
|
|
По умолчанию |
|
http, server, location |
Ограничивает размер данных, сбрасываемых во временный файл за один раз, при включенной буферизации ответов SCGI-сервера во временные файлы. По умолчанию размер ограничен двумя буферами, заданными директивами scgi_buffer_size и scgi_buffers. Максимальный размер временного файла задается директивой scgi_max_temp_file_size.
scgi_temp_path#
|
|
По умолчанию |
|
http, server, location |
Задает имя каталога для хранения временных файлов с данными, полученными от SCGI-серверов. В каталоге может использоваться иерархия подкаталогов до трех уровней. Например, при такой конфигурации
scgi_temp_path /spool/angie/scgi_temp 1 2;
временный файл будет следующего вида:
/spool/angie/scgi_temp/7/45/00000123457
См. также параметр use_temp_path директивы scgi_cache_path.