BSM Configuration bsm

The configuration for BSM is stored in:

/opt/blueworx/sm/config

This directory contains a sample configuration file bsm.config.sample and a directory named after the hostname of the VM (environment variable $BSM_CONF).

This hostname is automatically collected from the VM, however if it is incorrect, it can be changed. To do this:

modify /opt/blueworx/common/res/.hostname and change the name to your desired hostname.
move the /opt/blueworx/sm/config/<previously configured hostname> directory to /opt/blueworx/sm/config/<new hostname> with the following command:
mv /opt/blueworx/sm/config/<previously configured hostname> /opt/blueworx/sm/config/<new hostname>

Note: that if the /opt/blueworx/sm/config/<new hostname> does not exist, BSM will fail to start.

The actual configuration that BSM uses is stored in the file /opt/blueworx/sm/config/<hostname>/bsm.config, however if this file is corrupted or deleted, the sample configuration can be restored with the following command:

cp /opt/blueworx/sm/config/bsm.config.sample /opt/blueworx/sm/config/<hostname>/bsm.config

Note: All versions of the configuration file contain descriptions and examples of the setting of configuration options

See TOML Configuration File Format for details on the configuration file format.

Common configuration considerations

BSM can be installed either on the same machine as BVR or an entirely separate machine. When installing onto a machine that has a BVR instance on it you must configure the SIP stack to start on a different port (e.g. 5070) as BSM always uses its own SIP stack to REGISTER with registrars.

Some registrars do not follow the expected format when responding with a 401 Unauthorized challenge to let BSM supply appropriate credentials. To avoid these messages being discarded instead of processed, you may wish to set the ignore_sent_by_check configuration option to true in the [sip] configuration section.

When using some machines in the cloud, the externally available presentation IP address may be different from the default IP address of the machine. In this instance you will want to set the default_presentation_address in the [general] configuration section

Here are example settings for those configuration settings:

[general]
#   java_command = "java"
#   default_bind_address = "any"
   default_presentation_address = "3.134.118.216"
#   listening_address = "any"

...

[sip]

#   bind_address = "any"
#   presentation_address = "insert_address_here"
   ignore_sent_by_check = true
#   dns_servers =
#   dns_timeout = 5000
#   dns_failure_threshold = 3
#   ms_delay_before_retrying_failed_registrations = 60000

...

 [[sip.listening_point]]

   port = 5070
   protocol = ["TCP", "UDP"]

Note that you must set the protocol of [[sip.listening_point]]s as well as the port.

Setting up your registrars

For BSM to register with a registrar you need to both configure the registrar, bind to appropriate application mappings and set up the SIP Digest Credentials for the realm associated with it to allow BSM to pass authentication challenges made in response to registration attempts.

See BAM Command Line Utility SIP Registrars Panel and SIP Digest Credentials Panel