Service Configuration

Our services are configured by having certain environment variables set in their shell before they are started.

Database Configuration

Environment variableExample valueDescription
CROWD_DB_READ_HOSTstaging-read.postgres.crowd.dev Host location of your PostgreSQL v13 database read-only instance. This can be the same as CROWD_DB_WRITE_HOST if you don't expect much load on your database.
CROWD_DB_WRITE_HOSTstaging-write.postgres.crowd.devHost location of your PostgreSQL v13 database read & write instance
CROWD_DB_PORT5432Database port number
CROWD_DB_USERNAMEpostgresDatabase user
CROWD_DB_PASSWORDpasswordDatabase password
CROWD_DB_DATABASEcrowdDbDatabase name

Message Queue Configuration

Environment variableExample valueDescription
CROWD_SQS_NODEJS_WORKER_QUEUEhttps://sqs.us-east-2.amazonaws.com/12345678/nodejs-worker.fifoSQS FIFO Queue Url used by nodejs-worker service.
CROWD_SQS_NODEJS_WORKER_DELAYABLE_QUEUEhttps://sqs.us-east-2.amazonaws.com/12345678/nodejs-workerSQS non-FIFO Queue Url used by nodejs-worker service to delay messages.
CROWD_SQS_PYTHON_WORKER_QUEUEhttps://sqs.us-east-2.amazonaws.com/12345678/python-worker.fifoSQS FIFO Queue Url used by python-worker service.
CROWD_SQS_PREMIUM_PYTHON_WORKER_QUEUEhttps://sqs.us-east-2.amazonaws.com/12345678/premium-python-worker.fifoSQS FIFO Queue Url used by premium-python-worker service.
CROWD_SQS_AWS_ACCOUNT_ID12345678AWS Account ID
CROWD_SQS_AWS_ACCESS_KEY_IDAWSACCESSKEYIDAWS Access Key ID
CROWD_S3_AWS_SECRET_ACCESS_KEYAWSSECRETACCESSKEYAWS Secret Access Key
CROWD_S3_AWS_REGIONus-east-2AWS Region

CubeJS Configuration

Environment variableExample valueDescription
CROWD_CUBEJS_URLhttps://staging.cubejs.app.comURL pointing to the where CubeJS is deployed.
CROWD_CUBEJS_JWT_SECRETtopsecretjwtkeyJWT secret used to configure CubeJS so that our services can access CubeJS API.
CROWD_CUBEJS_JWT_EXPIRY2hHow long do JWT tokens issued by CubeJS last?

MeiliSearch Configuration

Environment variableExample valueDescription
CROWD_SEARCH_ENGINE_HOSThttps://staging-search.crowd.app.comURL pointing to where MeiliSearch instance is deployed.
CROWD_SEARCH_ENGINE_API_KEYtestkeyMeiliSearch API key so that our services can access their API.

Crowd Backend Configuration

Environment variableExample valueDescription
CROWD_EDITIONcommunityWhich crowd.dev edition are you using?
TENANT_MODEmultiFor now we only allow multi here but we could support other modes as well later on.
NODE_ENVdevelopmentThis can be either set to production for production deploy or to development for all the other deploy modes.
SERVICE_ENVdevelopmentSame as NODE_ENV
CROWD_API_URLhttps://app.test.com/apiURL to api service instance.
CROWD_API_FRONTEND_URLhttps://app.test.comURL to frontend service instance. This is where the web application lives.
CROWD_API_JWT_SECRETtopsecretjwtissuingkeyPassphrase used for issuing JWT login tokens by our api service.
CROWD_API_JWT_EXPIRES_IN100 yearsHow long should the login token last.
KUBE_MODE1This has to be set to 1.

Crowd Frontend Configuration

