Versions Compared

Old Version 18

changes.mady.by.user Wes Johnson

Saved on

compared with

New Version Current

changes.mady.by.user Wes Johnson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


HTML
<div style="background-color: yellow; border: 2px solid red; margin: 4px; padding: 2px; font-weight: bold; text-align: center;">
Sparkplug SiteWise Bridge has been renamed to <a href="https://docs.chariot.io/display/CLD80/IBAS%3A+Configuration">IoT Bridge for SiteWise</a>. You will be redirected to the new documentation.
<br>
Click in the link above if you are not automatically redirected in 10 seconds.
</div>
<meta http-equiv="refresh" content="10; URL='https://docs.chariot.io/display/CLD80/IBAS%3A+Configuration'" />

Configuration Options

Sparkplug SiteWise Bridge is configured with a configuration file on the filesystem of the EC2 instance. If you are unfamiliar with how to access the instance see this page for access instructions. Also note, after modifying the configuration the application must be restarted. This can be done with the following command.

Code Block
languagebash
sudo /etc/init.d/ssb restart

The path to the configuration file is:

/opt/ssb/conf/ssb.properties

Once you open the file, you will see the following options.

Code Block
languagetext
# The MQTT Server URL
mqtt_server_url = ssl://REPLACE_WITH_MQTT SERVER_ENDPOINT:8883

# The MQTT Server name
mqtt_server_name = My MQTT Server

# The MQTT username (if required by the MQTT Server)
#mqtt_username =

# The MQTT password (if required by the MQTT Server)
#mqtt_password =

# The MQTT keep-alive timeout in seconds
mqtt_keepalive_timeout = 30

# The path to the TLS Certificate Authority certificate chain
#mqtt_ca_cert_chain_path =

# The path to the TLS certificate
#mqtt_client_cert_path =

# The path to the TLS private key
#mqtt_client_private_key_path =

# The TLS private key password
#mqtt_client_private_key_password =

# Whether or not to verify the hostname against the server certificate
#mqtt_verify_hostname = false

# Whether or not to block auto-rebirth requests
#block_auto_rebirth = false

# The primary host ID if this is the acting primary host
#primary_host_id =

# The MQTT Client ID
# It is recommend to not set this unless there is a specific reason to do so. If this is not set a random client ID will be automatically generated
#client_id =

Configuration Examples

If you are using AWS IoT Core then your configuration file should look similar to the one below.

Code Block
languagetext
# The MQTT Server URL
mqtt_server_url = ssl://b9ffnzzzzzzzz-ats.iot.us-east-1.amazonaws.com:8883

# The MQTT Server name
mqtt_server_name = AWS IoT Core

# The MQTT username (if required by the MQTT Server)
# NOT USED FOR AWS IOT
#mqtt_username = admin

# The MQTT password (if required by the MQTT Server)
# NOT USED FOR AWS IOT
#mqtt_password = changeme

# The MQTT keep-alive timeout in seconds
mqtt_keepalive_timeout = 30

# The path to the TLS Certificate Authority certificate chain
mqtt_ca_cert_chain_path = /opt/ssb/conf/certs/AmazonRootCA1.pem

# The path to the TLS certificate - this is provisioned in the AWS IoT Console
mqtt_client_cert_path = /opt/ssb/conf/certs/72d382zzzz.cert.pem

# The path to the TLS private key - this is provisioned in the AWS IoT Console
mqtt_client_private_key_path = /opt/ssb/conf/certs/72d382zzzz.private.key

# The TLS private key password
# NOT USED FOR AWS IOT
#mqtt_client_private_key_password =

# Whether or not to verify the hostname against the server certificate
#mqtt_verify_hostname = false

# Whether or not to block auto-rebirth requests
#block_auto_rebirth = false

# The primary host ID if this is the acting primary host
# NOT POSSIBLE FOR AWS IOT
#primary_host_id =

# The MQTT Client ID
# It is recommend to not set this unless there is a specific reason to do so. If this is not set a random client ID will be automatically generated
# NOT USED FOR AWS IOT
#client_id =

If you are using Cirrus Link's Chariot MQTT Server using a real signed TLS certification then your configuration file should look similar to the one below.

Code Block
languagetext
# The MQTT Server URL
mqtt_server_url = ssl://chariot.mycompany.com:8883

# The MQTT Server name
mqtt_server_name = Chariot MQTT Server

# The MQTT username (if required by the MQTT Server)
# THIS IS PROVISIONED IN CHARIOT MQTT SERVER
mqtt_username = admin

# The MQTT password (if required by the MQTT Server)
# THIS IS PROVISIONED IN CHARIOT MQTT SERVER
mqtt_password = changeme

# The MQTT keep-alive timeout in seconds
mqtt_keepalive_timeout = 30

# The path to the TLS Certificate Authority certificate chain
# GENERALLY NOT REQUIRED IF USING A REAL SIGNED TLS CERTIFICATE
#mqtt_ca_cert_chain_path =

# The path to the TLS certificate - this is provisioned in the AWS IoT Console
# NOT USED WITH CHARIOT
#mqtt_client_cert_path =

# The path to the TLS private key - this is provisioned in the AWS IoT Console
# NOT USED WITH CHARIOT
#mqtt_client_private_key_path =

# The TLS private key password
# NOT USED WITH CHARIOT
#mqtt_client_private_key_password =

# Whether or not to verify the hostname against the server certificate
# RECOMMENDED FOR CHARIOT MQTT SERVER
mqtt_verify_hostname = true

# Whether or not to block auto-rebirth requests
#block_auto_rebirth = false

# The primary host ID if this is the acting primary host
# NOT POSSIBLE FOR AWS IOT
#primary_host_id =

# The MQTT Client ID
# It is recommend to not set this unless there is a specific reason to do so. If this is not set a random client ID will be automatically generated
# NOT USED FOR AWS IOT
#client_id =