Developer Machine Setup

This guide lists the steps required to set up the RudderStack data plane (backend) in your development environment.

Setup prerequisites

To set up RudderStack, you will need to set up and install the following tools:

RudderStack-hosted control plane

If you're using a RudderStack-hosted control plane, follow these steps to set up the data plane in your development environment:

  1. Log into your RudderStack Open Source dashboard.
  2. Note and copy your workspace token from the top of the page, as shown:
RudderStack workspace token

The workspace token is required for setting up the data plane.

  1. Then, set up the database in your preferred directory using the following commands:
createdb jobsdb
createuser --superuser rudder
psql "jobsdb" -c "alter user rudder with encrypted password 'rudder'";
psql "jobsdb" -c "grant all privileges on database jobsdb to rudder";
  1. Next, clone the RudderStack server repository:
git clone https://github.com/rudderlabs/rudder-server.git
  1. Then, run git submodule init and git submodule update to fetch the rudder-transformer repository.
  2. Next, navigate to the rudder-transformer directory using the following command:
cd rudder-transformer
  1. Install the dependencies using the command npm i. Then, start the destination transformer using the following command:
node destTransformer.js
  1. Navigate back to the main directory using the command cd rudder-server.
  2. Copy sample.env to the main directory using the following command:
cp config/sample.env .env
  1. Update the WORKSPACE_TOKEN environment variable in this file with the workspace token you copied in Step 2.
  2. Finally, run the RudderStack server using the following command:
go run main.go

Self-hosted control plane

If you have self-hosted the control plane using the open-source Control Plane Lite utility, follow the Developer Machine Setup instructions to set up the RudderStack data plane in your development environment.

Sending test events

Once you have successfully performed the steps above, follow the Sending Test Events guide to verify the installation.

Contact us

If you come across any issues while setting up RudderStack in your development environment, you can contact us or start a conversation in our Slack community.

Contents