:::note
This page is automatically generated from code files. If you find something inaccurate, feel free to update org.apache.pulsar.websocket.service.WebSocketProxyConfiguration. Do NOT edit this markdown file manually. Manual changes will be overwritten by automatic generation.
:::
Name of the cluster to which this broker belongs to
Default: null
Dynamic: false
Category:
When this parameter is not empty, unauthenticated users perform as anonymousUserRole
Default: null
Dynamic: false
Category:
Enable authentication
Default: false
Dynamic: false
Category:
Authentication provider name list, which is a list of class names
Default: []
Dynamic: false
Category:
Allow wildcard matching in authorization (wildcard matching only applicable if wildcard-char: presents at first or last position. For example: .pulsar.service,pulsar.service.)
Default: false
Dynamic: false
Category:
Enforce authorization
Default: false
Dynamic: false
Category:
Authorization provider fully qualified class name
Default: org.apache.pulsar.broker.authorization.PulsarAuthorizationProvider
Dynamic: false
Category:
Hostname or IP address the service binds on, default is 0.0.0.0.
Default: 0.0.0.0
Dynamic: false
Category:
Proxy authentication parameters used to connect to brokers
Default: null
Dynamic: false
Category:
Proxy authentication settings used to connect to brokers
Default: null
Dynamic: false
Category:
Enable TLS of broker client
Default: false
Dynamic: false
Category:
Path for the trusted TLS certificate file for outgoing connection to a server (broker)
Default: ``
Dynamic: false
Category:
The broker binary service URL (for produce and consume operations)
Default: null
Dynamic: false
Category:
The secured broker binary service URL (for produce and consume operations)
Default: null
Dynamic: false
Category:
Connection string of configuration metadata store servers
Default: null
Dynamic: false
Category:
Capacity for accept queue in the HTTP server Default is set to 8192.
Default: 8192
Dynamic: false
Category:
Capacity for thread pool queue in the HTTP server Default is set to 8192.
Default: 8192
Dynamic: false
Category:
Max concurrent web requests
Default: 1024
Dynamic: false
Category:
Maximum number of inbound http connections. (0 to disable limiting)
Default: 2048
Dynamic: false
Category:
Metadata store cache expiry time in seconds.
Default: 300
Dynamic: false
Category:
Metadata store session timeout in milliseconds.
Default: 30000
Dynamic: false
Category:
Number of threads to used in HTTP server
Default: 8
Dynamic: false
Category:
Key-value properties. Types are all String
Default: {}
Dynamic: false
Category:
The HTTPS REST service URL to connect to broker
Default: null
Dynamic: false
Category:
The HTTPS REST service TLS URL
Default: null
Dynamic: false
Category:
Path for the file used to determine the rotation status for the broker when responding to service discovery health checks
Default: null
Dynamic: false
Category:
Role names that are treated as “super-user”, which means they can do all admin operations and publish to or consume from all topics
Default: []
Dynamic: false
Category:
Accept untrusted TLS certificate from client
Default: false
Dynamic: false
Category:
TLS cert refresh duration (in seconds). 0 means checking every new connection.
Default: 300
Dynamic: false
Category:
Path for the TLS certificate file
Default: null
Dynamic: false
Category:
Enable TLS with KeyStore type configuration for WebSocket
Default: false
Dynamic: false
Category:
Path for the TLS private key file
Default: null
Dynamic: false
Category:
TLS KeyStore path in WebSocket
Default: null
Dynamic: false
Category:
TLS KeyStore password for WebSocket
Default: null
Dynamic: false
Category:
TLS KeyStore type configuration in WebSocket: JKS, PKCS12
Default: JKS
Dynamic: false
Category:
Specify the TLS provider for the WebSocket service: SunJSSE, Conscrypt and etc.
Default: Conscrypt
Dynamic: false
Category:
Specify whether client certificates are required for TLS rejecting the connection if the client certificate is not trusted
Default: false
Dynamic: false
Category:
Path for the trusted TLS certificate file
Default: ``
Dynamic: false
Category:
TLS TrustStore path in WebSocket
Default: null
Dynamic: false
Category:
TLS TrustStore password for WebSocket, null means empty password.
Default: null
Dynamic: false
Category:
TLS TrustStore type configuration in WebSocket: JKS, PKCS12
Default: JKS
Dynamic: false
Category:
Port to use to server HTTP request
Default: Optional[8080]
Dynamic: false
Category:
Port to use to server HTTPS request
Default: Optional.empty
Dynamic: false
Category:
Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake.
Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]
Default: []
Dynamic: false
Category:
Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake.
Example:- [TLSv1.3, TLSv1.2]
Default: []
Dynamic: false
Category:
Number of connections per broker in Pulsar client used in WebSocket proxy
Default: 8
Dynamic: false
Category:
Maximum size of a text message during parsing in WebSocket proxy
Default: 1048576
Dynamic: false
Category:
Number of IO threads in Pulsar client used in WebSocket proxy
Default: 8
Dynamic: false
Category:
Number of threads used by Websocket service
Default: 20
Dynamic: false
Category:
Timeout of idling WebSocket session (in milliseconds)
Default: 300000
Dynamic: false
Category:
Configuration store connection string (as a comma-separated list). Deprecated in favor of configurationMetadataStoreUrl
Default: null
Dynamic: false
Category:
Configuration Store connection string
Default: null
Dynamic: false
Category:
ZooKeeper cache expiry time in seconds. @deprecated - Use metadataStoreCacheExpirySeconds instead.
Default: -1
Dynamic: false
Category:
ZooKeeper session timeout in milliseconds. @deprecated - Use metadataStoreSessionTimeoutMillis instead.
Default: -1
Dynamic: false
Category: