RudderStack Config Generator

Rudderstack has two components - the Control Plane and the Data Plane. The Data Plane reliably delivers your event data. The Control Plane manages the configuration of your sources and destinations. This configuration can also be read from a file instead of the Control Plane if you don't wish to use our hosted Control Plane.

The RudderStack Config Generator provides the UI to manage the source and destination configurations without needing to signup, etc. All the source and destination configurations stay on your local storage. You can simply export or import the configurations to a JSON file.

Setup

Follow the instructions below to start RudderStack Config Generator.

• Clone this repository.

  $ git clone https://github.com/rudderlabs/rudder-server.git

• Navigate to utils/config-gen directory.

  $ cd rudder-server/utils/config-gen

• Install dependencies using npm. Please make sure that Node.js 10.6 and npm are installed.

  $ npm install

• Start RudderStack Config Generator

  $ npm start

The RudderStack Config Generator starts on the port 3000 i.e., http://localhost:3000.

On a successful setup, you should see the following:

Exporting Workspace Configuration

After adding the required sources and destinations, you can export your workspace configuration. This workspace config is required by the RudderStack Server. To learn more about adding sources and destinations in RudderStack, refer to our documentation on Adding a Source and Destination in RudderStack.

To export the workspace configuration, click on the EXPORT button present at the right top of the Connections page. Keep a note of the downloaded workspace configuration file location.

Start RudderStack With The Exported Workspace Config File

For RudderStack to pick up the exported workspace config file, you need to do the following.

If you are running RudderStack in docker

• Open rudder-docker.yml.
• Uncomment volumes section under backend service. Replace <absolute_path_to_workspace_config> with the absolute path of the downloaded workspace configuration file location.
• In environment section under backend service, add the environment variable RSERVER_BACKEND_CONFIG_CONFIG_FROM_FILE=true.

If you have done Native RudderStack Installation

• Open .env file.
• Add RSERVER_BACKEND_CONFIG_CONFIG_FROM_FILE=true to the file
• Also add RSERVER_BACKEND_CONFIG_CONFIG_JSONPATH=<absolute_path_to_workspace_config>. Replace <absolute_path_to_workspace_config> with the absolute path of the downloaded workspace configuration file location.

If you have setup RudderStack on developer machine

• Open config/config.toml. Set configFromFile to true and configJSONPath to the absolute path of the downloaded workspace configuration file location.

Contact Us

In case you come across any issues while using the RudderStack Config Generator, please feel free to contact us. You can also start a conversation on our Discord channel. We will be happy to help you!