Home

Configuring a Broker

Brokers have multiple configuration options. Edit your broker.json file to configure it.

Key	Description	Default Value
host	Bind Host	0.0.0.0
port	HTTP Port - If this is -1, HTTP will not be started	8080
https_port	HTTPS Port - If this -1, HTTPS will not be started	8443
sslCertificatePath	Path to SSL Certificate. If https_port is not -1, this should be specified	N/A
sslCertificatePassword	Password for the SSL Certificate. If SSL is enabled, this should not be null	N/A
sslKeyPath	Path to SSL private key. If https_port is not -1, this should be specified	N/A
sslKeyPassword	Password for the SSL private key. If SSL is enabled, this should not be null	N/A
downstreamName	Name of the downstream path	downstream
logLevel	Logging level, or verbosity, of the broker's logger.	info
quarantine	If links will be quarantined by default when connecting without an authentication token	false
allowAllLinks	If the broker should allow all links to connect. This overrides the quarantine value	true
link_prefix	DSLink Prefix for Broker	broker-
upstream	JSON Object of upstream objects	{}

Upstream Objects are configured as follows. Note the name of the upstream object is the name that will appear in the 'upstream' path for this broker.

Key	Description	Default Value
name	Name of this broker as it appears in upstream broker	"broker"
url	Remote address for the upstream broker	N/A
enabled	If the upstream connection is enabled or not	false
token	Token authentication for connection with upstream broker	null
group	Permission group to give the upstream broker for access to current broker	null

Example Configuration

{
  "host": "0.0.0.0",
  "port": 8080,
  "downstream": "downstream",
  "link_prefix": "broker-",
  "logLevel": "info",
  "allowAllLinks": true,
  "quarantine": false,
  "upstream": {
    "far-broker": {
      "name": "myBroker",
      "url": "http://localhost:8080/conn",
      "enabled": true,
      "token": null
    }
  }
}