Skip to main content
Version: Release 23.1

Run Release Runner with Docker

This guide explains how to set up and run Release Runner using Docker.

note
  • Advanced networking setup and creation of Release tokens is not covered in this document. For more information about creating Release tokens, see Personal Access Token (PAT) Authentication.
  • Release and Runner are assumed to be running in separate networks.
  • Stable Release Runner images are available on Docker Hub under the xebialabs organization. For more information, see Docker Hub.

Run Release Runner with Docker​

To start Release Runner using Docker, use the following command:

docker run -d \
  --name release-runner \
  --network host \
  -e RELEASE_RUNNER_RELEASE_URL=<release-url> \
  -e RELEASE_RUNNER_TOKEN=rpa_<release-token> \
  -e RELEASE_RUNNER_PROFILE=docker \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /tmp:/tmp \
  xebialabs/release-runner:<release-version>
important

Specify values for <release-url>, <release-token>, and <release-version>. These options are required. Change the image tag to use a different version if needed.

On Linux, add the following option to grant the container access to the Docker socket:

--group-add <docker_group_id>

To find the Docker group ID, run:

getent group docker

Run Release Runner with Docker Compose​

You can use Docker Compose to configure and start Release Runner:

services:
  release-runner:
    image: xebialabs/release-runner:<release-version>
    environment:
      - RELEASE_RUNNER_RELEASE_URL=<release-url>
      - RELEASE_RUNNER_TOKEN=rpa_<release-token>
      - RELEASE_RUNNER_PROFILE=docker
    network_mode: host
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /tmp:/tmp

Start the service with:

docker compose -f file.yaml up
important

Specify values for <release-url>, <release-token>, and <release-version>. These options are required. Change the image tag to use a different version if needed.

On Linux, add the following to your Docker Compose file to grant the container access to the Docker socket:

    group_add:
      - <docker_group_id>

To find the Docker group ID, run:

getent group docker