| APOLLO_OPTICS_KEY |
A key for Apollo tracer. |
| ASSETS_DIR |
Directory path where front-end packaged JavaScript is saved and loaded. Required. |
| ASSETS_MAP_FILE |
File name of map file, within ASSETS_DIR, containing map of general file names to unique build-specific file names. |
| AUTH0_DOMAIN |
Domain name on Auth0 account, should end in .auth0.com, e.g. example.auth0.com. Required. |
| AUTH0_CLIENT_ID |
Client ID from Auth0 app. Required. |
| AUTH0_CLIENT_SECRET |
Client secret from Auth0 app. Required. |
| AWS_ACCESS_AVAILABLE |
1 or 0 to enable or disable S3 campaign exports within Amazon Lambda. |
| AWS_ACCESS_KEY_ID |
AWS access key ID with access to S3 bucket, required for campaign exports outside Amazon Lambda. |
| AWS_SECRET_ACCESS_KEY |
AWS access key secret with access to S3 bucket, required for campaign exports outside Amazon Lambda. |
| AWS_S3_BUCKET_NAME |
Name of S3 bucket for saving campaign exports. |
| BASE_URL |
The base URL of the website, without trailing slack, e.g. https://example.org, used to construct various URLs. |
| CACHE_PREFIX |
If REDISURL is set, then this will prefix keys CACHE_PREFIX, which might be useful if multiple applications use the same redis server. _Default: "". |
| CAMPAIGN_ID |
Campaign ID used by dev-tools/export-query.js to identify which campaign should be exported. |
| DB_HOST |
Domain or IP address of database host. |
| DB_MAX_POOL |
Database connection pool maximum size. Default: 10. |
| DB_MIN_POOL |
Database connection pool minumum size. Default: 2. |
| DB_NAME |
Database connection name. Required. |
| DB_PORT |
Database connection port. Required. |
| DB_TYPE |
Database connection type for Knex. Options: mysql, pg, sqlite3. Default: sqlite3. |
| DB_USE_SSL |
Boolean value to determine whether database connections should use SSL. Default: false. |
| PGSSLMODE |
Postgres SSL mode. Due to a Knex bug, this environment variable must be used in order to specify the SSL mode directly in the driver. This must be set to PGSSLMODE=require to work with Heroku databases above the free tier (see Heroku Postgres & SSL). |
| DEBUG_SCALING |
Emit console.log on events related to scaling issues. Default: false. |
| DEFAULT_SERVICE |
Default SMS service. Options: twilio, nexmo, fakeservice. |
| DEV_APP_PORT |
Port for development Webpack server. Required for development. |
| DST_REFERENCE_TIMEZONE |
Timezone to use to determine whether DST is in effect. If it's DST in this timezone, we assume it's DST everywhere. Default: "America/New_York". (The default will work for any campaign in the US. For example, if the campaign is in Australia, use "Australia/Sydney" or some other timezone in Australia. Note that DST is opposite in the northern and souther hemispheres.) |
| EMAIL_FROM |
Email from address. Required to send email from either Mailgun or a custom SMTP server. |
| EMAIL_HOST |
Email server host. Required for custom SMTP server usage. |
| EMAIL_HOST_PASSWORD |
Email server password. Required for custom SMTP server usage. |
| EMAIL_HOST_PORT |
Email server port. Required for custom SMTP server usage. |
| EMAIL_HOST_USER |
Email server user. Required for custom SMTP server usage. |
| GRAPHQL_URL |
Optional URL for pointing GraphQL API requests. Should end with /graphql, e.g. https://example.org/graphql. Default: "/graphql" |
| JOBS_SAME_PROCESS |
Boolean value indicating whether jobs should be executed in the same process in which they are created (vs. processing asyncronously via worker processes). Default: false. |
| MAILGUN_DOMAIN |
The domain you set up in Mailgun, e.g. email.bartletforamerica.com. Required for Mailgun usage. |
| MAILGUN_PUBLIC_KEY |
Should be automatically set during Heroku auto-deploy. Do not modify. Required for Mailgun usage. |
| MAILGUN_SMTP_LOGIN |
'Default SMTP Login' in Mailgun. Required for Mailgun usage. |
| MAILGUN_SMTP_PASSWORD |
'Default Password' in Mailgun. Required for Mailgun usage. |
| MAILGUN_SMTP_PORT |
Default: 587. Do not modify. Required for Mailgun usage. |
| MAILGUN_SMTP_SERVER |
Default: smtp.mailgun.org. Do not modify. Required for Mailgun usage. |
| MAX_CONTACTS |
If set each campaign can only have a maximum of the value (an integer). This is good for staging/QA/evaluation instances. Default: false (i.e. there is no maximum) |
| MAX_CONTACTS_PER_TEXTER |
Maximum contacts that a texter can receive. This is particularly useful for dynamic assignment. Leave it blank (which is the default value) for no maximum. |
| MAX_MESSAGE_LENGTH |
The maximum size for a message that a texter can send. When you send a SMS message over 160 characters the message will be split, so you might want to set this as 160 or less if you have a high SMS-only target demographic. Default: 99999 |
| NEXMO_API_KEY |
Nexmo API key. Required if using Nexmo. |
| NEXMO_API_SECRET |
Nexmo API secret. Required if using Nexmo. |
| NO_EXTERNAL_LINKS |
Removes google fonts and auth0 login script -- good for development offline when you already have an auth0 session |
| NODE_ENV |
Node environment type. Options: development, production. |
| NOT_IN_USA |
A flag to affirmatively indicate the ability to use features that are discouraged or not legally usable in the United States. Consult with an attorney about the implications for doing so. Default: false (i.e. default assumes a USA legal context) |
| OPT_OUT_MESSAGE |
Spoke instance-wide default for opt out message. |
| OPTOUTS_SHARE_ALL_ORGS |
Can be set to true if opt outs should be respected per instance and across organizations |
| OUTPUT_DIR |
Directory path for packaged files should be saved to. Required. |
| PHONE_NUMBER_COUNTRY |
Country code for phone number formatting. Default: US. |
| PORT |
Port for Heroku servers. |
| PUBLIC_DIR |
Directory path server should use to serve files. Required. |
| REDIS_URL |
This enables caching using the url option in redis library. This is an area of active development. More can be seen at server/models/cacheable-queries/README and the project board |
| REVERE_SQS_URL |
SQS URL to process outgoing Revere SMS Messages. |
| REVERE_LIST_ID |
Revere List to add user to. |
| REVERE_NEW_SUBSCRIBER_MOBILE_FLOW |
Revere mobile flow to trigger upon recording action. |
| REVERE_MOBILE_API_KEY |
Revere authentication api key to use to access Revere API. |
| REVERE_API_URL |
Revere api endpoint to use for triggering a mobile flow. |
| ROLLBAR_CLIENT_TOKEN |
Client token for Rollbar error tracking. |
| ROLLBAR_ACCESS_TOKEN |
Access token for Rollbar error tracking. |
| ROLLBAR_ENDPOINT |
Endpoint URL for Rollbar error tracking. |
| SESSION_SECRET |
Unique key used to encrypt sessions. Required. |
| SLACK_NOTIFY_URL |
If set, then on post-install (often from deploying) a message will be posted to a slack channel's #spoke channel |
| SUPPRESS_SELF_INVITE |
Boolean value to prevent self-invitations. Recommend setting before making sites available to public. Default: false. |
| TERMS_REQUIRE |
Require texters to accept the Terms page before they can start texting. Default: false |
| TWILIO_API_KEY |
Twilio API key. Required if using Twilio. |
| TWILIO_APPLICATION_SID |
Twilio application ID. Required if using Twilio. |
| TWILIO_AUTH_TOKEN |
Twilio auth token. Required if using Twilio. |
| TWILIO_MESSAGE_SERVICE_SID |
Twilio message service ID. Required if using Twilio. |
| TWILIO_STATUS_CALLBACK_URL |
URL for Twilio status callbacks. Should end with /twilio-message-report, e.g. https://example.org/twilio-message-report. Required if using Twilio. |
| TWILIO_SQS_QUEUE_URL |
AWS SQS URL to handle incoming messages when app isn't connected to twilio |
| TWILIO_VALIDATION_HOST |
Allow overriding the host Spoke validates Twilio headers against. This can be useful if you are running Spoke behind a proxy. If set to "", the host option will be undefined. |
| SKIP_TWILIO_VALIDATION |
Whether to bypass Twilio header validation altogether. |
| WAREHOUSEDB{TYPE,HOST,PORT,NAME,USER,PASSWORD} |
Enables ability to load contacts directly from a SQL query from a separate data-warehouse db -- only is_superadmin-marked users will see the interface |
| WAREHOUSE_DB_LAMBDA_ITERATION |
If the WAREHOUSEDB connection/feature is enabled, then on AWS Lambda, queries that take longer than 5min can expire. This will enable incrementing through queries on new lambda invocations to avoid timeouts. |
| WEBPACK_HOST |
Host domain or IP for Webpack development server. Default: 127.0.0.1. |
| WEBPACK_PORT |
Port for Webpack development server. Defaut: 3000. |
| FIX_ORGLESS |
Set to any truthy value only if you want to run the job that automatically assigns the default org (see DEFAULT_ORG) to new users who have no assigned org. |
| DEFAULT_ORG |
Set only with FIX_ORGLESS. Set to integer organization.id corresponding to the organization you want orgless users to be assigned to. |
| ALTERNATE_LOGIN_URL |
When set, the "Login" link on the home page will direct to this alternate URL |