Native Installation

Step-by-step instructions on setting up a native RudderStack installation.

This is not the easiest way of installing RudderStack. Use this method only if you want to know more about the RudderStack internals.

Prerequisites

To set up a native installation of RudderStack, you will need to set up and install the following tools in your development environment:

Installation

  • 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";
  • Sign up and log into the RudderStack dashboard. Copy your workspace Token from the top of the page, as shown:

Why do I need to sign up on RudderStack?

RudderStack's dashboard (Control Plane) lets you set up your data pipelines by configuring event data sources and destinations. This dashboard is hosted by RudderStack and is free for open-source users.

If you don't wish to sign up for RudderStack, you can also set up your own control plane using the open-source RudderStack Config Generator. However, note that the control plane set up using the RudderStack Config Generator lacks certain features like Transformations and Live Events Debugger.

  • Create a directory for the RudderStack server using the following command:

mkdir rudder-server
  • Go to the RudderStack GitHub repository, download the latest binary for your target system, and move it to the rudder-server directory.

  • Create a directory for the RudderStack transformer using the following command:

mkdir rudder-transformer
  • Go to the RudderStack Transformer page in the GitHub repo and download the latest release package. Then, extract it in the rudder-transformer directory.

  • Navigate to the transformer directory using the following command:

cd rudder-transformer
  • Then, install the dependencies using the command npm i .

  • Next, start the destination transformer using the following command:

node destTransformer.js
  • Navigate back to the main directory using the command cd rudder-server.

  • Then, create a .env file, and copy the contents of the sample.env file into this .env file.

  • Update theWORKSPACE_TOKEN environment variable in this .env file with the token that you copied from your RudderStack dashboard.

  • Finally, run the RudderStack server using the following command:

./rudder-server

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

Contact Us

If you come across any issues while setting up your native RudderStack installation, feel free to contact us. You can also start a conversation on our Slack channel.