Getting Started on a Linux Computer

Prerequisites

To run RemotiveBroker on your Linux computer you need to install Docker and Docker Compose. For instructions on how to install it on your Linux distribution visit the Docker documentation here. Once Docker is installed you need to install the Docker Compose plugin, follow the instructions for your distribution here.

All examples should work with both Docker Compose V1 and V2, but they have different command-line syntax.

Docker Compose V1

docker-compose

Docker Compose V2

docker compose

What are the differences between Compose V1 and Compose V2?

Getting started

By following the steps below you will start the RemotiveBroker and RemotiveBrokerApp on your computer, the RemotiveBrokerApp will be available on http://127.0.0.1:8080/.

The commands below should be executed in your terminal.

Clone the RemotiveBroker bootstrap repository

git clone https://github.com/remotivelabs/remotivebroker-bootstrap

Change directory to the cloned repository

cd remotivebroker-bootstrap

Start the services with docker compose

docker compose up

It is also possible to start the services in detached mode, which run the services in the background on your computer. Doing this will also make sure the services are started when you start your computer.

docker compose up -d

note

RemotiveBroker and RemotiveBrokerApp will by default need access to port 50051 and 8080 on your computer. If you have anything running on these ports you will need to exit that program first.