{"id":19491785,"url":"https://github.com/rudderlabs/config-generator","last_synced_at":"2025-04-25T19:32:26.782Z","repository":{"id":40386365,"uuid":"239977649","full_name":"rudderlabs/config-generator","owner":"rudderlabs","description":"Repo for RudderStack's Config Generator, that generates configuration JSON files to be used with the RudderStack server.","archived":false,"fork":false,"pushed_at":"2024-03-04T13:14:42.000Z","size":7799,"stargazers_count":20,"open_issues_count":25,"forks_count":45,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-20T19:43:43.084Z","etag":null,"topics":["control-plane","json","rudderstack"],"latest_commit_sha":null,"homepage":"https://rudderstack.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rudderlabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-12T09:49:32.000Z","updated_at":"2024-11-25T06:46:46.000Z","dependencies_parsed_at":"2023-01-30T06:31:27.341Z","dependency_job_id":null,"html_url":"https://github.com/rudderlabs/config-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rudderlabs%2Fconfig-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rudderlabs%2Fconfig-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rudderlabs%2Fconfig-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rudderlabs%2Fconfig-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rudderlabs","download_url":"https://codeload.github.com/rudderlabs/config-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250882637,"owners_count":21502341,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["control-plane","json","rudderstack"],"created_at":"2024-11-10T21:18:10.049Z","updated_at":"2025-04-25T19:32:21.773Z","avatar_url":"https://github.com/rudderlabs.png","language":"TypeScript","readme":"\n  \u003ch2 align=\"center\"\u003e⚠️ DEPRECATED\u003c/h2\u003e\n  \u003cp align=\"center\"\u003eThis repository is not maintained anymore. Read \u003ca href=\"https://github.com/rudderlabs/config-generator/issues/49\"\u003ethis issue for more details\u003c/a\u003e\u003c/p\u003e\n\n# What is RudderStack?\n\n[RudderStack](https://rudderstack.com/) is a **customer data pipeline** tool for collecting, routing and processing data from your websites, apps, cloud tools, and data warehouse.\n\nMore information on RudderStack can be found [here](https://github.com/rudderlabs/rudder-server).\n\n## RudderStack Control Plane Lite\n\nRudderStack has two components: _control plane_ and _data plane_.\n\nThe data plane reliably delivers your event data, while the control plane manages the configuration of your sources and destinations.\n\n\u003e To learn more about the data plane and control plane, refer to the [RudderStack Architecture](https://www.rudderstack.com/docs/resources/rudderstack-architecture/).\n\nRudderStack's Control Plane Lite utility provides the UI to self-host and manage these source and destination configurations. All the source and destination configuration stays on your local storage. You can also export or import these configurations to a JSON file.\n\n\u003e To read more about the Control Plane Lite utility, refer to the [RudderStack documentation](https://www.rudderstack.com/docs/get-started/rudderstack-open-source/control-plane-lite/).\n\n## Setup\n\nRequirement: Use `Node.js v14` for the best experience. (`Node v16` and higher versions are not supported)\n\nTo set up the RudderStack Control Plane Lite, run the following commands:\n\n1. `npm install`\n2. `npm start`\n\nThe Control Plane Lite starts on the default port i.e., `http://localhost:3000`.\n\nOn a successful setup, you should see the following:\n\n![configGenScreenshot](https://user-images.githubusercontent.com/9196093/139224985-28c795cb-d130-4525-a41f-451dba0ac384.png)\n\n## Exporting workspace configuration\n\nAfter adding the required sources and destinations, export your workspace config. This workspace config is required by the [RudderStack server](https://github.com/rudderlabs/rudder-server).\n\n\u003e To learn more about adding sources and destinations in RudderStack, refer to the [RudderStack documentation](https://www.rudderstack.com/docs/dashboard-guides/overview/).\n\nUpdate the [config](https://docs.rudderstack.com/administrators-guide/config-parameters) variables `configFromFile` and `configJSONPath` in your RudderStack server to read the workspace configuration from the exported JSON file.\n\n## Starting RudderStack with the workspace config file\n\n1. Download the workspace config file on your machine.\n2. In `docker-compose.yml`, uncomment `volumes` section under `backend` service. Specify the path to your workspace config.\n3. In `build/docker.env`, set the environment variable `RSERVER_BACKEND_CONFIG_CONFIG_FROM_FILE=true`\n4. Start RudderStack by running the command `docker-compose up`\n\nFor more information, refer to the [RudderStack documentation](https://www.rudderstack.com/docs/get-started/rudderstack-open-source/control-plane-lite/).\n\n## Exporting source configuration\n\nAfter 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 on the `/sourceConfig` end-point. Then, specify that link as your `controlPlaneUrl` while initializing the SDK.\n\n## More information\n\nFor more information and documentation related to the RudderStack Control Plane Lite, refer to the [RudderStack documentation](https://www.rudderstack.com/docs/get-started/rudderstack-open-source/control-plane-lite/).\n\nSome more points to note:\n\n- You can make use of the `addDestinationSource.js` file in the `src/scripts` to automatically generate the required config code automatically. \n- Make use of the print functions to generate the code in the required format. \n- You can alter the `printConfig` function to generate the config for your sources or destinations.\n\n## Contact us\n\nIf you come across any issues while configuring or using the RudderStack Control Plane Lite, feel free to start a conversation on our [Slack](https://resources.rudderstack.com/join-rudderstack-slack) channel.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frudderlabs%2Fconfig-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frudderlabs%2Fconfig-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frudderlabs%2Fconfig-generator/lists"}