Improved env.example files on enterprise and engine

services/engine/.env.example

@@ -38,8 +38,7 @@ MONGODB_DB_NAME = 'dataherald'
 MONGODB_DB_USERNAME = 'admin'
 MONGODB_DB_PASSWORD = 'admin'
 
-
-# The enncryption key is used to encrypt database connection info before storing in Mongo. Please refer to the README on how to set it.
+# Used to store credential files for database connections
 S3_AWS_ACCESS_KEY_ID=
 S3_AWS_SECRET_ACCESS_KEY=
 ONLY_STORE_CSV_FILES_LOCALLY = False # Set to True if only want to save generated CSV files locally instead of S3. Note that if stored locally they should be treated as ephemeral, i.e., they will disappear when the engine is restarted.

services/enterprise/.env.example

@@ -1,37 +1,47 @@
 ENGINE_URL=http://{DOCKER_CONTAINER_NAME:PORT}/api/v1 # example: http://engine/api/v1 (port 80 by default)
-MONGODB_DB_NAME=
-MONGODB_URI=
+MONGODB_DB_NAME=dataherald
+MONGODB_URI=mongodb://admin:admin@mongodb:27017
+
+#The encryption key should be the same as the one used in engine
+ENCRYPT_KEY=
 
 AUTH0_DOMAIN='{yourDomain}'
-AUTH0_ISSUER='{yourIssuer}'
+AUTH0_ISSUER='https://{yourDomain}/'
 AUTH0_API_AUDIENCE='{yourAudience}'
+# AUTH0_DISABLED creates a mock authentication token type for testing purposes
+# you can provide an email as the bearer token, note that the admin console will not be able to authenticate
 AUTH0_DISABED=False
 
+# The salt is used to hash the API key, use the string from ENCRYPT_KEY or create a different one
 API_KEY_SALT=
 
 DEFAULT_ENGINE_TIMEOUT=120
 
+# Used to store credential files for database connections
+# should be the same as the ones in engine
 S3_AWS_ACCESS_KEY_ID=
 S3_AWS_SECRET_ACCESS_KEY=
 
-#The encryption key should be the same as the one used in engine
-ENCRYPT_KEY =
 
+# Optional posthog analytics if disabled
+POSTHOG_DISABLED=True
 POSTHOG_API_KEY=
 POSTHOG_HOST=
-POSTHOG_DISABLED=True
 
-# To set the SSH key file
+
+
+# Optional ssh credentials if connecting to a remote database using ssh tunnel
 SSH_PRIVATE_KEY_PASSWORD=
 SSH_PATH_TO_CREDENTIAL_FILE=
 
+# Optional stripe env vars if organizations are not on ENTERPRISE plan
 STRIPE_API_KEY=
 STRIPE_WEBHOOK_SECRET=
-SQL_GENERATION_PRICE_ID=#optional
-FINETUNING_GPT_35_PRICE_ID=#optional
-FINETUNING_GPT_4_PRICE_ID=#optional
-DEFAULT_SPENDING_LIMIT=#optional
-SINGUP_CREDITS=#optional
-SQL_GENERATION_COST=#optional
-FINETUNING_GPT_35_COST=#optional
-FINETUNING_GPT_4_COST=#optional
+SQL_GENERATION_PRICE_ID=
+FINETUNING_GPT_35_PRICE_ID=
+FINETUNING_GPT_4_PRICE_ID=
+DEFAULT_SPENDING_LIMIT=
+SINGUP_CREDITS=
+SQL_GENERATION_COST=
+FINETUNING_GPT_35_COST=
+FINETUNING_GPT_4_COST=