Пaраметр modifiers#

Группа modifiers позволяет изменять содержимое заголовков запроса и ответа.

В случае, если не указаны трансформации и модификации заголовка Forwarded, этот заголовок дополняется, если пришел, через запятую значением for = $formatted_original_remote_addr.

Опциональные параметры:

  • modifiers

    Тип параметра: группа параметров и их значения.

    По умолчанию: не имеет значения по умолчанию.

    Опциональные параметры:

    • set_header

      В значении параметра можно переопределить или заменить заголовок в запросе клиента.

      set_header:
  - client_header

      Тип параметра: последовательность строковых значений.

      По умолчанию: не имеет значения по умолчанию.

    • proxy_host_resolved

      Если установлен параметр proxy_host_resolved, то в заголовке Host будет значение IP:Port, иначе (оно же по умолчанию) в заголовке будет запись: <имя хоста из конфига>:Port.

      Тип параметра: логическое значение:

      • true;

      • false.

      По умолчанию: не имеет значения по умолчанию.

    • pass_header

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

      pass_header:
  - upstream_header

      Тип параметра: последовательность строковых значений.

      По умолчанию: не имеет значения по умолчанию.

    • proxy_redirect

      В значении параметра задается текст, который нужно изменить в полях заголовка Location и Refresh в ответе проксируемого сервера.

      Доступно, в случае http_version < 2.0.

      proxy_redirect:
  - location_new

      Тип параметра: последовательность строковых значений.

      По умолчанию: не имеет значения по умолчанию.

    • sub_filter

      Группа параметров sub_filter позволяет сделать замену одной строки на другую в ответе.

      Тип параметра: группа параметров и их значения.

      По умолчанию: не имеет значения по умолчанию.

      Обязательные параметры:

      • replace

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

        Тип параметра: последовательность параметров и их значения.

        По умолчанию: не имеет значения по умолчанию.

        Обязательные параметры:

        • from

          В значении параметра определяется заменяемый текст.

          Тип параметра: строковое значение.

          По умолчанию: не имеет значения по умолчанию.

        • to

          В значении параметра определяется текст замены.

          Тип параметра: строковое значение.

          По умолчанию: не имеет значения по умолчанию.

        Пример:

        replace:
  - from: text_1
    to: text_2

      Опциональные параметры:

      • once

        В значении параметра определяется, сколько раз нужно искать каждую из заменяемых строк: один раз или многократно.

        Тип параметра:

        • on;

        • off.

        По умолчанию: не имеет значения по умолчанию.

      • last_modified

        Параметр позволяет сохранить поле заголовка last-modified исходного ответа во время замены для лучшего кэширования ответов.

        Тип параметра:

        • on;

        • off.

        По умолчанию: не имеет значения по умолчанию.

        Пример:

        sub_filter:
  replace:
    - from: text 1
      to: text 2
  once: "off"
  last_modifided: "off"

    • subs_filter

      Группа параметров subs_filter позволяет сделать замену одной строки на другую в ответе, используя регулярные выражения.

      Группа параметров subs_filter является более универсальной, по сравнению с sub_filter.

      Тип параметра: группа параметров и их значения.

      По умолчанию: не имеет значения по умолчанию.

      Обязательные параметры:

      • replace

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

        Тип параметра: последовательность параметров и их значения.

        По умолчанию: не имеет значения по умолчанию.

        Обязательные параметры:

        • from

          В значении параметра определяется заменяемый текст.

          Тип параметра: строковое значение.

          По умолчанию: не имеет значения по умолчанию.

        • to

          В значении параметра определяется текст замены.

          Тип параметра: строковое значение.

          По умолчанию: не имеет значения по умолчанию.

      Опциональные параметры:

      • flags

        Значение параметра flags должно быть уникальным.

        Тип параметра: Последовательность строковых значений:

        • „i“ — выполняется сопоставление без учета регистра;

        • „g“ — выполняется замена всех строк соответствия;

        • „o“ — выполняется замена по первому соответствию;

        • „r“ — шаблон обрабатывается как регулярное выражение, по умолчанию это фиксированная строка.

        По умолчанию:

        replace:
  - ...
    ...
    flags:
      - r

      Пример:

      replace:
  - from: text_1
    to: text_2

      Опциональные параметры:

      • mime_types

        В значении параметра указываются типы данных, которые могут быть переданы посредством сети интернет с применением стандарта MIME. Тип MIME состоит из двух частей: типа и подтипа. Они разделены косой чертой (/).

        Тип параметра: строковое значение.

        По умолчанию:

        mime_types: *

      Пример:

      subs_filter:
  replace:
    - from: text_1
      to: text_2
      flags:
        - 'r'
        - 'i'
  mime_types: *

    • cors

      Группа параметров для обработки CORS запросов.

      Тип параметра: группа параметров и их значения.

      По умолчанию: не имеет значения по умолчанию.

      Обязательные параметры:

      • origin_wl

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

        Тип параметра: строковое значение.

        По умолчанию: не имеет значения по умолчанию.

      • method_wl

        В значении параметра определяется белый список для метода запроса. Значение используется в запросе для предварительной проверки.

        method_wl:
  - get
  - post

        Тип параметра: последовательность строковых значений.

        • get;

        • head;

        • post;

        • put;

        • connect;

        • options;

        • trace;

        • patch;

        • delete.

        По умолчанию: не имеет значения по умолчанию.
        Опциональные параметры:

      • origin_wl_type

        В значении параметра определяется тип для директивы origin_wl.

        • «re» — белый список для заголовка Origin со значениями регулярных выражений;

        • «recl» — белый список для заголовка Origin со значениями регулярных выражений без регистра.

        Тип параметра:

        • «re»;

        • «recl».

        По умолчанию: если не указано иное, используется полное совпадение.

      • origin_allow_null_wl

        В значении параметра определяется белый список со всеми допустимыми хостами, для которых разрешен «Origin: null» в запросе.

        Тип параметра: строковое значение.

        По умолчанию: не имеет значения по умолчанию.

      • origin_allow_null_wl_type

        В значении параметра определяется тип для директивы origin_allow_null_wl.

        • «re» — белый список со значениями регулярных выражений;

        • «recl» — белый список со значениями регулярных выражений без регистра.

        Тип параметра:

        • «re»;

        • «recl».

        По умолчанию: если не указано иное, используется полное совпадение.

      • deny_status

        В значении параметра указывается статус отказа при сбое проверки cors.

        Тип параметра: текстовое значение. Диапазон от 400 до 599.

        По умолчанию:

        deny_status: 403

    • set_output_headers

      Последовательность параметров, позволяющая устанавливать заголовки в ответе клиенту с указанием условий их выставления.

      Тип параметра: группа параметров и их значения.

      По умолчанию: не имеет значения по умолчанию.

      Обязательные параметры:

      • headers

        В значении параметра определяется строка заголовка.

        - headers:
  - X-MyHeader foo

        Тип параметра: последовательность строковых значений.

        По умолчанию: не имеет значения по умолчанию.

      Опциональные параметры:

      • status_codes

        В значении параметра указывается критерий для кода состояния.

        status_codes:
  - 400
  - 403
  - 500

        Тип параметра: последовательность текстовых значений. Диапазон от 100 до 599.

        По умолчанию: не имеет значения по умолчанию.

      • content_types

        В значении параметра указывается критерий для типа содержимого в заголовках ответов.

        content_types:
  - text/html

        Тип параметра: последовательность строковых значений.

        По умолчанию: не имеет значения по умолчанию.

      • conditions

        В значении параметра определяется файл условий для заголовков. Есть возможность использовать регулярное выражение.

        Тип параметра: строковое значение.

        По умолчанию: не имеет значения по умолчанию.

      • conditions_reverse*

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

        Используется в случае:

        • conditions is not None.

        Тип параметра:

        • true;

        • false.

        По умолчанию: не имеет значения по умолчанию.

      • set_var

        В значении параметра устанавливается переменная для использования в этих заголовках.

        set_var: $orig_xff $http_x_forwarded_for

        Тип параметра: строковое значение.

        По умолчанию: не имеет значения по умолчанию.

      • value_regex

        Обновляет существующий заголовок, если его текущее значение соответствует указанному регулярному выражению. Например, „~session=.“.

        Тип параметра: текстовое значение.

    • set_input_headers

    Последовательность параметров, позволяющая устанавливать заголовки в запросе на upstream с указанием условий их выставления.

    Тип параметра: последовательность параметров и их значения.

    По умолчанию: не имеет значения по умолчанию.

    Обязательные параметры:

    • headers

      В значении параметра определяется строка заголовка.

      - headers:
  - X-MyHeader foo

      Тип параметра: последовательность строковых значений.

      По умолчанию: не имеет значения по умолчанию.

    Опциональные параметры:

    • content_types

      В значении параметра указывается критерий для типа содержимого в заголовках ответов.

      content_types:
  - text/html

      Тип параметра: последовательность строковых значений.

      По умолчанию: не имеет значения по умолчанию.

    • conditions

      В значении параметра определяется файл условий для заголовков. Есть возможность использовать регулярное выражение.

      Тип параметра: строковое значение.

      По умолчанию: не имеет значения по умолчанию.

    • conditions_reverse

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

      Используется в случае:

      • conditions is not None.

      Тип параметра:

      • true;

      • false.

      По умолчанию: не имеет значения по умолчанию.

    • set_var

      В значении параметра устанавливается переменная для использования в этих заголовках.

      set_var: $orig_xff $http_x_forwarded_for

      Тип параметра: строковое значение.

      По умолчанию: не имеет значения по умолчанию.