RudderStack is a customer data pipeline tool for collecting, routing and processing data from your websites, apps, cloud tools, and data warehouse.
More information on RudderStack can be found here.
Rudderstack has two components: control plane and 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 a file instead of from the control plane, if you want remove an extra dependency.
RudderStack Config Generator provides the UI to manage the source and destination configurations without needing to sign up. All the source and destination configuration stays on your local storage. You can export/import config to a JSON file.
npm installnpm start
RudderStack config generator starts on the default port i.e., http://localhost:3000. On a successful setup, you should see the following
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.
- Download the workspace config file on your machine.
- In
docker-compose.yml, uncommentvolumessection underbackendservice. Specify the path to your workspace config. - In
build/docker.env, set the environment variableRSERVER_BACKEND_CONFIG_CONFIG_FROM_FILE=true - Start RudderStack with
docker-compose up
After adding the required sources and destinations, export your source config for the sources. This source config is required by the RudderStack SDKs. After downloading the source config 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.
For more information and documentation related to the RudderStack Config Generator, check out our documentation.
We can make use of the addDestinationSource.js file in the src/scripts to generate the config code required automatically. Make use of the print functions to generate the code in the required format. Can alter the printConfig function to generate the config for either source/ destination. Can refer rudder stack webapp for more
If you come across any issues while configuring or using the RudderStack Config Generator, please feel free to start a conversation on our Slack channel. We will be happy to help you.