Generic

Installing and Configuring Broker

Install .jar, .tar, .zip packages using the following steps:

1. Make sure you have completed all generic prerequisites mentioned in the Prerequisites section.

2. Install the broker with the downloaded package:

   • jar:

     1. You must have Java installed on your system, and the environment should be configured to run this file.

     2. Download the JAR file into a folder.

     3. Create folders (cache, config, bootstrap) where the JAR file is downloaded, using the following command:

        mkdir -p britive-broker/cache britive-broker/config britive-broker/bootstrap

     4. Create the broker-config.yml file under the config folder. To configure the file, see the Configure broker-config.yml file.

     5. Bootstrap the broker:

        1. If the Java command is running from the folder that has config/, cache/, and bootstrap/folders under it, use the following command:

           java -Xms5M -Xmx50M -jar /path/to/jar_file.jar

        2. If the Java command is running from any other folder, use the following command:

           java -Dbritive.broker.config=/path/to/broker-config.yml -Xms5M -Xmx50M -jar /path/to/jar_file.jar

   • tar:

     1. Locate the downloaded broker file and untar it using the following command:

        tar -xvf britive-broker.tar

     2. Create a bootstrap folder if you want to configure the resources and broker names; otherwise, it is optional. The cache and config folders are already available. Create a bootstrap folder using the following command:

        mkdir -p britive-broker/bootstrap

     3. Bootstrap the broker. To run this as a background service, add an ampersand (&) at the end of the Java command.

     4. If the Java command is running from the folder that has config/, cache/, and bootstrap/ folders under it, use the following command:

        java -Xms5M -Xmx50M -jar /path/to/jar_file.jar

     5. If the Java command is running from any other folder, use the following command:

        java -Dbritive.broker.config=/path/to/broker-config.yml -Xms5M -Xmx50M -jar /path/to/jar_file.jar

   • zip:

     1. Unzip and extract the files from the downloaded file:

        • Unzip the files using the following command on Windows:

          unzip britive-broker.zip

        • Unzip the files using the following command on Linux:

          tar -xf britive-broker.zip

     2. Bootstrap the broker:

        • If the Java command is running from the folder that has config/, cache/, and bootstrap/ folders under it, use the following command:

          java -Xms5M -Xmx50M -jar /path/to/jar_file.jar

        • If the Java command is running from any other folder, use the following command:

          java -Dbritive.broker.config=/path/to/broker-config.yml -Xms5M -Xmx50M -jar /path/to/jar_file.jarjava -Dbritive.broker.config=/path/to/broker-config.yml -Xms5M -Xmx50M -jar /path/to/jar_file.jar

3. Add and configure broker-config.yml. For more details about the configuration file, see the Configure broker-config.yml file.

4. A list of brokers is updated on Britive after users download and install the broker package on their system.

Upgrading Access Broker

1. Untar/unzip the package.

2. Follow the steps to install the broker as mentioned at the top of the article.