RudderStack Config Generator

RudderStack has two components - the Control Plane and the Data Plane. The Data Plane reliably delivers your event data, while the Control Plane manages the configuration of your sources and destinations.

The easiest way to manage these configurations is through RudderStack's Hosted Control Plane. It is free, requires no setup, and allows you to send events without any limitation.

You can also use the RudderStack Config Generator if you wish to manage the source and destination configurations locally, by exporting to or importing them from a JSON file.

Setup

Follow the instructions below to start the RudderStack Config Generator.

• Clone RudderStack Control Plane Lite repository.

  $ git clone https://github.com/rudderlabs/config-generator.git

• Navigate to Config Generator directory.

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

  $ npm install

• Start the RudderStack Config Generator

  $ npm start

Note: 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, please follow the steps below:

If you are running RudderStack on Docker:

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

For a 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 a developer machine:

• Open config/config.toml. Look for configFromFile and configJSONPath under [BackendConfig]. 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!