arizz96/rudderstack-config-generator repository overview

⁠Rudder Config Generator

Rudderstack has two components control plane and data plane. Data plane reliably delivers your event data. Control plane manages the configuration of your sources and destinations. This configuration can also be read from a file instead of from Control plane, if we want remove an extra dependency.

Config-generator provides the UI to manage the source and destination configurations without needing to signup, etc. All the source and destination configuration stays on your local storage. You can export/import config to a JSON file.

⁠Setup

1. npm install
2. npm start

RudderStack config generator starts on the default port i.e., http://localhost:3000⁠. On a successful setup, you should see the following

⁠Export workspace config

After adding the required sources and destinations, export your workspace config. This workspace-config is required by the RudderStack Server. To learn more about adding sources and destinations in RudderStack, refer Adding a Source and Destination in RudderStack⁠

Update the config⁠ variables configFromFile and configJSONPath in rudder-server to read workspace config from the exported JSON file.

⁠Start RudderStack with the workspace config file

• Download the workspace config file on your machine.
• In docker-compose.yml, uncomment volumes section under backend service. Specify the path to your workspace config.
• In build/docker.env, set the environment variable RSERVER_BACKEND_CONFIG_CONFIG_FROM_FILE=true
• Start RudderStack with docker-compose up

⁠Export source config

After adding the required sources and destinations, export your source config for the sources. This source-config is required by the SDKs. After downloading the sourceConfig file, you need to host that file at a /sourceConfig end-point. Then you can specify that link as your controlPlaneUrl while initializing the SDK.

⁠Contact Us

If you come across any issues while configuring or using RudderStack, please feel free to contact us⁠ or start a conversation on our Slack⁠ channel. We will be happy to help you.