Skip to content

Commit

Permalink
chore: Sorted .env.example and added more documentation (#9104)
Browse files Browse the repository at this point in the history
* Sorted .env.example and added more documentation

* Added changes related to PR. Improved section naming.

* Fixed CI variable location

* Sorted variables and created new categories for GOOGLE, DATADOG, AWS. Added missing variables.

* Requested changes incorporated

---------

Co-authored-by: Rafael Romero <rafael@parabol.co>
  • Loading branch information
mwermuth and rafaelromcar-parabol authored Nov 27, 2023
1 parent 5cc7423 commit a26050e
Showing 1 changed file with 94 additions and 50 deletions.
144 changes: 94 additions & 50 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,15 +1,45 @@
# SERVER CONFIG
HOST='localhost'
PORT='3000'
PROTO='http'
SERVER_SECRET='key_SERVER_SECRET'
# Cluster node number 0 - 1023. Must be unique per process.
SERVER_ID='1'
SOCKET_PORT='3001'

# APPLICATION
# AMPLITUDE_WRITE_KEY='key_AMPLITUDE_WRITE_KEY'
ATLASSIAN_CLIENT_ID='key_ATLASSIAN_CLIENT_ID'
ATLASSIAN_CLIENT_SECRET='key_ATLASSIAN_CLIENT_SECRET'
# Enter a short url redirect service for invitations, it needs to redirecto to /invitation-link
# INVITATION_SHORTLINK='example.com'
# If true, all new orgs will default to being enterprise tier. Use for PPMIs
IS_ENTERPRISE=false

# AUTHENTICATION
AUTH_INTERNAL_DISABLED='false'
AUTH_GOOGLE_DISABLED='false'
AUTH_SSO_DISABLED='false'
SERVER_SECRET='key_SERVER_SECRET'
GOOGLE_OAUTH_CLIENT_ID=''
GOOGLE_OAUTH_CLIENT_SECRET=''
OAUTH2_REDIRECT=''

# AWS
AWS_ACCESS_KEY_ID='key_AWS_ACCESS_KEY_ID'
AWS_REGION='key_AWS_REGION'
AWS_S3_BUCKET='action-files.parabol.co'
AWS_SECRET_ACCESS_KEY='key_AWS_SECRET_ACCESS_KEY'

# MONITORING
# SEGMENT_WRITE_KEY='key_SEGMENT_WRITE_KEY'
SENTRY_AUTH_TOKEN='key_SENTRY_AUTH_TOKEN'
# SENTRY_DSN='key_SENTRY_DSN'

# CDN SETTINGS
CDN_BASE_URL=''
# FILE_STORE_PROVIDER: local | s3 | gcs
FILE_STORE_PROVIDER='local'
# AWS_S3_BUCKET='BUCKET_NAME'
# GOOGLE_GCS_BUCKET='BUCKET_NAME'

# CHRONOS
CHRONOS_PULSE_EMAIL=''
CHRONOS_PULSE_CHANNEL=''
CHRONOS_PULSE_DAILY='0 0 4 * * *'
Expand All @@ -19,29 +49,66 @@ CHRONOS_SCHEDULE_JOBS='0 */10 * * * *'
CHRONOS_UPDATE_TOKENS='0 0 0 1,15 * *'
CHRONOS_PROCESS_RECURRENCE='0 */5 * * * *'
CHRONOS_AUTOPAUSE='0 0 5 * * *'
CI='true'
DD_AGENT_HOST='172.17.0.1'
DD_API_KEY='DD_API_KEY'

# DATABASES
POSTGRES_PASSWORD=parabol
POSTGRES_USER=pgparaboladmin
POSTGRES_DB=parabol-saas
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
# POSTGRES_POOL_SIZE=5
# POSTGRES_SSL_REJECT_UNAUTHORIZED=false
# POSTGRES_SSL_DIR='/var/lib/postgresql'
REDIS_PASSWORD=''
REDIS_URL='redis://localhost:6379'
# REDIS_TLS_CERT_FILE=./certs/redis.crt
# REDIS_TLS_KEY_FILE=./certs/redis.key
# REDIS_TLS_CA_FILE=./certs/redisCA.crt
# REDIS_TLS_REJECT_UNAUTHORIZED='false'
RETHINKDB_URL='rethinkdb://localhost:28015/actionDevelopment'
RETHINKDB_SSL='false'

# DATADOG DD-Trace
# https://ddtrace.readthedocs.io/en/stable/configuration.html
DD_APM_ENABLED='false'
DD_API_KEY=''
DD_APPLICATIONID=''
DD_APPSEC_ENABLED='true'
DD_CLIENTTOKEN=''
DD_ENV=''
DD_LOGS_INJECTION='true'
DD_RUNTIME_METRICS_ENABLED='true'
DD_SERVICE='DD_SERVICE_NAME'
DD_TRACE_AGENT_URL='http://localhost:8126'
DD_TRACE_ENABLED='false'
DD_ENV='local'
FILE_STORE_PROVIDER='s3'

# GOOGLE
# Google Analytics Tracking ID
# GA_TRACKING_ID=''
GOOGLE_CLOUD_CLIENT_EMAIL='key_GOOGLE_CLOUD_CLIENT_EMAIL'
GOOGLE_CLOUD_PRIVATE_KEY='key_GOOGLE_CLOUD_PRIVATE_KEY'
GOOGLE_CLOUD_PRIVATE_KEY_ID='key_GOOGLE_CLOUD_PRIVATE_KEY_ID'

# INTEGRATIONS
ATLASSIAN_CLIENT_ID='key_ATLASSIAN_CLIENT_ID'
ATLASSIAN_CLIENT_SECRET='key_ATLASSIAN_CLIENT_SECRET'
AZUREDEVOPS_CLIENT_ID=''
AZUREDEVOPS_CLIENT_SECRET=''
GITHUB_CLIENT_ID='key_GITHUB_CLIENT_ID'
GITHUB_CLIENT_SECRET='key_GITHUB_CLIENT_SECRET'
GITHUB_WEBHOOK_SECRET='key_GITHUB_WEBHOOK_SECRET'
GITLAB_CLIENT_ID='key_GITLAB_CLIENT_ID'
GITLAB_CLIENT_SECRET='key_GITLAB_CLIENT_SECRET'
GOOGLE_CLOUD_CLIENT_EMAIL='key_GOOGLE_CLOUD_CLIENT_EMAIL'
GOOGLE_CLOUD_PRIVATE_KEY='key_GOOGLE_CLOUD_PRIVATE_KEY'
GOOGLE_CLOUD_PRIVATE_KEY_ID='key_GOOGLE_CLOUD_PRIVATE_KEY_ID'
GOOGLE_GCS_BUCKET=''
GRAPHQL_HOST='localhost:3000'
GRAPHQL_PROTOCOL='http'
HOST='localhost'
#if true, all new orgs will default to being enterprise tier. Use for PPMIs
IS_ENTERPRISE=false
# Enter a short url redirect service for invitations, it needs to redirecto to /invitation-link
# INVITATION_SHORTLINK='example.com'
HUBSPOT_API_KEY=''
HUBSPOT_SALES_PIPELINE_ACTIVE_STAGES=''
HUBSPOT_SALES_PIPELINE_ID=''
OPEN_AI_API_KEY=''
OPEN_AI_ORG_ID=''
RECALL_AI_KEY=''
SLACK_CLIENT_ID='key_SLACK_CLIENT_ID'
SLACK_CLIENT_SECRET='key_SLACK_CLIENT_SECRET'

# MAIL
# MAIL GLOBALS. PROVIDER: mailgun | google | debug | smtp
MAIL_PROVIDER='debug'
MAIL_FROM='key_MAIL_FROM'
Expand All @@ -55,37 +122,14 @@ MAIL_SMTP_USER='key_MAIL_SMTP_USER'
MAIL_SMTP_PASSWORD='key_MAIL_SMTP_PASSWORD'
MAIL_SMTP_USE_TLS='1' # set to '0' for false
MAIL_SMTP_CIPHERS='HIGH:MEDIUM:!aNULL:!eNULL:@STRENGTH:!DH:!kEDH'
MIN_LOG_DURATION='200'
OAUTH2_REDIRECT=''
PGADMIN_DEFAULT_EMAIL='pgadmin4@pgadmin.org'
PGADMIN_DEFAULT_PASSWORD='admin'
PORT='3000'
POSTGRES_PASSWORD=parabol
POSTGRES_USER=pgparaboladmin
POSTGRES_DB=parabol-saas
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
POSTGRES_POOL_SIZE=5
POSTGRES_SSL_REJECT_UNAUTHORIZED=false
POSTGRES_SSL_DIR='/var/lib/postgresql'
PROTO='http'
REDIS_PASSWORD=''
REDIS_URL='redis://localhost:6379'
REDIS_TLS_CERT_FILE=./certs/redis.crt
REDIS_TLS_KEY_FILE=./certs/redis.key
REDIS_TLS_CA_FILE=./certs/redisCA.crt
REDIS_TLS_REJECT_UNAUTHORIZED='false'
RETHINKDB_URL='rethinkdb://localhost:28015/actionDevelopment'
RETHINKDB_SSL='false'
SENTRY_AUTH_TOKEN='key_SENTRY_AUTH_TOKEN'
# SENTRY_DSN='key_SENTRY_DSN'
# Cluster node number 0 - 1023
SERVER_ID='1'
SLACK_CLIENT_ID='key_SLACK_CLIENT_ID'
SLACK_CLIENT_SECRET='key_SLACK_CLIENT_SECRET'
SOCKET_PORT='3001'
# https://stripe.com/docs/keys

# STRIPE KEYS https://stripe.com/docs/keys
STRIPE_SECRET_KEY='sk_test_4eC39HqLyjWDarjtT1zdp7dc'
STRIPE_PUBLISHABLE_KEY='pk_test_TYooMQauvdEDq54NiTphI7jx'
STRIPE_WEBHOOK_SECRET='sk_test_4eC39HqLyjWDarjtT1zdp7dc'

# DEVELOPER VARIABLES
CI='true'
PGADMIN_DEFAULT_EMAIL='pgadmin4@pgadmin.org'
PGADMIN_DEFAULT_PASSWORD='admin'
ULTRAHOOK_API_KEY='key_ULTRAHOOK_API_KEY'

0 comments on commit a26050e

Please sign in to comment.