Модуль ngx_http_proxy_module позволяет передавать запросы другому серверу.

location / {
    proxy_pass       http://localhost:8000;
    proxy_set_header Host      $host;
    proxy_set_header X-Real-IP $remote_addr;
}

proxy_buffer_size 4k|8k;

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

proxy_buffering on;

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

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

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

proxy_buffers 8 4k|8k;

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

proxy_cache off;

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

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

proxy_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
proxy_cache_bypass $http_pragma    $http_authorization;

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

proxy_cache_key $scheme$proxy_host$request_uri;

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

proxy_cache_key "$host$request_uri $cookie_user";

По умолчанию значение директивы близко к строке

proxy_cache_key $scheme$proxy_host$uri$is_args$args;

proxy_cache_lock off;

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

proxy_cache_lock_timeout 5s;

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

proxy_cache_min_uses 1;

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

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

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.

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

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

proxy_cache_use_stale off;

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

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

proxy_cache_valid 200 302 10m;
proxy_cache_valid 404      1m;

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

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

proxy_cache_valid 5m;

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

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

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

proxy_connect_timeout 60s;

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

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

proxy_http_version 1.0;

Задаёт версию протокола HTTP для проксирования. По умолчанию используется версия 1.0. Для работы постоянных соединений рекомендуется версия 1.1.

proxy_ignore_client_abort off;

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

Запрещает обработку некоторых полей заголовка из ответа проксированного сервера. В директиве можно указать поля “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).

proxy_intercept_errors off;

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

proxy_next_upstream error timeout;

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

error

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

timeout

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

invalid_header

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

http_500

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

http_502

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

http_503

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

http_504

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

http_404

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

off

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

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

Задаёт условия, при которых ответ не будет сохраняться в кэш. Если значение хотя бы одного из строковых параметров непустое и не равно “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/;

путь указан после слова “unix” и заключён между двумя двоеточиями.

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

При передаче запроса серверу часть URI, соответствующая location, заменяется на URI, указанный в директиве proxy_pass. Но из этого правила есть два исключения, в которых нельзя определить заменяемый location:

• если location задан регулярным выражением;
• если внутри проксируемого location с помощью директивы rewrite изменяется URI, и именно с этой конфигурацией будет обрабатываться запрос (break):

  location /name/ {
      rewrite    /name/([^/]+) /users?name=$1 break;
      proxy_pass http://127.0.0.1;
  }
  

  Для этих случаев URI передаётся без отображения.

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

• два и более слэшей заменяются на один: “//” — “/”;
• убираются ссылки на текущий каталог: “/./” — “/”;
• убираются ссылки на предыдущий каталог: “/dir/../” — “/”.

Если на сервер нужно передать URI в необработанном виде, то для этого в директиве proxy_pass нужно указать URL сервера без URI:

location /some/path/ {
    proxy_pass http://127.0.0.1;
}

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

proxy_pass http://$host$uri;

или так:

proxy_pass $request;

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

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

proxy_read_timeout 60s;

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

proxy_redirect default;

Задаёт текст, который нужно изменить в полях заголовка “Location” и “Refresh” в ответе проксируемого сервера. Предположим, проксируемый сервер вернул поле заголовка “Location: http://localhost:8000/two/some/uri/”. Директива

proxy_redirect http://localhost:8000/two/ http://frontend/one/;

перепишет эту строку в виде “Location: http://frontend/one/some/uri/”.

В заменяемой строке можно не указывать имя сервера:

proxy_redirect http://localhost:8000/two/ /;

тогда будет подставлено основное имя сервера и порт, если он отличен от 80.

Стандартная замена, задаваемая параметром default, использует параметры директив location и proxy_pass. Поэтому две нижеприведённые конфигурации одинаковы:

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

Параметр default недопустим, если в proxy_pass используются переменные.

В строке замена можно использовать переменные:

proxy_redirect http://localhost:8000/ http://$host:$server_port/;

В строке перенаправление тоже можно использовать (1.1.11) переменные:

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 может быть несколько:

proxy_redirect default;
proxy_redirect http://localhost:8000/  /;
proxy_redirect http://www.example.com/ /;

Параметр off запрещает все директивы proxy_redirect на данном уровне:

proxy_redirect off;
proxy_redirect default;
proxy_redirect http://localhost:8000/  /;
proxy_redirect http://www.example.com/ /;

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

proxy_redirect / /;

proxy_send_timeout 60s;

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

proxy_set_header Host $proxy_host;

proxy_set_header Connection close;

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

proxy_set_header Host       $proxy_host;
proxy_set_header Connection close;

Неизменённое поле заголовка запроса “Host” можно передать так:

proxy_set_header Host       $http_host;

Однако, если это поле отсутствует в заголовке запроса клиента, то ничего передаваться не будет. В этом случае лучше воспользоваться переменной $host - её значение равно имени сервера в поле “Host” заголовка запроса, или же основному имени сервера, если поля нет:

proxy_set_header Host       $host;

Кроме того, можно передать имя сервера вместе с портом проксируемого сервера:

proxy_set_header Host       $host:$proxy_port;

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

proxy_set_header Accept-Encoding "";

proxy_ssl_session_reuse on;

Определяет, использовать ли повторно SSL-сессии при работе с проксированным сервером. Если в логах появляются ошибки “SSL3_GET_FINISHED:digest check failed”, то можно попробовать выключить повторное использование сессий.

proxy_store off;

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

proxy_store /data/www$original_uri;

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

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

location /images/ {
    root                   /data/www;
    open_file_cache_errors off;
    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;

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

proxy_store_access user:rw group:rw all:r;

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

proxy_store_access group:rw all:r;

proxy_temp_path proxy_temp;

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

proxy_temp_path /spool/nginx/proxy_temp 1 2;

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

/spool/nginx/proxy_temp/7/45/00000123457

В модуле ngx_http_proxy_module есть встроенные переменные, которые можно использовать для формирования заголовков с помощью директивы proxy_set_header:

$proxy_host

имя проксируемого хоста и порт;

$proxy_port

порт проксируемого хоста;

$proxy_add_x_forwarded_for

поле заголовка запроса клиента “X-Forwarded-For” и добавленная к нему через запятую переменная $remote_addr. Если же поля “X-Forwarded-For” в заголовке запроса клиента нет, то переменная $proxy_add_x_forwarded_for равна переменной $remote_addr.