Skip to content

Commit

Permalink
fix(config): remove unsupported inline comments from .env.example, an…
Browse files Browse the repository at this point in the history
…d format

dotenv does not actually support inline comments, so these comments were
being parsed incorrectly as part of the environment variable values.

Upstream issue: motdotla/dotenv#484

This also groups and sorts the environment variables for readability,
and removes the quotes around values.

(Quotes should probably only be used around values with significant
spaces, to avoid confusion.)
  • Loading branch information
PiDelport committed Jul 16, 2021
1 parent 68f81a5 commit 9131f1e
Showing 1 changed file with 28 additions and 23 deletions.
51 changes: 28 additions & 23 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
AUTH0_DOMAIN= # Required
AUTH0_AUDIENCE="http://localhost:3000" # Required
AUTH0_CLIENT_ID="someClientId"
AUTH0_CLIENT_SECRET="someClientSecret"
AUTH0_API_KEY="someapikey" # Required
# App config
PORT=3000
#HOST=localhost
HTTP_LOG_LEVEL=debug
MONGO_URI=mongodb://localhost:27017/registree-core

ADMIN_API_KEY="someapikey" # Required
# Storage
# True to store uploads locally, if not set S3 details is required
LOCAL_OBJECT_STORAGE=true
#S3_ENDPOINT=someS3Endpont.example.com
#S3_ACCESS_KEY_ID=someS3AccessKey
#S3_SECRET=someS3Secret

PORT=3000 # Optional
# Auth config
AUTH0_DOMAIN=
AUTH0_CLIENT_ID=someClientId
AUTH0_CLIENT_SECRET=someClientSecret
AUTH0_AUDIENCE=http://localhost:3000
AUTH0_MANAGEMENT_API=https://link.to/auth0/management/api
AUTH0_CONNECTION=Connection-Name
AUTH0_API_KEY=someapikey
ADMIN_API_KEY=someapikey
# Set NODE_ENV to "develop" to ignore JWT expiration.
NODE_ENV=develop

LOCAL_OBJECT_STORAGE="true" # True to store uploads locally, if not set S3 details is required
# S3_ENDPOINT="someS3Endpont.example.com"
# S3_ACCESS_KEY_ID="someS3AccessKey"
# S3_SECRET="someS3Secret"
HTTP_LOG_LEVEL="debug"
NODE_ENV="develop"

CUSTOMER_API="http://someapi.com" # Required
QUERY_API="http://query-api.example.com" # Required
STUDENT_API="http://student-api.example.com" # required
LINKING_API="http://linking-api.example.com"
IDENTIFYING_API="http://identifying-api.example.com"
MONGO_URI="mongodb://localhost:27017/registree-core"

AUTH0_MANAGEMENT_API="https://link.to/auth0/management/api"
AUTH0_CONNECTION="Connection-Name"
# API config
CUSTOMER_API=http://someapi.com
QUERY_API=http://query-api.example.com
STUDENT_API=http://student-api.example.com
LINKING_API=http://linking-api.example.com
IDENTIFYING_API=http://identifying-api.example.com

0 comments on commit 9131f1e

Please sign in to comment.