Install and Set Up RudderStack

Detailed documentation on installing and setting up RudderStack in your preferred environment.

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

Setup Instructions

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 much more frequently than our GitHub repository.

Send Test Events

Once you have installed RudderStack, follow this guide to send test events to verify your installation.

You can contact us for help if you're stuck at any stage of the setup process.

FAQs

What is a Data Plane URL? Where do I get it?

Refer to the RudderStack Architecture guide for more information the RudderStack Data Plane.

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:

An open-source Data Plane URL looks like http:localhost:8080 where 8080 is typically the port where your RudderStack Data Plane is hosted.

How to Check the Data Plane Status?

To check your Data Plane status, run the following command:

CURL <DATA_PLANE_URL>/health

A sample command to check the Data Plane status is as shown:

CURL https://hosted.rudderlabs.com/health

You will get the following output:

{"server":"UP", "db":"UP","acceptingEvents":"TRUE","routingEvents":"TRUE","mode":"NORMAL","goroutines":"15364", "backendConfigMode": "API", "lastSync":"2020-12-01T04:20:33Z", "lastRegulationSync":"2020-11-30T21:40:27Z"}

The RudderStack server supports two running modes:

  • Normal ("mode": "NORMAL"): In this mode, the RudderStack server runs as expected, and there are no issues.

  • Degraded ("mode": "DEGRADED"): RudderStack enters the degraded mode if it keeps crashing while processing the events after a threshold number of restarts is reached. RudderStack still receives and stores the events in this mode but does not process them and route them to your specified destinations.

For more information on the RudderStack Server running modes, refer to our High Availability guide.

Why Do I Need a RudderStack Account?

Using the RudderStack web app is the easiest way to set up and manage your event data sources, destinations and transformations.

The web app is only used for source/destination configuration and does not have access to your data. The Live Events console can be used to temporarily stream events for debugging purposes, but only for a limited time. RudderStack does not persist any of your data.

If you do not wish to sign up for RudderStack and want to self-host the Control Plane, you can do so using the open-source RudderStack Control Plane Lite utility.

Note that the Control Plane set up using the Control Plane Lite utility does not have features like Transformations and Live Events.

Contact Us

For any questions on installing and setting up RudderStack, feel free to contact us. You can also start a conversation on our Slack channel.