Octopus
1.x
Open

Reading1 min
Updated31 Jul 2026
Sourcev1/configuration/grpc.mdx

gRPC

The grpc section configures gRPC proxying. For the protocol model, see the Protocols section.

Warning

These keys are currently display-only. The live gRPC handler is constructed with built-in defaults (GrpcHandler::new()) and does not read this block — from_config is never called — so enabled, max_message_size, enable_reflection, enable_grpc_web, deadline_propagation, and services are parsed and surfaced by the admin API but do not yet affect proxying. gRPC requests are proxied transparently over HTTP/2 (h2c) regardless. See Protocols → gRPC.

grpc:
  enabled: true
  max_message_size: 4194304
  enable_reflection: false
  enable_grpc_web: false
  deadline_propagation: true
  services:
    "users.UserService": user-service
    "orders.OrderService": order-service

grpc01

KeyTypeDefaultDescription
enabledbooleantrueEnable gRPC proxying.
max_message_sizeinteger (bytes)4194304 (4 MiB)Maximum gRPC message size.
enable_reflectionbooleanfalseEnable the gRPC reflection proxy.
enable_grpc_webbooleanfalseEnable gRPC-Web support (HTTP/1.1 compatible).
deadline_propagationbooleantruePropagate gRPC deadlines to upstreams.
servicesmap of string→string{}Explicit mapping from fully qualified gRPC service name to upstream name.
Note

services keys are fully qualified service names such as users.UserService; values are upstream names.