RudderStack has two major 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. This configuration can also be read from an external JSON 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 the need to sign up. All the source and destination configurations stay on your local storage. You can simply export or import the configurations to a JSON file.
Before setting up the RudderStack Config Generator, make sure you have RudderStack installed locally. You can find the instructions for setting up RudderStack for the platform of your choice below:
Instructions for Docker
Instructions for Kubernetes
Instructions for a Native Installation
Instructions for a Developer Machine Setup
In order to set up the RudderStack Config Generator, you will need to run the following commands in the specified order:
On successful setup, you should be able to see the following UI:
After you add the required sources and destinations in the dashboard as shown above, you can export your workspace configuration by simply clicking the EXPORT button. The configuration is then exported and saved as a JSON file. This workspace configuration is required to start the RudderStack server.
To read the workspace configuration from the exported JSON file, you can update the config variables
To start RudderStack with the workspace configuration, please follow these steps:
Download the workspace configuration file on your machine
docker-compose.yml, uncomment the
volumes section under the
backend service. Then, specify the path to your workspace configuration file
build/docker.env, set the environment variable
In case you come across any issues while setting up or 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!