Skip to content

Latest commit

 

History

History
112 lines (71 loc) · 4.55 KB

developer-machine-setup.md

File metadata and controls

112 lines (71 loc) · 4.55 KB
description
Step-by-step instructions to set up RudderStack on your developer machine.

Developer Machine Setup

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

Introduction

Installing and setting up RudderStack involves two key steps:

  • Control Plane setup
  • Data Plane setup

{% hint style="info" %} Refer to the RudderStack Architecture to know more about the RudderStack Control Plane and Data Plane. {% endhint %}

Control Plane Setup

There are two ways you can set up the Control Plane. This section lists the steps involved in each of them.

Use RudderStack-Hosted Control Plane

{% hint style="info" %} Why do I need to sign up for RudderStack?

RudderStack's dashboard lets you easily set up your data pipelines by configuring your sources and destinations. It is fully hosted by RudderStack and is free for open-source users. You also get access to some important features like Transformations and a Live Events tab. {% endhint %}

  • Note and copy your workspace Token from the top of the page, as shown below. This will be required for setting up the Data Plane.

Self-Host the Control Plane

{% hint style="warning" %} Use this option if you don't wish to sign up for RudderStack. {% endhint %}

You can self-host your own Control Plane using the open-source Control Plane Lite ****utility.

{% hint style="danger" %} Note that the Control Plane set up using Control Plane Lite lacks certain features like Transformations and Live Events tab. {% endhint %}

Data Plane Setup

This section lists the steps to set up the RudderStack Data Plane in your preferred development environment.

Prerequisites

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

For RudderStack-Hosted Control Plane

  • First, 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";
  • Next, clone the RudderStack server repository.
  • Then, run git submodule init and git submodule update to fetch the rudder-transformer repository.
  • Next, navigate to the Transformer directory using the following command:
cd rudder-transformer
  • Install dependencies using the command npm i . Then, start the destination transformer using the following command:
node destTransformer.js
  • Navigate back to the main directory using the command cd rudder-server.
  • Next, copy the sample.env to the main directory using the following command:
cp config/sample.env .env
  • Update theWORKSPACE_TOKEN environment variable in this file with the workspace token you copied from the RudderStack dashboard.
  • Finally, run the RudderStack server using the following command:
go run -mod=vendor main.go
  • Once you have completed these steps above successfully, send test events to verify the installation.

For Self-Hosted Control Plane

If you have self-hosted the Control Plane using the open-source Control Plane Lite ****utility, follow these instructions to set up the RudderStack Data Plane in your development environment.

Once you have successfully followed the steps above, send test events to verify the installation.

Contact Us

If you come across any issues while setting up RudderStack, you can contact us or start a conversation on our Slack channel.