Forward Proxy Advanced Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Forward Proxy Advanced plugin is compatible with the following protocols:

grpc, grpcs, http, https

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name

  string required

  The name of the plugin, in this case forward-proxy.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example forward-proxy_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/SERVICE_NAME|ID/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/ROUTE_NAME|ID/plugins.

• consumer.name or consumer.id

  string

  The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/CONSUMER_NAME|ID/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • x_headers

    string required default: append Must be one of: append, transparent, delete

    Determines how to handle headers when forwarding the request.

  • http_proxy_host

    string

    A string representing a host name, such as example.com.

  • http_proxy_port

    integer between: 0 65535

    An integer representing a port number between 0 and 65535, inclusive.

  • https_proxy_host

    string

    A string representing a host name, such as example.com.

  • https_proxy_port

    integer between: 0 65535

    An integer representing a port number between 0 and 65535, inclusive.

  • proxy_scheme

    string required default: http Must be one of: http

    The proxy scheme to use when connecting. Only http is supported.

  • auth_username

    string referenceable

    The username to authenticate with, if the forward proxy is protected by basic authentication.

  • auth_password

    string referenceable

    The password to authenticate with, if the forward proxy is protected by basic authentication.

  • https_verify

    boolean required default: false

    Whether the server certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.

Deprecated parameters

Important: The following fields have been deprecated and will be removed in a future version.
See the changelog for this plugin for new field mapping info.

• proxy_host

  string

• proxy_port

  integer