Модуль ngx_http_proxy_module |
Разделы
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Модуль Пример конфигурации
location / { proxy_pass http://localhost:8000; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; }
Директивы
Эта директива появилась в версии 0.8.22.
Задаёт локальный IP-
Задаёт
Разрешает или запрещает использовать буферизацию ответов проксируемого сервера. Если буферизация включена, то nginx принимает ответ проксируемого сервера как можно быстрее, сохраняя его в буферы, заданные директивами proxy_buffer_size и proxy_buffers. Если ответ не вмещается целиком в память, то его часть может быть записана на диск во временный файл. Запись во временные файлы контролируется директивами proxy_max_temp_file_size и proxy_temp_file_write_size. Если буферизация выключена, то ответ синхронно передаётся клиенту сразу же по мере его поступления. nginx не пытается считать весь ответ проксируемого сервера. Максимальный размер данных, который nginx может принять от сервера за один раз, задаётся директивой proxy_buffer_size.
Буферизация может быть также включена или выключена путём передачи
значения “
Задаёт
При включённой буферизации ответов
проксируемого сервера, ограничивает суммарный
Задаёт зону разделяемой памяти, используемой для кэширования.
Одна и та же зона может использоваться в нескольких местах.
Параметр
Задаёт условия, при которых ответ не будет браться из кэша. Если значение хотя бы одного из строковых параметров непустое и не равно “0”, то ответ не берётся из кэша: proxy_cache_bypass $cookie_nocache $arg_nocache$arg_comment; proxy_cache_bypass $http_pragma $http_authorization; Можно использовать совместно с директивой proxy_no_cache.
Задаёт ключ для кэширования, например, proxy_cache_key "$host$request_uri $cookie_user"; По умолчанию значение директивы близко к строке proxy_cache_key $scheme$proxy_host$uri$is_args$args;
Эта директива появилась в версии 1.1.12. Если включено, одновременно только одному запросу будет позволено заполнить новый элемент кэша, идентифицируемый согласно директиве proxy_cache_key, передав запрос на проксируемый сервер. Остальные запросы этого же элемента будут либо ожидать появления ответа в кэше, либо освобождения блокировки этого элемента, в течение времени, заданного директивой proxy_cache_lock_timeout.
Эта директива появилась в версии 1.1.12. Задаёт таймаут для proxy_cache_lock.
Эта директива появилась в версии 0.7.59.
Если метод запроса клиента указан в этой директиве,
то ответ будет закэширован.
Методы “
Задаёт
Задаёт путь и другие параметры кэша.
Данные кэша хранятся в файлах.
Именем файла в кэше является результат функции MD5
от ключа кэширования.
Параметр proxy_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m; имена файлов в кэше будут такого вида: /data/nginx/cache/c/29/b7f54b2df7773722d382f4809d65029c
Кэшируемый ответ сначала записывается во временный файл, а потом этот файл переименовывается. Начиная с версии 0.8.9, временные файлы и кэш могут располагаться на разных файловых системах. Однако нужно учитывать, что в этом случае вместо дешёвой операции переименовывания в пределах одной файловой системы файл копируется с одной файловой системы на другую. Поэтому лучше, если кэш будет находиться на той же файловой системе, что и каталог с временными файлами, задаваемый директивой proxy_temp_path для данного location.
Кроме того, все активные ключи и информация о данных хранятся в зоне
разделяемой памяти,
Если к данным кэша не обращаются в течение времени, заданного параметром
Специальный процесс “cache manager” следит за максимальным размером кэша,
заданным параметром
Через минуту после старта активируется специальный процесс “cache loader”,
который загружает в зону кэша информацию о ранее закэшированных данных,
хранящихся на файловой системе.
Загрузка происходит итерациями.
За одну итерацию загружается не более
Эта директива появилась в версии 1.5.7. Задаёт условия, при которых запрос будет считаться запросом на очистку кэша. Если значение хотя бы одного из строковых параметров непустое и не равно “0”, то запись в кэше с соответствующим ключом кэширования удаляется. В результате успешной операции возвращается ответ с кодом 204 (No Content).
Если ключ кэширования
запроса на очистку заканчивается
звёздочкой (“ Пример конфигурации: proxy_cache_path /data/nginx/cache keys_zone=cache_zone:10m; map $request_method $purge_method { PURGE 1; default 0; } server { ... location / { proxy_pass http://backend; proxy_cache cache_zone; proxy_cache_key $uri; proxy_cache_purge $purge_method; } }
Эта директива появилась в версии 1.5.7. Разрешает ревалидацию просроченных элементов кэша при помощи условных запросов с полем заголовка “If-Modified-Since”.
Определяет, в каких случаях можно использовать устаревший закэшированный ответ, если при работе с проксированным сервером возникла ошибка. Параметры директивы совпадают с параметрами директивы proxy_next_upstream.
Кроме того, дополнительный параметр Чтобы минимизировать число обращений к проксированным серверам при заполнении нового элемента кэша, можно воспользоваться директивой proxy_cache_lock.
Задаёт время кэширования для разных кодов ответа. Например, директивы proxy_cache_valid 200 302 10m; proxy_cache_valid 404 1m; задают время кэширования 10 минут для ответов с кодами 200 и 302 и 1 минуту для ответов с кодом 404.
Если указано только proxy_cache_valid 5m; то кэшируются только ответы 200, 301 и 302.
Кроме того, можно кэшировать любые ответы с помощью параметра
proxy_cache_valid 200 302 10m; proxy_cache_valid 301 1h; proxy_cache_valid any 1m;
Параметры кэширования могут также быть заданы непосредственно
в заголовке ответа.
Такой способ приоритетнее, чем задание времени кэширования с помощью директивы.
Поле заголовка “X-Accel-Expires” задаёт время кэширования
ответа в секундах.
Значение 0 запрещает кэшировать ответ.
Если значение начинается с префикса
Задаёт таймаут для установления соединения с проксированным сервером. Необходимо иметь в виду, что этот таймаут обычно не может превышать 75 секунд.
Эта директива появилась в версии 1.1.15.
Задаёт текст, который нужно изменить в атрибуте proxy_cookie_domain localhost example.org;
перепишет данный атрибут в виде
“
Точка в начале строк
В строках proxy_cookie_domain www.$host $host;
Директиву также можно задать при помощи регулярных выражений.
При этом proxy_cookie_domain ~\.(?P<sl_domain>[-0-9a-z]+\.[a-z]+)$ $sl_domain;
Директив proxy_cookie_domain localhost example.org; proxy_cookie_domain ~\.([a-z]+\.[a-z]+)$ $1;
Параметр proxy_cookie_domain off; proxy_cookie_domain localhost example.org; proxy_cookie_domain www.example.org example.org;
Эта директива появилась в версии 1.1.15.
Задаёт текст, который нужно изменить в атрибуте proxy_cookie_path /two/ /;
перепишет данный атрибут в виде
“
В строках proxy_cookie_path $uri /some$uri;
Директиву также можно задать при помощи регулярных выражений.
При этом proxy_cookie_path ~*^/user/([^/]+) /u/$1;
Директив proxy_cookie_path /one/ /; proxy_cookie_path / /two/;
Параметр proxy_cookie_path off; proxy_cookie_path /two/ /; proxy_cookie_path ~*^/user/([^/]+) /u/$1;
Задаёт
Задаёт максимальный
По умолчанию
nginx не передаёт клиенту поля заголовка “Date”,
“Server”, “X-Pad” и
“X-Accel-...” из ответа проксированного сервера.
Директива
Эта директива появилась в версии 1.1.4. Задаёт версию протокола HTTP для проксирования. По умолчанию используется версия 1.0. Для работы постоянных соединений рекомендуется версия 1.1.
Определяет, закрывать ли соединение с проксированным сервером в случае, если клиент закрыл соединение, не дождавшись ответа.
Запрещает обработку некоторых полей заголовка из ответа проксированного сервера. В директиве можно указать поля “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). Если не запрещено, обработка этих полей заголовка заключается в следующем:
Определяет, передавать ли клиенту проксированные ответы с кодом больше либо равным 300, или же перенаправлять их на обработку nginx’у с помощью директивы error_page.
Если включена буферизация ответов
проксируемого сервера, и ответ не вмещается целиком в буферы,
заданные директивами proxy_buffer_size и
proxy_buffers, часть ответа может быть записана во временный файл.
Эта директива задаёт максимальный Значение 0 отключает буферизацию ответов во временные файлы.
Задаёт HTTP-
Определяет, в каких случаях запрос будет передан следующему серверу:
Необходимо понимать, что передача запроса следующему серверу возможна только при условии, что клиенту ещё ничего не передавалось. То есть, если ошибка или таймаут возникли в середине передачи ответа клиенту, то исправить это уже невозможно.
Директива также определяет, что считается неудачной попыткой работы с
сервером.
Случаи
Задаёт условия, при которых ответ не будет сохраняться в кэш. Если значение хотя бы одного из строковых параметров непустое и не равно “0”, то ответ не будет сохранён: proxy_no_cache $cookie_nocache $arg_nocache$arg_comment; proxy_no_cache $http_pragma $http_authorization; Можно использовать совместно с директивой proxy_cache_bypass.
Задаёт протокол и адрес проксируемого сервера, а также необязательный URI,
на который должен отображаться location.
В качестве протокола можно указать
“ proxy_pass http://localhost:8000/uri/;
или в виде пути UNIX-сокета, который указывается после слова
“ proxy_pass http://unix:/tmp/backend.socket:/uri/;
Если доменному имени соответствует несколько адресов, то все они будут использоваться по очереди (round-robin). Кроме того, в качестве адреса можно указать группу серверов. URI запроса передаётся на сервер так:
В ряде случаев часть URI запроса, подлежащую замене, выделить невозможно:
Имя сервера, его порт и передаваемый URI можно также полностью задать с помощью переменных: proxy_pass http://$host$uri; или даже так: proxy_pass $request;
В этом случае имя сервера ищется среди описанных групп серверов и если не найдено, то определяется с помощью resolver’а. Проксирование WebSocket требует особой настройки и поддерживается начиная с версии 1.3.13.
Разрешает передавать от проксируемого сервера клиенту запрещённые для передачи поля заголовка.
Задаёт таймаут при чтении ответа проксированного сервера. Таймаут устанавливается не на всю передачу ответа, а только между двумя операциями чтения. Если по истечении этого времени проксируемый сервер ничего не передаст, соединение закрывается.
Позволяет запретить передачу исходного тела запроса на проксируемый сервер. location /x-accel-redirect-here/ { proxy_method GET; proxy_pass_request_body off; proxy_set_header Content-Length ""; proxy_pass ... } См. также директивы proxy_set_header и proxy_pass_request_headers.
Позволяет запретить передачу полей заголовка исходного запроса на проксируемый сервер. location /x-accel-redirect-here/ { proxy_method GET; proxy_pass_request_headers off; proxy_pass_request_body off; proxy_pass ... } См. также директивы proxy_set_header и proxy_pass_request_body.
Задаёт текст, который нужно изменить в полях заголовка
“Location” и “Refresh” в ответе
проксируемого сервера.
Предположим, проксируемый сервер вернул поле заголовка
“ proxy_redirect http://localhost:8000/two/ http://frontend/one/;
перепишет эту строку в виде
“ В заменяемой строке можно не указывать имя сервера: proxy_redirect http://localhost:8000/two/ /; тогда будут подставлены основное имя сервера и порт, если он отличен от 80.
Стандартная замена, задаваемая параметром location /one/ { proxy_pass http://upstream:port/two/; proxy_redirect default;
location /one/ { proxy_pass http://upstream:port/two/; proxy_redirect http://upstream:port/two/ /one/;
Параметр
В строке proxy_redirect http://localhost:8000/ http://$host:$server_port/;
В строке proxy_redirect http://$proxy_host:8000/ /;
Директиву также можно задать (1.1.11) при помощи регулярных выражений.
При этом proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2; proxy_redirect ~*/user/([^/]+)/(.+)$ http://$1.example.com/$2;
Директив proxy_redirect default; proxy_redirect http://localhost:8000/ /; proxy_redirect http://www.example.com/ /;
Параметр proxy_redirect off; proxy_redirect default; proxy_redirect http://localhost:8000/ /; proxy_redirect http://www.example.com/ /;
С помощью этой директивы можно также добавлять имя хоста к относительным перенаправлениям, выдаваемым проксируемым сервером: proxy_redirect / /;
При установке директивы в ненулевое значение nginx будет пытаться минимизировать
число операций отправки на исходящих соединениях с проксируемым сервером либо
при помощи флага Эта директива игнорируется на Linux, Solaris и Windows.
Задаёт таймаут при передаче запроса проксированному серверу. Таймаут устанавливается не на всю передачу запроса, а только между двумя операциями записи. Если по истечении этого времени проксируемый сервер не примет новых данных, соединение закрывается.
Позволяет переопределить тело запроса, передаваемое на проксируемый сервер. В качестве значения можно использовать текст, переменные и их комбинации.
Позволяет переопределять или добавлять поля заголовка запроса,
передаваемые проксируемому серверу.
В качестве значения можно использовать текст, переменные и их комбинации.
Директивы наследуются с предыдущего уровня при условии, что на данном
уровне не описаны свои директивы proxy_set_header Host $proxy_host; proxy_set_header Connection close;
Неизменённое поле заголовка запроса “Host” можно передать так: proxy_set_header Host $http_host;
Однако, если это поле отсутствует в заголовке запроса клиента, то ничего
передаваться не будет.
В этом случае лучше воспользоваться переменной proxy_set_header Host $host;
Кроме того, можно передать имя сервера вместе с портом проксируемого сервера: proxy_set_header Host $host:$proxy_port;
Если значение поля заголовка — пустая строка, то поле вообще не будет передаваться проксируемому серверу: proxy_set_header Accept-Encoding "";
Эта директива появилась в версии 1.5.6. Описывает разрешённые шифры для запросов к проксируемому HTTPS-серверу. Шифры задаются в формате, поддерживаемом библиотекой OpenSSL.
Полный список можно посмотреть с помощью команды
“
Эта директива появилась в версии 1.7.0.
Указывает
Эта директива появилась в версии 1.7.0. Позволяет переопределить имя сервера, используемое при проверке сертификата проксируемого HTTPS-сервера, а также для передачи его через SNI при установлении соединения с проксируемым HTTPS-сервером. По умолчанию используется имя хоста из URL’а, заданного директивой proxy_pass.
Эта директива появилась в версии 1.7.0. Разрешает или запрещает передачу имени сервера через расширение Server Name Indication протокола TLS (SNI, RFC 6066) при установлении соединения с проксируемым HTTPS-сервером.
Определяет, использовать ли повторно SSL-сессии при
работе с проксированным сервером.
Если в логах появляются ошибки
“
Эта директива появилась в версии 1.5.6. Разрешает указанные протоколы для запросов к проксируемому HTTPS-серверу.
Эта директива появилась в версии 1.7.0.
Задаёт
Эта директива появилась в версии 1.7.0. Разрешает или запрещает проверку сертификата проксируемого HTTPS-сервера.
Эта директива появилась в версии 1.7.0. Устанавливает глубину проверки в цепочке сертификатов проксируемого HTTPS-сервера.
Разрешает сохранение на диск файлов.
Параметр proxy_store /data/www$original_uri;
Время изменения файлов выставляется согласно полученному полю “Last-Modified” в заголовке ответа. Ответ сначала записывается во временный файл, а потом этот файл переименовывается. Начиная с версии 0.8.9, временный файл и постоянное место хранения ответа могут располагаться на разных файловых системах. Однако нужно учитывать, что в этом случае вместо дешёвой операции переименовывания в пределах одной файловой системы файл копируется с одной файловой системы на другую. Поэтому лучше, если сохраняемые файлы будут находиться на той же файловой системе, что и каталог с временными файлами, задаваемый директивой proxy_temp_path для данного location. Директиву можно использовать для создания локальных копий статических неизменяемых файлов, например, так: location /images/ { root /data/www; error_page 404 = /fetch$uri; } location /fetch/ { internal; proxy_pass http://backend/; proxy_store on; proxy_store_access user:rw group:rw all:r; proxy_temp_path /data/temp; alias /data/www/; }
или так: location /images/ { root /data/www; error_page 404 = @fetch; } location @fetch { internal; proxy_pass http://backend; proxy_store on; proxy_store_access user:rw group:rw all:r; proxy_temp_path /data/temp; root /data/www; }
Задаёт права доступа для создаваемых файлов и каталогов, например, proxy_store_access user:rw group:rw all:r;
Если заданы какие-либо права для proxy_store_access group:rw all:r;
Ограничивает
Задаёт имя каталога для хранения временных файлов с данными, полученными от проксируемых серверов. В каталоге может использоваться иерархия подкаталогов до трёх уровней. Например, при такой конфигурации proxy_temp_path /spool/nginx/proxy_temp 1 2; временный файл будет следующего вида: /spool/nginx/proxy_temp/7/45/00000123457
Встроенные переменные
В модуле
|