Deploy runner with docker-compose
Last updated
Was this helpful?
Last updated
Was this helpful?
First, you need to have Docker installed on your server. If not already installed, please follow instructions from .
After installing Docker, you need the following files in a directory:
The runner-config.yaml file contains Brainboard runner configuration. You can modify this file to change the configuration of the runner. It's important to note that the runner-config.yaml file should be in the same directory as the docker-compose.yml file.
Before starting the runner for the first time, it is mandatory to update the runner.token configuration value in the runner-config.yaml file. Update this value with the private self-hosted runner token you generated from the Brainboard settings page.
This token should be unique and cannot be shared across multiple runners. If you use the same token on multiple runners, you will encounter issues when running CI/CD jobs.
To start the runner, open a terminal and navigate to the directory where you downloaded the docker-compose and runner-config files. The following command will start the runner in the background:
This operation only needs to be done once, when the runner is started for the first time.
To open a terminal inside the runner container, use the following command:
If you want to see the logs, you can run this command:
To stop the Brainboard runner, execute the following command:
Once the runner is started, you will need to register it with your organization. To do so, open a terminal inside the runner container () and run the following command: