- Notifications
You must be signed in to change notification settings - Fork15
RudderStack Config Generator
RudderStack has two components - theControl Plane and theData 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'sHosted Control Plane. It is free, requires no setup, and allows you to send events without any limitation.
You can also use theRudderStack Config Generator if you wish to manage the source and destination configurations locally, by exporting to or importing them from a JSON file.
Follow the instructions below to start the RudderStack Config Generator.
CloneRudderStack Control Plane Lite repository.
$ git clone https://github.com/rudderlabs/config-generator.gitNavigate to Config Generator directory.
Install dependencies using npm. Please make sure thatNode.js 10.6 and npm are installed.
$ npm installStart 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:
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 onAdding a Source and Destination in RudderStack.
To export the workspace configuration, click on theEXPORT button present at the right top of the Connections page. Keep a note of the downloaded workspace configuration file location.
For RudderStack to pick up the exported workspace config file, please follow the steps below:
If you are runningRudderStack on Docker:
- Open
rudder-docker.yml. - Uncomment the
volumessection under thebackendservice. Replace<absolute_path_to_workspace_config>with the absolute path of the downloaded workspace configuration file location. - In the
environmentsection underbackendservice, uncomment the environment variableRSERVER_BACKEND_CONFIG_CONFIG_FROM_FILE=true.
For aNative RudderStack Installation:
- Open
.envfile. - Add
RSERVER_BACKEND_CONFIG_CONFIG_FROM_FILE=trueto 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 setupRudderStack on a developer machine:
- Open
config/config.toml. Look forconfigFromFileandconfigJSONPathunder[BackendConfig]. SetconfigFromFileto true andconfigJSONPathto the absolute path of the downloaded workspace configuration file location.
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 ourDiscord channel. We will be happy to help you!
To know more about RudderStack, you cancontact us or start a conversation in ourSlack community. To see RudderStack in action, make sure yourequest a demo today!