Readme update (omnistrate-oss#453)

* Add subscription id to capacity api calls * Update readme * Add environment type faq * Code rabbit review fixes --------- Co-authored-by: sharmaamits <[email protected]>
FalkorDB · Dec 24, 2024 · 2ae7415 · 2ae7415
1 parent 518b3dc
commit 2ae7415
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -80,7 +80,9 @@ yarn install
 | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | PROVIDER_EMAIL        | Service provider's Omnistrate email address                                                                                                                                                                                                           |
 | PROVIDER_PASSWORD     | Service provider's Omnistrate account password                                                                                                                                                                                                        |
+| ENVIRONMENT_TYPE  | The environment type for your application. Defaults to *PROD*. Learn more about environments [here](https://docs.omnistrate.com/operate-guides/pipelines/) 
 | YOUR_SAAS_DOMAIN_URL  | The secure domain URL where this application will be deployed eg. https://www.yourcloud.com. When working locally, it should be http://localhost:3000 
+| YOUR_SAAS_DOMAIN_ALIAS  | The domain alias for your deployment 
 | MAIL_SMTP_HOST    | The the hostname or IP address of the mail service provider. Defaults to *smtp.gmail.com* |                                                                                                |
 | MAIL_SMTP_PORT    | The port to be used for creating the SMTP connection. Defaults to *587* |                                                                                                |
 | MAIL_USER_EMAIL       | The email account to be used to authenticate to send mails (signup, reset password etc) to your customers. Check the following [section](#how-to-configure-google-account-for-sending-out-emails) for instructions to configure gmail account for sending out the emails. |
@@ -159,6 +161,14 @@ For a video guide covering all the below steps, you can follow it [here](https:/
 
 Ensure your node and yarn versions meet the project's requirements. Try clearing your yarn cache with yarn cache clean and reinstalling dependencies.
 
+
+#### Why do I need to specify an environment type?
+
+SaaSBuilder runs in an environment scope. The services and subscription plans that are made available to the users depend on the environment type that you specify when running the application. SaaSBuilder supports DEV, STAGING, QA, CANARY, PRIVATE and PROD environment types.
+User sign-ups are supported in *PROD*, while other environments are meant for internal use.
+
+Learn more about environments [here](https://docs.omnistrate.com/operate-guides/pipelines/) 
+
 #### How to configure Google Account for sending out emails?
 
 Configuring Google Account for sending out emails is a two step process. First the account must have a 2-Step Verification enabled, and second, the app password needs to be set. If the Google Account you are using, already has 2-Step Verification configured, you may skip Step 1, and start with Step 2.