Configuration

Environment variables are crucial for a correct configuration of crowd.dev.

📘

Reading the configuration

The configuration gives a description of each environment variable.

  • If it has a default setting, it is recommended to leave it as it is.
  • If it is marked as not required, it only needs to be filled for certain features.
  • If it is empty, it needs to be filled with your own values.

Front-end

The front-end has a template environment: frontend/.env.dist. If you want to the front-end it locally, copy it as .env, if you want to run it in the cloud, copy it as .env.[prod | staging]. Then fill it according to the configuration below.

General

VariableDescriptionLocal defaultCloud default
VUE_APP_BACKEND_URLThe backend URLhttps://anton.localhost/api
VUE_APP_FRONTEND_HOSTThe host for the frontend, without protocolapp.localhost
VUE_APP_FRONTEND_PROTOCOLThe protocol the front-end is usinghttpshttps

Integrations

GitHub

VariableDescriptionLocal defaultCloud default
VUE_APP_GITHUB_INSTALLATION_URLInstallation URL of the GitHub app

Discord

VariableDescriptionLocal defaultCloud default
VUE_APP_GITHUB_INSTALLATION_URLInstallation URL of the Discord app

Conversations (premium only)

VariableDescriptionLocal defaultCloud default
VUE_APP_CONVERSATIONS_PUBLIC_URLThe URL for public conversationshttps://open.localhostnot required

Backend

The backend directory has three template files:

  • backend/.env.dist: copy as .env.
  • backend/.env.dist.prod: copy as .env.prod (only for cloud production deployments).
  • backend/.env.dist.staging: copy as .env.staging (only for cloud staging deployments).

General

VariableDescriptionLocal defaultCloud default
PROJECT_ROOTRoot of the project (/Users/joanreyero/Documents/crowd-postgres)not required
EDITIONTo distinguish between cloud and community editions. Please do not change this.communitycommunity
SEGMENT_WRITE_KEYFor telemetry. See Telemetry.TdX3BLaZuHpHyzN2lcDiNiRHDSH9PiylTdX3BLaZuHpHyzN2lcDiNiRHDSH9Piyl

Database and Search Engine

VariableDescriptionLocal defaultCloud default
DATABASE_USERNAMEUsername of the DBpostgrespostgres
DATABASE_DIALECTDialect of the DBpostgrespostgres
DATABASE_PASSWORDPassword of the DBexample
DATABASE_DATABASEName of the databasecrowd-web
DATABASE_HOST_READRead instance hostdb
DATABASE_HOST_WRITEWrite instance hostdb
DATABASE_PORTDatabase port54325432
SEARCH_ENGINE_HOSTHost of the search enginehttp://search-engine:7700
SEARCH_ENGINE_API_KEYAPI key for search enginedev

Web app

VariableDescriptionLocalCloud
FRONTEND_URLURL of the front-endhttps://app.localhost
BACKEND_URLURL of the back-endhttps://anton.localhost/api
AUTH_JWT_SECRETThe secret for authenticating tokens. Set to a random UUID
AUTH_JWT_EXPIRES_INExpiry time of JWT tokens100 years100 years

AWS

VariableDescriptionLocal defaultCloud default
AWS_ACCOUNT_IDYour AWS account ID000000000000
AWS_ACCESS_KEY_IDYour AWS key ID“”
AWS_SECRET_ACCESS_KEYYour AWS secret“”
AWS_REGIONYour AWS regioneu-central-1eu-central-1

Integrations

GitHub

VariableDescriptionLocal defaultCloud default
GITHUB_APP_IDYour GitHub App IDnot requirednot required
GITHUB_CLIENT_IDYour GitHub client IDnot requirednot required
GITHUB_CLIENT_SECRETYour GitHub client secretnot requirednot required
GITHUB_PRIVATE_KEYYour GitHub private keynot requirednot required
GITHUB_WEBHOOK_SECRETYour GitHub webhook secretnot requirednot required

Twitter

VariableDescriptionLocal defaultCloud default
AUTH_SOCIAL_TWITTER_CLIENT_IDYour Twitter App Client IDnot requirednot required
AUTH_SOCIAL_TWITTER_CLIENT_SECRETYour Twitter Client Secretnot requirednot required
TWITTER_GLOBAL_LIMITMaximum Tweets per month1000010000
TWITTER_LIMIT_RESET_FREQUENCY_DAYSLimit reset frequency, in days3030
TWITTER_MAX_RETROSPECT_IN_SECONDSMaximum time to look back every time the integration runs, in seconds. This should be more than the integration frequency defined in serverless.yml.73807380

Discord

VariableDescriptionLocal defaultCloud default
DISCORD_TOKENYour Discord Bot tokennot requirednot required
DISCORD_MAX_RETROSPECT_IN_SECONDSMaximum time to look back every time the integration runs, in seconds. This should be more than the integration frequency defined in serverless.yml.36003600

Slack

VariableDescriptionLocal defaultCloud default
SLACK_CLIENT_IDYour client ID for Slacknot requirednot required
SLACK_CLIENT_SECRETYour client secret for Slacknot requirednot required
SLACK_MAX_RETROSPECT_IN_SECONDSMaximum time to look back every time the integration runs, in seconds. This should be more than the integration frequency defined in serverless.yml.36003600

Cube.js

VariableDescriptionLocal defaultCloud default
CUBE_JS_URLThe URL where Cube.js is deployedhttp://cubejs:4000
CUBE_JS_JWT_SECRETThe secret for signing Cube.js JWTs“”
CUBE_JS_JWT_EXPIRYLifetime of JWTs for Cube.js2h2h

Localstack

LocalStack is used to simulate the Serverless stack locally.

VariableDescriptionLocal defaultCloud default
LOCALSTACK_HOSTNAMEHostname of LocalStackhttp://localstack"none"
LOCALSTACK_PORTLocalStack port4566"none"

Netlify

TODO


Did this page help you?