7d0aeeefe5
* Improve format and clarity of the docs [ci skip] While this change produces a lot of git noise by enacting what seems like an arbitrary linewrap on most of the files in the documentation it will result in better version control and tracking of the changes in the documentation. For example, as it currently stands, if one was to make a PR to move a comma in a sentence because each paragraph in most of the files is on a single line, that small change would look in the git history like the author had modified the entire paragraph. In reality, this author just moved a comma. This change also includes a significant number of modifications to the more article-esque docs. Many of these docs were written in a sort of stream-of-conciousness and aren't as easy to read as they could be. Hopefully this is the first of several readability changes. If we could get these docs to a more accessible reading level, we would probably see an increase in contributions. :) * Delegate markdown wrapping to Prettier * Add linewrapping explanation in the docs [ci skip]
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
---
|
|
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. You'll need to get your own free
|
|
[Algolia credentials][algolia] to get your development environment running.
|
|
|
|
The [backend guide][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 DEV, you'll need to create an
|
|
`application.yml` file. You can do this by copying the file called
|
|
`sample_application.yml` in the `config` directory:
|
|
|
|
```shell
|
|
cp config/sample_application.yml config/application.yml
|
|
```
|
|
|
|
Then, add each key you need to the `application.yml` file. For example, if
|
|
you're setting up GitHub authentication:
|
|
|
|
```shell
|
|
GITHUB_KEY: "SOME_REAL_SECURE_KEY_HERE"
|
|
GITHUB_SECRET: "ANOTHER_REAL_SECURE_KEY_HERE"
|
|
```
|
|
|
|
(Don't worry, your `application.yml` file is ignored by git)
|
|
|
|
If you are missing `ENV` variables on bootup, the [envied][envied] gem will
|
|
alert you with messages similar to `'error_on_missing_variables!': The following environment variables should be set: A_MISSING_KEY.`.
|
|
|
|
Only certain features require "real" keys, so you may be able to add them as you
|
|
work on different areas of the application.
|
|
|
|
[algolia]: /backend/algolia
|
|
[backend_guide]: /backend
|
|
[envied]: https://rubygems.org/gems/envied
|