ENV Reference

Here are the configuration variables for the MakeAPI server, and their purpose in the codebase.

---

SESSION_SECRET

• This (hopefully humourous) phrase will be used to generate a session signature to secure the cookie the server relies on.

PORT

• The MakeAPI server will be accessible through the port specified in this variable.

NODE_ENV

• This variable controls how server activity is logged, and can be set to production or development

MONGO_URL

• The URI of the MongoDB server the MakeAPI will be using

ELASTIC_SEARCH_URL

• Host and port for your Elastic search cluster

AUDIENCE

• This variable must contain the full URI of the webmaker.org server as understood by a web browser in order for the Persona-based single-sign on functionality to work

STATSD_HOST

STATSD_PORT

STATSD_PREFIX

• These variables configure the server to send metrics data to a statsd server for tracking. If these are left empty, no stats will be collected or sent to a server. Only STATSD_HOST and STATSD_PORT are required. STATSD_PREFIX is an optional prefix for all stats (defaults to "development.makeapi" or "production.makeapi" if left blank).

LOGIN_SERVER_URL_WITH_AUTH

• This is the URI for the Login server, including Basicauth credentials

FORCE_SSL

For most situations, this variable shouldn't be modified. If the server is running in a production environment, and is operating behind a load-balancer using SSL, this should be set to true.

LOGIN_SERVER

• Login server URI without basicauth for webmaker SSO

USE_DEV_KEY_LOOKUP

• When set to true, forces MakeAPI call authentication to look for "00000000-0000-0000-000000000000" public/private keys from the requesting server. SHOULD ONLY BE USED IN DEVELOPMENT!

ENABLE_GELF_LOGS

• Enables GELF style logging when true