Native Installation

Detailed instructions on setting up a native RudderStack installation

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

Please follow these steps to set up a native installation of RudderStack:

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";
  • Go to the RudderStack dashboard and set up your account. Copy your workspace token from the top of the home page.

Why do I need this? RudderStack's dashboard (control plane) is where you can setup sources, destinations, and transformations. RudderStack hosts the control plane and is free for OSS users. You can also use our open-source config-generator if you don't want to use the hosted control plane (the config generator lacks certain features like Transformations and LiveDebugger.)

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

mkdir rudder-server
  • Go to the RudderStack server page and download the latest binary for your target system. Then, 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 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
  • Install the dependencies using the command npm i . Then, 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 file sample.env into the previously created .env file.

  • Update theWORKSPACE_TOKEN environment variable with the token fetched from your RudderStack dashboard.

  • Run the backend server using the following command:

./rudder-server

Once you have successfully followed the steps above, follow our guide on How to Send Test Events in order to test if there are any issues with the installation.

Contact Us

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