RudderStack Developer Machine Setup

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

Prerequisites

• Go 1.17 or above.
• Node.js 14.17 or above.
• PostgreSQL 11 or above.

Data plane setup

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. Log in to your RudderStack Open Source dashboard.
2. Copy your workspace token from Settings > Workspace:

3. 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";

4. Clone the rudder-server repository:

git clone https://github.com/rudderlabs/rudder-server.git

5. Run the following commands to fetch the rudder-transformer repository.

git submodule init
git submodule update

6. Navigate to the rudder-transformer directory using the cd rudder-transformer command.
7. Install the dependencies using the npm i command.
8. Start the destination transformer:

node destTransformer.js

9. Navigate back to the main directory using the cd rudder-server command.
10. Copy sample.env to the main directory:

cp config/sample.env .env

11. Update WORKSPACE_TOKEN in this file with the workspace token you copied in Step 2.
12. Start the RudderStack server:

go run main.go

Self-hosted control plane

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

Verify installation

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

Questions? Contact us by email or on Slack