flex-template-web/docs/env.md
Olli Vanhapiha bba6159b75 Format docs
2018-03-15 13:18:05 +02:00

3.9 KiB

Environment configuration variables

The following configuration variables can be set to control the Starter App behaviour. Most of them have defaults that work for development environment. For production deploys most should be set.

Variable Must be set? Default Description
REACT_APP_GOOGLE_MAPS_API_KEY X - See: Google Maps API key
REACT_APP_SHARETRIBE_SDK_CLIENT_ID X - Client ID (API key). You will get this from the Sharetribe team.
REACT_APP_STRIPE_PUBLISHABLE_KEY X - Stripe publishable API key for generating tokens with Stripe API.
REACT_APP_SHARETRIBE_SDK_BASE_URL http://localhost:8088 The base url to access the Marketplace API.
REACT_APP_SHARETRIBE_MARKETPLACE_CURRENCY USD The currency used in the Marketplace as ISO 4217 currency code. For example: USD, EUR, CAD, AUD, etc.
REACT_APP_CANONICAL_ROOT_URL http://localhost:3000 Canonical root url of the marketplace is running. Needed for social media sharing and SEO optimization.
NODE_ENV ? Node env. Use 'dev' for development and 'production' for production.
REACT_APP_ENV production TODO Didn't understand NODE_ENV vs this?
REACT_APP_SHARETRIBE_USING_SSL false Redirect HTTP to HTTPS.
SERVER_SHARETRIBE_TRUST_PROXY false Set when running the app behind a reverse proxy.
REACT_APP_PUBLIC_SENTRY_DSN - See: Error logging with Sentry
SERVER_SENTRY_DSN - See: Error logging with Sentry
REACT_APP_CSP - See: Content Security Policy (CSP)
BASIC_AUTH_USERNAME - Set to enable HTTP Basic Auth
BASIC_AUTH_PASSWORD - Set to enable HTTP Basic Auth
REACT_APP_GOOGLE_ANALYTICS_ID - See: Google Analytics

Defining the env variables

When the Starter App is started locally with yarn run dev you can set environment variables by using the file .env.development.local. However, the server process doesn't currently pick up values from this file. In production it is recommended to set the environment variables on OS level.