Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Sorted .env.example and added more documentation #9104

Merged
merged 6 commits into from
Nov 27, 2023
Merged

chore: Sorted .env.example and added more documentation #9104

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4985452
Sorted .env.example and added more documentation
mwermuth Nov 2, 2023
375ff86
Added changes related to PR. Improved section naming.
mwermuth Nov 3, 2023
c38444b
Fixed CI variable location
mwermuth Nov 6, 2023
49af5c1
Sorted variables and created new categories for GOOGLE, DATADOG, AWS.…
mwermuth Nov 14, 2023
f9a8a26
Requested changes incorporated
rafaelromcar-parabol Nov 15, 2023
e7ca0b4
Merge remote-tracking branch 'origin/master' into chore/update-env-va…
rafaelromcar-parabol Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 90 additions & 47 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,43 @@
# SERVER CONFIG
rafaelromcar-parabol marked this conversation as resolved.
Show resolved Hide resolved
HOST='localhost'
NODE_ENV=''
rafaelromcar-parabol marked this conversation as resolved.
Show resolved Hide resolved
PORT='3000'
PROTO='http'
SERVER_SECRET='key_SERVER_SECRET'
# Cluster node number 0 - 1023
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'

# AUTHENTICATION
AUTH_INTERNAL_DISABLED='false'
AUTH_GOOGLE_DISABLED='false'
mwermuth marked this conversation as resolved.
Show resolved Hide resolved
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
mwermuth marked this conversation as resolved.
Show resolved Hide resolved
# SEGMENT_WRITE_KEY='key_SEGMENT_WRITE_KEY'
SENTRY_AUTH_TOKEN='key_SENTRY_AUTH_TOKEN'
# SENTRY_DSN='key_SENTRY_DSN'

# CDN SETTINGS
rafaelromcar-parabol marked this conversation as resolved.
Show resolved Hide resolved
CDN_BASE_URL=''
FILE_STORE_PROVIDER='local|s3|gcs'
rafaelromcar-parabol marked this conversation as resolved.
Show resolved Hide resolved
AWS_S3_BUCKET=''
GOOGLE_GCS_BUCKET=''

# CHRONOS
CHRONOS_PULSE_EMAIL=''
CHRONOS_PULSE_CHANNEL=''
CHRONOS_PULSE_DAILY='0 0 4 * * *'
Expand All @@ -19,26 +47,65 @@ 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'

# 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_AGENT_HOST='172.17.0.1'
DD_API_KEY='DD_API_KEY'
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='PROTOCOL://URL:PORT'
rafaelromcar-parabol marked this conversation as resolved.
Show resolved Hide resolved
DD_TRACE_ENABLED='false'
DD_ENV='local'
FILE_STORE_PROVIDER='s3'

# GOOGLE
GA_TRACKING_ID='' # GOOGLE ANALYTICS TRACKING ID
rafaelromcar-parabol marked this conversation as resolved.
Show resolved Hide resolved
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
mwermuth marked this conversation as resolved.
Show resolved Hide resolved
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'
GRAPHQL_HOST='localhost:3000'
GRAPHQL_PROTOCOL='http'
HOST='localhost'
# 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 @@ -52,38 +119,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='[email protected]'
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'
# SEGMENT_WRITE_KEY='key_SEGMENT_WRITE_KEY'
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'
mwermuth marked this conversation as resolved.
Show resolved Hide resolved
PGADMIN_DEFAULT_EMAIL='[email protected]'
PGADMIN_DEFAULT_PASSWORD='admin'
ULTRAHOOK_API_KEY='key_ULTRAHOOK_API_KEY'
mwermuth marked this conversation as resolved.
Show resolved Hide resolved