Install and Set Up RudderStack

Detailed documentation on installing and setting up RudderStack from scratch on your platform of choice

This guide is aimed at helping you install and set up RudderStack correctly on a variety of platforms. Please feel free to reach out to us in case you are stuck anywhere in the process, or want more information on any of the topics covered below.

The easiest way to get started with RudderStack is to sign up for free on RudderStack Cloud Free.

You can also set up and use RudderStack on your platform of choice:

If you are planning to use RudderStack in production, we strongly recommend using the Kubernetes Helm charts. We update our Docker images with bug fixes more frequently than our GitHub repository (where we release once a month).

For routing and processing the events to the RudderStack backend, a Data Plane URL is required. Here's how to get the data plane URL:

  • If you're using the open-source version of RudderStack, you are required to set up your own data plane by installing and setting up RudderStack in your preferred dev environment.

  • If you're using the enterprise version of RudderStack, please contact us for the data plane URL with the email ID you used to sign up for RudderStack.

How to Send Test Events

Before sending test events to verify your RudderStack installation, you will first need to clone our Github repository using the following command:

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

Once you have installed and set up RudderStack on your target machine, please follow the steps below to test your RudderStack installation:

  • If you already have a Google Analytics account, keep the tracking ID handy. If not, please create one and get the tracking ID. The Google Analytics account needs to have a WebProperty (Web+App doesn't seem to work)

  • Create one source (Android or iOS) and configure a Google Analytics destination for the same with the above tracking ID

  • We have bundled a shell script that can generate test events. Get the source writeKey from the RudderStack dashboard and then run the following command:

./scripts/generate-event <YOUR_WRITE_KEY> https://hosted.rudderlabs.com/v1/batch
Sending Test Events

The write key is different from your workspace token. The former is associated with the source, while the latter is for your RudderStack account.

Workspace token vs Write Key
  • You can then login to your Google Analytics account and verify that events are delivered. Go to MainPage -> RealTime -> Events. RealTime view is important as the other dashboards can sometimes take 24 to 48 hours to refresh.

  • You can use our JavaScript, Android, or iOS SDKs for sending events from your app.

Contact Us

To know more about installing and setting up RudderStack, please feel free to reach out to us. You can also start a conversation on our Slack channel - we will be happy to talk to you.