Install and configure the Comm Broker

The following topics describe how to install and uninstall a Comm Broker.

To install the Comm Broker:

Unzip the the Comm Broker file.
Unzip the bootstrap certificate in the ./shared/certs/ folder.

Modify the default configuration in the file ./run_sender.sh, or use environment variables, to set the values for the following parameters:

SENDERID: A numerical ID for the Comm Broker. You can use any numerical value you want, but it must be unique within your tenant. If you have multiple Comm Brokers, each one must have a unique SENDERID.
SENDERNAME: A descriptive name for the Comm Broker.
TAPURL: The fully qualified domain name of your Helix Enterprise instance. For example, https://hexABC123.receiver.apps.fireeye.com:443, where you replace ABC123 with your unique ID.
META_I: Any information you would like to include as metadata. For example, if you are setting up a dedicated Comm Broker to collect certain types of events, you can add that information here.
TCP_PORT: The port number you want to use to configure TCP
UDP_PORT: The port number you want to use to configure UDP.
SSL: Configure the SSL security protocol parameters.

This is an example of the parameters you need to modify in the run_sender.sh script:

**** DEFAULT configuration in run_sender.sh ****

# Configurable values
# Set ports to 0 or blank to disable the associated input type
DEFAULT_SENDERID=123456789
DEFAULT_SENDERNAME=senderName
DEFAULT_TAPURL=https://hexXXXYYY.receiver.apps.fireeye.com:443
DEFAULT_META_I=meta_i
DEFAULT_JSON_TCP_PORT=1026
DEFAULT_SYSLOG_UDP_PORT=1027
DEFAULT_SYSLOG_TCP_PORT=1027

DEFAULT_JSON_SSL_PORT=0
DEFAULT_JSON_SSL_CA=ca.crt
DEFAULT_JSON_SSL_CERT=commbroker.pem
DEFAULT_JSON_SSL_KEY=commbroker
DEFAULT_JSON_SSL_REQUIRE_CERT=TRUE
DEFAULT_SYSLOG_SSL_PORT=0
DEFAULT_SYSLOG_SSL_CA=ca.crt
DEFAULT_SYSLOG_SSL_CERT=commbroker.pem
DEFAULT_SYSLOG_SSL_KEY=commbroker
DEFAULT_SYSLOG_SSL_REQUIRE_CERT=TRUE


**** Use Environment variables **** 

export SENDERID=123123
export SENDERNAME=env123
export TAPURL=https://hexabc123.receiver.apps.fireeye.com:443
export META_I=env123
export SYSLOG_TCP_PORT=1234
export SYSLOG_UDP_PORT=1234
export JSON_TCP_PORT=4321

export SYSLOG_SSL_PORT=8443
export SYSLOG_SSL_CA=ca.pem
export SYSLOG_SSL_CERT=pub.crt
export SYSLOG_SSL_KEY=priv.key
export SYSLOG_SSL_REQUIRE_CERT=FALSE
export JSON_SSL_PORT=8444
export JSON_SSL_CA=ca.pem
export JSON_SSL_CERT=pub.crt
export JSON_SSL_KEY=priv.key
export JSON_SSL_REQUIRE_CERT=FALSE

In the top-level folder, use the following command to run the script:
```
sh run_sender.sh
```