The default configuration in GrowthBook is optimized for trying things out quickly on a local dev machine. Beyond that, you can customize behavior with Environment Variables.
Domains and Ports
This is used to generate links to GrowthBook and enable CORS access to the API.
- APP_ORIGIN - default http://localhost:3000
- API_HOST - default http://localhost:3100
If you want to run GrowthBook on a different host than localhost, you need to add the above environment
variables to your
- APP_ORIGIN=http://<my ip>:3000
- API_HOST=http://<my ip>:3100
The back-end and the front-end must run on unique ports if on the same domain.
The front-end has its own set of
/api routes so currently we do not support running both the API and the front-end on the same port on the same domain.
In order for authentication cookies to work correctly, both the app and api domains must be considered the "same site". They can be on different subdomains or ports, but the root domain must be the same.
If you need to change the ports on your local dev environment (e.g. if
3000 is already being used),
you need to update the above variables AND change the port mapping in
- "4000:3000" # example: use 4000 instead of 3000 for the app
- "4100:3100" # example: use 4100 instead of 3100 for the api
- APP_ORIGIN=http://<my ip or url>:4000
- API_HOST=http://<my ip or url>:4100
- NODE_ENV - Set to "production" to turn on additional optimizations and API request logging
- MONGODB_URI - The full MongoDB connection string. Alternatively you can specify the following environment variables from which we will compose the full connection string like so
- MONGODB_USERNAME - Username for MongoDB
- MONGODB_PASSWORD - Password for MongoDB
- MONGODB_HOST - Host name of MongoDB excluding port, e.g.
- MONGODB_PORT - Port to use for MongoDB (defaults to
- MONGODB_DBNAME - Database name of growthbook database (defaults to
- MONGODB_EXTRA_ARGS - Optional set of extra arguments for MongoDB connection string (defaults to
- JWT_SECRET - Auth signing key (use a long random string)
- ENCRYPTION_KEY - Data source credential encryption key (use a long random string)
If you change the
ENCRYPTION_KEY, you will need to migrate any existing data sources using the following script:
# If you didn't have an ENCRYPTION_KEY before, leave OLD_KEY blank below
docker-compose run growthbook yarn migrate-encryption-key OLD_KEY
When using GrowthBook in production, it is important to change the
NODE_ENVto to "production" and change the
JWT_SECRETto a random string. Using the
productionnode environment and the default
JWT_SECRETwill throw an error.
Email SMTP Settings
This is required in order to send experiment alerts, team member invites, and reset password emails.
- EMAIL_ENABLED ("true" or "false")
Google OAuth Settings
Only required if using Google Analytics as a data source
The UPLOAD_METHOD environment variable controls where to store uploaded files
and screenshots. The supported values are
This is the default value. Uploads are stored in the GrowthBook docker container at
/usr/local/src/app/packages/back-end/uploads. In production, you should mount a volume here to persist uploads across container restarts.
Store uploads in an AWS S3 bucket.
- S3_REGION (defaults to
- S3_DOMAIN (defaults to
- AWS_ACCESS_KEY_ID (not required when deployed to AWS with an instance role)
- AWS_SECRET_ACCESS_KEY (not required when deployed to AWS with an instance role)
Store uploads in a Google Cloud Storage bucket.
- GCS_DOMAIN (defaults to
- GOOGLE_APPLICATION_CREDENTIALS (not required when deployed to GCP with an instance service account)
Some features in self-hosted GrowthBook are only available with a commercial license key. You can get a trial Enterprise key from your self-hosted version of GrowthBook, or reach out to email@example.com to learn more.
If you have a license key, you can activate it in GrowthBook two different ways:
- Navigate to Settings > General and look for the License section of the page. There you can input or edit your license key string. (Recommended)
- Alternately, set the environment variable
LICENSE_KEYto your license key string. If using Docker, go to docker-compose.yml and add the variable to the growthbook > environment section.
To enable SSO on your self-hosted GrowthBook instance, you will need an active license key (see above section), and
then you may add the SSO settings for your provider. You can find the instructions on how to setup SSO for GrowthBook
with most common providers on our SSO instructions page. The JSON object with the settings will need to be JSON
encoded and then set to the environment variable
The GrowthBook API is instrumented with OpenTelemetry to publish observability metrics, traces, and logs.
To enable, you must change the Docker CMD from the default
yarn start to
The standard OTEL_* Environment Variables are supported, such as
- EXPERIMENT_REFRESH_FREQUENCY - Default update schedule for experiment results. Update when stale for X hours (default
- QUERY_CACHE_TTL_MINS - How long (in minutes) to cache and re-use SQL query results (default
- DEFAULT_CONVERSION_WINDOW_HOURS - How many hours after being put into an experiment does a user have to convert. Can be overridden on a per-metric basis. (default
- DISABLE_TELEMETRY - We collect anonymous telemetry data to help us improve GrowthBook. Set to "true" to disable.
- STORE_SEGMENTS_IN_MONGO - If using the config.yml file, set to
trueif you want to store segments in Mongo. This is also useful if you have existing segments stored in Mongo that you need to access. When set, GrowthBook will ignore segments in the config.yml file and only use Segments stored in Mongo.
- CDN_HOST - When set, this will update the implementation instructions within GrowthBook to override the
API_HOSTin cases where a CDN is used.
- EXPRESS_TRUST_PROXY_OPTS - Express' trust proxy setting value. Supports boolean (true/false), string values, and integer values for trusting the nth hop from the front-facing proxy server as the client. Leavy empty or specify
falseto use Express' default behavior. If you are running GrowthBook behind a proxy or load balancer, this is required to track the correct user IP for audit log events.