docbrown/docs/getting-started/config-env.md
Molly Struve 1be8c72206
[deploy] Refactor:Remove ENVied Gem, Use dotenv Instead for Test and Development (#9621)
* Refactor:Remove ENVied Gem in Favor of Default application.yml

* Copy sample_application.yml for Travis

* Create .env_sample file, Warn of missing ENV variables, ignore .env file

* Use dotenv For ENV variables and create Rake Task to Populate

* Update docs to copy .env_sample file

* make application config a bit more resilient

* update more documentation and only initialize dotenv in dev and test

* Update doc code snippet types and refactor rake task and app config

* remove push defaults

* Make initializers more resilient, remove unused ENV from travis

* Exit new rake task if application.yml does not exist, include dotenv in docs
2020-08-12 11:01:38 -04:00

1.2 KiB

title
Configuring Environment Variables

Configuring environment variables and secret keys

Take a look at Envfile. This file lists all the ENV variables we use and provides a fake default for any missing keys.

The backend guide will show you how to get free API keys for additional services that may be required to run certain parts of the app.

To set up keys for your local instance of Forem, you'll need to create an .env file. You can do this by copying the file called .env_sample in the config directory:

cp config/.env_sample .env

Then, add each key you need to the .env file. For example, if you're setting up GitHub authentication:

export GITHUB_KEY="SOME_REAL_SECURE_KEY_HERE"
export GITHUB_SECRET="ANOTHER_REAL_SECURE_KEY_HERE"

(Don't worry, your .env file is ignored by git)

If you are missing ENV variables when you boot your application you will see a warning message in your logs when you try to access that variable Unset ENV variable: xyz.

Only certain features require "real" keys, so you may be able to add them as you work on different areas of the application.