Parameters
See plugin common configurations for configuration options available to all plugins.
uri
method
string
vaild vaule:
one of the
GET,POST,PUT,HEAD,DELETE,OPTIONS,MKCOL,COPY,MOVE,PROPFIND,LOCK,UNLOCK,PATCH, orTRACEHTTP method to rewrite requests to use.
regex_uri
array[string]
Regular expressions used to match the URI path from client requests and compose a new upstream URI path. When both
uriandregex_uriare configured,urihas a higher priority. The array should contain one or more key-value pairs, with the key being the regular expression to match URI against and value being the new upstream URI path.For example, with
["^/iresty/(. *)/(. *)", "/$1-$2", ^/theothers/*", "/theothers"], if a request is originally sent to/iresty/hello/world, the plugin will rewrite the upstream URI path to/iresty/hello-world; if a request is originally sent to/theothers/hello/world, the plugin will rewrite the upstream URI path to/theothers.host
headers
object
Header actions to be executed. Can be set to objects of action verbs
add,remove, and/orset; or an object consisting of headers to beset.When multiple action verbs are configured, actions are executed in the order of
add,remove, andset.add
object
Headers to append to requests. If a header already present in the request, the header value will be appended. Header value could be set to a constant, one or more built-in variables, or the matched result of
regex_uriusing variables such as$1-$2-$3.set
object
Headers to set to requests. If a header already present in the request, the header value will be overwritten. Header value could be set to a constant, one or more built-in variables, or the matched result of
regex_uriusing variables such as$1-$2-$3.Should not be used to set
Host.remove
array
Headers to remove from requests.
use_real_request_uri_unsafe
boolean
default:
falseIf true, bypass URI normalization and allow for the full original request URI. Enabling this option is considered unsafe.