Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The gRPC-Web
plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
, tcp
, tls
, tls_passthrough
, udp
, ws
, wss
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
name
string requiredThe name of the plugin, in this case
grpc-web
. -
instance_name
stringAn optional custom name to identify an instance of the plugin, for example
grpc-web_my-service
. Useful when running the same plugin in multiple contexts, for example, on multiple services. -
service.name or service.id
stringThe 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|SERVICE_ID/plugins
. -
route.name or route.id
stringThe 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|ROUTE_ID/plugins
. -
consumer.name or consumer.id
stringThe 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|CONSUMER_ID/plugins
. -
enabled
boolean default:true
Whether this plugin will be applied.
-
config
record required-
proto
stringIf present, describes the gRPC types and methods. Required to support payload transcoding. When absent, the web client must use application/grpw-web+proto content.
-
pass_stripped_path
booleanIf set to
true
causes the plugin to pass the stripped request path to the upstream gRPC service (see thestrip_path
Route attribute).
-
allow_origin_header
string default:*
The value of the
Access-Control-Allow-Origin
header in the response to the gRPC-Web client. The default of*
is appropriate for requests without credentials. In other cases, specify the allowed origins of the client code. For more information, see MDN Web Docs - Access-Control-Allow-Origin.
-