---
title: "Ubuntu"
slug: "ubuntu"
updated: 2026-06-15T11:15:18Z
published: 2026-06-15T11:15:18Z
canonical: "docs.britive.com/ubuntu"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.britive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ubuntu

## Installing Broker on Ubuntu

1. Make sure you have completed all generic prerequisites mentioned in the [Prerequisites](/v1/docs/installing-and-configuring-broker-1#prerequisites) section.
2. Install OpenJDK 21 using the following command:

```shell
sudo apt install openjdk-21-jdk
```
3. Run the following command to verify Java installation:

```shell
$ java -version
```

1. Create a user and group *britivebroker* as a best practice before installing the broker:
  1. Creating a group:

```shell
sudo groupadd britivebroker
```
  2. Creating and adding a user to the group:

```shell
sudo useradd -g britivebroker britivebroker
```
2. The *britive-broker* Debian package has a dependency on the Debian package *openjdk-21-jre-headless*. If the *openjdk-21-jre-headless* package is not installed on the Debian system, run the following command to install it:

```shell
‘apt-get install openjdk-21-jre-headless’
```
3. Install the Debian package as the *root* user; the broker is installed at */opt/britive-broker*.

```shell
‘dpkg -i <path to the downloaded Debian package>’
```
4. If the user *britivebroker* and the group *britivebroker* are already present, they are not created; otherwise, a user and a user group with the name *britivebroker* are created.

```shell
The system user `britivebroker' already exists. Exiting.
Unpacking britive-broker (1.0.0-SNAPSHOT) over (1.0.0-SNAPSHOT) ...
Setting up britive-broker (1.0.0-SNAPSHOT) ...
```
5. The contents of the */opt/britive-broker* folder are:

```shell
drwxr-x--- 2 britivebroker britivebroker     4096 May 22 01:53 cache/
-rwxr-x--- 1 britivebroker britivebroker 26799984 Aug  6 20:19 britive-broker.jar*
drwxr-x--- 2 root          britivebroker     4096 Aug 13 18:59 bootstrap/
drwxr-xr-x 2 root          root              4096 Aug 13 18:59 config/
```
6. Change the directory to */opt*:

```shell
cd /opt
```
7. Verify if the owner of the folder britive-broker is britivebroker; if not, change the owner of the *britive-broker* directory:

```shell
sudo chown -R britivebroker:britivebroker britive-broker
```
8. Change directory to broker's config file:

```shell
cd /opt/britive-broker/config/
```
9. Rename the config file:

```shell
mv broker-config-template.yml broker-config.yml
```
10. Open and edit the broker configuration file (*broker-config.yml)* using vi. For more details about the configuration file, see the [Configure broker-config.yml file](/v1/docs/brokers-1#configuring-brokerconfigyml-file).

```shell
vi broker-config.yml
```
11. A list of brokers is updated on Britive after users download and install the broker package on their system.
12. Start the **Britive Broker** service.

```shell
systemctl service start britive-broker
```

## Upgrading Access Broker

There are two ways to upgrade an Access Broker on RHEL:

- Uninstalling and installing the broker package again:
  1. Uninstall the *Debian* or *RPM* package for the broker and install the desired version.
  2. Ensure */opt/britive-broker/conf/broker-config.yml* and */opt/britive-broker/conf/logback.xml* have not been modified after the upgrade.
- In-place upgrade, preserving the existing broker configuration files:
  1. Verify the current version of the broker package:

```shell
$ sudo dpkg -l | grep britive
```

Expected output example:

```shell
ii  britive-broker                     2.0.1                                   all          The britive broker service.
```
  2. Run the following command to perform the in-place upgrade, replacing the filename with the actual file path:

```shell
$ sudo apt install --upgrade ./britive-broker_2.1.0_all.deb
```
  3. Reload the configuration:

```shell
$ sudo systemctl daemon-reload
```
  4. Restart the broker service to load the new version:

```shell
$ sudo systemctl restart britive-broker.service
```
  5. Registers the service for auto-start:

```shell
$ sudo systemctl enable britive-broker.service
```
  6. Run the version query again to confirm the upgrade was successful:

```shell
$ sudo dpkg -l | grep britive
```

Expected output example:
  7. ```shell
ii  britive-broker                     2.1.0                                   all          The britive broker service.
```