Skip to main content

Environmental variables

Feel free to copy this table and add your details prior to deployment

Some I haven't included as they are set by Heroku or the resources automatically. I've left DATABASE_URL in though since its kind of important even though heroku sets it up for you!

Outpost

ENV VARValueDescriptionService
FEEDBACK_FORM_URLLink to a feedback form for the service. Shown with the BETA banner for community users.Any, See [[Customising Outpost]]
GOOGLE_API_KEYoutpost_geocode_<ENV>with the geocoding API enabled, to geocode postcodesSee [[Maps]]
GOOGLE_CLIENT_KEYoutpost_maps_<ENV>with the javascript and static maps APIs enabled, to add map views to admin screensSee [[Maps]]
GCP_PROJECTUsed for settings and logo uploadGoogle cloud storage
GCP_BUCKETUsed for settings and logo uploadGoogle cloud storage
GCP_PROJECT_IDUsed for settings and logo uploadGoogle cloud storage
GCP_PRIVATE_KEY_IDUsed for settings and logo uploadGoogle cloud storage
GCP_PRIVATE_KEYUsed for settings and logo uploadGoogle cloud storage
GCP_CLIENT_EMAILUsed for settings and logo uploadGoogle cloud storage
GCP_CLIENT_IDUsed for settings and logo uploadGoogle cloud storage
GCP_CLIENT_X509_CERT_URL"https://www.googleapis.com/robot/v1/"Used for settings and logo uploadGoogle cloud storage
MAILER_FROMno-reply@blah.comFrom email for emailsGOV.UK Notify / Sendgrid
MAILER_HOSThttps://outpost.blah.comwhere the app lives on the web, to correctly form urls in emailsGOV.UK Notify / Sendgrid
NOTIFY_API_KEYAPI key for GOV.UK NotifyGOV.UK Notify
NOTIFY_TEMPLATE_IDTemplate ID for GOV.UK NotifyGOV.UK Notify
SENDGRID_API_KEYNot usedSendgrid
OFSTED_API_KEYAPI key for ofsted
OFSTED_FEED_API_ENDPOINTEndpoint for ofsted feed
DATABASE_URLpostgres://...Filled in automatically by herokuHeroku
DB_URImongodb+srv://<USERNAME>:<PASSWORD>@<INSTANCE>/<USERNAME>?retryWrites=true&w=majorityProvided by Atlas MongoDBAtlas MongoDB
LANGen_US.UTF-8
SCOUT_BUILD_HOOK (deprecated)Outpost will make a POST request to this webhook URL whenever taxonomies are changed. Intended to trigger Scout rebuilds.Netlify
SCOUT_URL (deprecated)Used in emails when changes have been approved.Netlify
OUTPOST_INSTANCE_NAME (deprecated)the name of the Outpost instance. This will appear in invite emails to new users, to let them know who the email is from.
INSTANCE (deprecated?)Was used to set instance specific options before settings were introduced

Extras

  • HEROKU_APP_ID
  • HEROKU_APP_NAME
  • HEROKU_RELEASE_CREATED_AT
  • HEROKU_RELEASE_VERSION
  • HEROKU_SLUG_COMMIT
  • HEROKU_SLUG_DESCRIPTION
  • PAPERTRAIL_API_TOKEN
  • RACK_ENV
  • RAILS_ENV
  • RAILS_LOG_TO_STDOUT enabled
  • RAILS_SERVE_STATIC_FILES enabled
  • SECRET_KEY_BASE
  • SENTRY_DSN

More info

FEEDBACK_FORM_URL

image