Open Source API Gateway
1. Proxies and Flow

stompProxy

Version

Proxies incoming STOMP CONNECT requests. Use a <stompClient> to forward these requests so some other machine.

Syntax

stompProxy:
'$ref': <string>
flow:
- <flow>
ip: <string>
name: <string>
port: <int>
ssl: {}
stompProxy:
  '$ref': <string>
  flow:
    - <flow>
  ip: <string>
  name: <string>
  port: <int>
  ssl: {}

Attributes

NameRequiredDefaultDescriptionExamples
$reffalse-Reference a component defined under components.-
ipfalsenot setIf present, binds the port only on the specified IP. Useful for hosts with multiple IP addresses.127.0.0.1
namefalseBy default, a name will be automatically generated from the target host, port, etc.The name as shown in the Admin Console.-
portfalse80The port Membrane listens on for incoming connections.8080

Child Structure

ElementCardinalityDescription
flow0..*
ssl0..1Configures a TLS context: the identity (key and certificate) presented to the peer, the certificates trusted from it, and handshake parameters such as protocol, ciphers, and client-certificate policy. Attach it to a serviceProxy/api to terminate inbound TLS, or to a target to make an outbound connection over TLS; most attributes and child elements apply to both directions, but a few - such as clientAuth and useAsDefault - only take effect on an inbound context. See tutorials/ssl-tls/10-TLS-Termination.yaml for inbound termination and tutorials/ssl-tls/20-Central-SSL-Config.yaml for sharing one ssl across several APIs via $ref.

Can be used in