Forward Proxy Advanced Configuration

You are browsing documentation for an outdated plugin version.

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 or plugin

  string required

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

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example forward-proxy_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• 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/{serviceName|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/{routeName|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/{consumerName|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

  • http_proxy_host

    string

    The HTTP hostname or IP address of the forward proxy to which to connect. Required if http_proxy_port is set.

    At least one of http_proxy_host or https_proxy_host must be specified.

    If http_proxy_host isn’t set, the plugin falls back to the value configured in https_proxy_host.

  • http_proxy_port

    integer between: 0 65535

    The TCP port of the HTTP forward proxy to which to connect. Required if http_proxy_host is set.

    At least one of http_proxy_port or https_proxy_port must be specified.

    If http_proxy_port isn’t set, the plugin falls back to the value configured in https_proxy_port.

  • https_proxy_host

    string

    The HTTPS hostname or IP address of the forward proxy to which to connect. Required if https_proxy_port is set.

    At least one of http_proxy_host or https_proxy_host must be specified.

    If https_proxy_host isn’t set, the plugin falls back to the value configured in http_proxy_host.

  • https_proxy_port

    integer between: 0 65535

    The TCP port of the HTTPS forward proxy to which to connect. Required if https_proxy_host is set.

    At least one of http_proxy_port or https_proxy_port must be specified.

    If https_proxy_port isn’t set, the plugin falls back to the value configured in http_proxy_port.

  • 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.

• proxy_host

  string
  Deprecation notice: This field has been deprecated and will be removed in a future version..

• proxy_port

  integer
  Deprecation notice: This field has been deprecated and will be removed in a future version..