RudderStack Docker Setup

Set up RudderStack on Docker.

  •   2 minute read  

This guide will help you set up the RudderStack data plane in your Docker environment.

success
The Docker setup is the easiest and the fastest way to get up and running with RudderStack.

Data plane setup in Docker

  1. Download the rudder-docker.yml docker-compose file.
  2. Replace <your_workspace_token> in this file with your workspace token.
  3. In your terminal, navigate to the directory where you want to install RudderStack and run the following command:
docker compose -f rudder-docker.yml up -d
info

If you’re using an older version of Docker, run the following command:

docker-compose -f rudder-docker.yml up

Update setup

warning

RudderStack recommends using the latest rudder-server and rudder-transformer versions to avoid any breaking changes to your pipelines.

See the Server-Transformer Compatibility guide for more information.

  1. Stop the running container.
  2. Pull the images with the latest minor release for both rudder-server and rudder-transformer.
docker pull rudderlabs/rudder-server:<version>

docker pull rudderlabs/rudder-transformer:<version>
info

See the below rudder-docker.yml references to update specific image versions:

  1. Start the container.
  2. Test the container health with the /health endpoint.

Workspace token

The workspace token is a unique identifier of your RudderStack workspace. RudderStack uses this token to automatically read your source-destination configurations when you set up and run the data plane.

  1. Log in to your RudderStack Open Source dashboard.
  2. Copy your workspace token from Settings > Workspace:
Workspace Token

Self-hosted control plane

If you are self-hosting your control plane using Control Plane Lite, see Docker instructions to set up your data plane.

danger

Control Plane Lite is now deprecated and does not work with the latest rudder-server versions.

To set up and manage your connections, using the RudderStack-hosted control plane is strongly recommended.

Verify installation

To verify if the setup is successful, follow the steps listed in Verify installation.

Questions? Contact us by email or on Slack