Environment variableExample valueDescription
VUE_APP_EDITIONcommunityWhich edition of crowd are you using?
VUE_APP_COMMUNITY_PREMIUMfalseAre premium features enabled?
VUE_APP_BACKEND_URLhttps://app.test.com/apiURL to api service instance.
VUE_APP_FRONTEND_HOSTapp.test.comDomain name of where web application is hosted at.
VUE_APP_FRONTEND_PROTOCOLhttpsEither https if using SSL or http.
VUE_APP_GITHUB_INSTALLATION_URLhttps://github.com/apps/testappname/installations/newGitHub app installation URL - Check this guide to see how to get this value.
VUE_APP_DISCORD_INSTALLATION_URLhttps://discord.com/api/oauth2/authorize?client_id=123456789&permissions=12345&redirect_uri=https%3A%2F%2Fapp.test.com%2Fintegrations%3Fsource%3Ddiscord&response_type=code&scope=bot%20messages.readDiscord app installation URL - Check this guide to see how to get this value.
VUE_APP_CUBEJS_URLhttps://app.test.com/cjsURL pointing to the instance of CubeJS.

Twitter Integration Configuration

Environment variableExample valueDescription
CROWD_TWITTER_CLIENT_IDWXFZpe4gUSR7ZhiHSu0yuc0yWkeTwY8GGINU7BmLtLQCEN2bP2zrT6glpaSbTwitter OAuth2 client ID for Twitter integration.
CROWD_TWITTER_CLIENT_SECRETdpLTMP0RbSGZeGH9erKkl0GzR7W2iS4BUNLlC9t1LeJa63GhHFqMIuU9QxT155WzxcP6aXBInSzp1NpbtSrvkwxYpAZwR8udj53VTwitter OAuth2 client secret for Twitter integration.

For a guide on how to get these values click here .

Slack Integration Configuration

Environment variableExample valueDescription
CROWD_SLACK_CLIENT_IDWXFZpe4gUSR7ZhiHSu0yuc0yWkeTwY8GGINU7BmLtLQCEN2bP2zrT6glpaSbSlack OAuth2 client ID for Twitter integration.
CROWD_SLACK_CLIENT_SECRETdpLTMP0RbSGZeGH9erKkl0GzR7W2iS4BUNLlC9t1LeJa63GhHFqMIuU9QxT155WzxcP6aXBInSzp1NpbtSrvkwxYpAZwR8udj53VSlack OAuth2 client secret for Twitter integration.

For a guide on how to get these values click here .

Discord Integration Configuration

Environment variableExample valueDescription
CROWD_DISCORD_TOKENdpLTMP0RbSGZeGH9erKkl0GzR7W2iS4BUNLlC9t1LeJa63GhHFqMIuU9QxT155WzxcP6aXBInSzp1NpbtSrvkwxYpAZwR8udj53VDiscord access token for Discord integration.

For a guide on how to get these values click here .

GitHub Integration Configuration

Environment variableExample valueDescription
CROWD_GITHUB_APP_ID123456GitHub developer app ID.
CROWD_GITHUB_CLIENT_IDWXFZpe4gUSR7ZhiHSu0yuc0yWkeTwY8GGINU7BmLtLQCEN2bP2zrT6glpaSbGitHub OAuth2 client ID for GitHub integration.
CROWD_GITHUB_CLIENT_SECRETdpLTMP0RbSGZeGH9erKkl0GzR7W2iS4BUNLlC9t1LeJa63GhHFqMIuU9QxT155WzxcP6aXBInSzp1NpbtSrvkwxYpAZwR8udj53VGitHub OAuth2 client ID for GitHub integration.
CROWD_GITHUB_PRIVATE_KEYLS0tLS1CRUdJTiBQ...clipped...FhLUT09Ci0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS0KGitHub private key base 64 encoded into one line.
CROWD_GITHUB_WEBHOOK_SECRET7c2e22ca-24c6-4643-8666-2d1766f018deGitHub webhook verification secret.

For a guide on how to get these values, click here .

Reddit integration configuration

For a guide on how to get these values, click here.

Environment variableExample valueDescription
CROWD_REDDIT_CLIENT_ID0-oy43x9FSgjhEshfuU_EgClient ID for your Reddit app
CROWD_REDDIT_CLIENT_SECRETjXtHarnskHjlhHPVid0jDIUYO_p4bgSecret for your Reddit app