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	-1
certificate_name	SSL Certificate Name. If https_port is not -1, this should be specified	N/A
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,
  "link_prefix": "broker-"
  "upstream": {
    "far-broker": {
      "name": "myBroker",
      "url": "http://localhost:8080/conn",
      "enabled": true,
      "token": null
    }
  }
}