Skip to content

Commit

Permalink
Add note that should be set to true if backend auth is turned on. (#566)
Browse files Browse the repository at this point in the history
  • Loading branch information
terryttsai committed May 9, 2022
1 parent 5e756c2 commit 89f2724
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions spotlight-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ Expected environment variables include:

- `REACT_APP_API_URL` - the base URL of the backend API server. This should be set to http://localhost:3001 when running the server locally, and to http://localhost:3002 in the test environment (because some tests will make requests to this URL).
- `REACT_APP_AUTH_ENABLED` - set to `true` or `false` to toggle Auth0 protection per environment. Currently only used in staging to make the entire site private. No need to enable this locally unless you are developing or testing something auth-related. If set to `true` then `REACT_APP_AUTH_ENV` **must** be set to a supported value.
- If the `AUTH_ENABLED` environment variable is set to `true` on the backend, then this must be set to `true` otherwise the app won't be able to fetch metrics. Note that `AUTH_ENABLED` is true on staging, but false in production.
- `REACT_APP_AUTH_ENV` - a string indicating the "auth environment" used to point to the correct Auth0 tenant. `development` (which also covers staging) is the only supported value, which **must** be set if `REACT_APP_AUTH_ENABLED` is `true`.
- `REACT_APP_ENABLED_TENANTS` - a feature flag for activating individual tenants, in the form of a comma-separated list of tenant IDs (e.g., "US_ND,US_PA") that should be available. Tenants that are configured but not enumerated here will not be accessible to users.

Expand Down

0 comments on commit 89f2724

Please sign in to comment.