Downloading Rudder

Please follow these steps to set up RudderStack directly from our dashboard:

  1. Go to the RudderStack dashboard at https://app.rudderlabs.com and set up your account.
  2. Enable the RudderStack Hosted Service option from the top right corner of the page after you login, as shown:
  3. You should see a confirmation message asking you to replace the data plane URL in your client SDKs. Click on OK if you agree.

How to Send Test Events

Sending test events from RudderStack is very easy. Please follow these steps:

  1. 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 Web Property (Web+App doesn’t work)
  2. Create one source (JavaScript) and configure a Google Analytics destination for the same with the above tracking ID. Note down the writeKey for the source.
  3. Download this script index.html. Update the WRITE_KEY (search for Replace for Hosted Version in the file) to the writeKey above.

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

  4. Open the file in the browser. This will fire a test event.
  5. You can then login to your Google Analytics account and verify that events are delivered. Go to MainPageRealTimeEventsRealTime view is important as the other dashboards can sometimes take 24 to 48 hours to refresh.
  6. You can now use our JavaScriptAndroid or iOS SDKs for sending events from your app.
The Docker setup is the easiest and fastest way to try out RudderStack. Simply follow these steps:

  1. Go to the RudderStack dashboard at https://app.rudderlabs.com and set up your account. Copy your workspace token from top of the home page.
  2. Clone the RudderStack Server repository using the following commands:

    Important: Please note that SSH clone is important, and that HTTPS won’t work.

    
      $ git clone git@github.com:rudderlabs/rudder-server.git
      $ cd rudder-server
      $ git submodule init
      $ git submodule update
    
    Git
  3. Replace <your_workspace_token> in build/docker.env with the workspace token you have copied above.
  4. [Optional Step]: Uncomment and set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY in build/docker.env if you want to add Amazon S3 as a destination on the UI.
  5. Run the command docker-compose up --build to bring up all the services.

Here is a quick demonstration of how you can set up RudderStack on Docker, and set up a connection between your source and destination:


How to Send Test Events

Sending test events from RudderStack is very easy. Please follow these steps:

  1. 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 Web Property (Web+App doesn’t work)
  2. Create one source (JavaScript) and configure a Google Analytics destination for the same with the above tracking ID. Note down the  writeKey for the source.
  3. We have bundled a shell script that can generate test events. Get the source writeKey from our app dashboard and then run the following command:
    cd scripts; ./generate-event <writeKey Here> http://localhost:8080/v1/batch

Important: 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 MainPageRealTimeEventsRealTime view is important as the other dashboard can sometimes take 24 to 48 hours to refresh.
  • You can now use our JavaScriptAndroid or iOS SDKs for sending events from your app.

Please follow these steps to set up RudderStack on your Kubernetes cluster:

  1. Go to the RudderStack dashboard at https://app.rudderlabs.com and set up your account. Copy your workspace token from top of the home page.
  2. Clone this GitHub repository:
    
      $ git clone git@github.com:rudderlabs/rudderstack-helm.git
      $ cd rudderstack-helm/
      $ helm install my-release ./ --set rudderWorkspaceToken="< workspace token from the dashboard >"
    
    Git

Important: This method requires the Helm package manager to be installed, as well as kubectl connected to your Kubernetes cluster. For more information on how to install the RudderStack chart and the list of configurable parameters, please check out our GitHub page.

How to Send Test Events

Sending test events from RudderStack is very easy. Please follow these steps:

  1. 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 Web Property (Web+App doesn’t work)
  2. Create one source (JavaScript) and configure a Google Analytics destination for the same with the above tracking ID. Note down the writeKey for the source.
  3. Download this script index.html. Update the WRITE_KEY (search for Replace for Kubernetes Version in the file) to the writeKey above.

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

  4. Update the DATA_PLANE_URI with the one you get when you do the helm install. 
  5. Open the file in the browser. This will fire a test event.
  6. You can then login to your Google Analytics account and verify that events are delivered. Go to MainPageRealTimeEventsRealTime view is important as the other dashboard can sometimes take 24 to 48 hours to refresh.
  7. You can now use our JavaScriptAndroid or iOS SDKs for sending events from your app.