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.

Sign up for a 14-day free trial for RudderStack Cloud, the easiest way to use RudderStack.

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).

How to Send Test Events

Clone the Github Repo

git clone

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>
Sending Test Events

writeKey is different from the your_workspace_token. The former is associated with the source, while the latter is for your account.

  • 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.