Don't add a dummy API key to every new Rails app #28524
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rafaelfranca
requested changes
Mar 22, 2017
| shared: | ||
| api_key: 123 | ||
| # shared: | ||
| # api_key: <%= app_secret %> |
There was a problem hiding this comment.
I'd use a human readable example here since that Make sure the secret is at least 30 characters and all random comment is about the app secret not about a shared api key.
Every new Rails app is currently generated with `Rails.application.secrets[:api_key]` set to `123`. This comes from a line in `config/secrets.yml` that, in my opinion, should be left commented out to only serve as a syntax example, rather than being actually set in every Rails app. Additionally, we might want to give a better example than `123`, since in the same file we are suggesting to > Make sure the secret is at least 30 characters and all random, > no regular words or you'll be exposed to dictionary attacks. The result of this commit is that `config/secrets.yml` will include something like: ```yaml # Shared secrets are available across all environments. # shared: # api_key: f56930851993982510d5bd9236f4108f6fe7c15448f1c6923a51872e0dbae1a24d274b318abb6518b540dfb51079c61640885f607467e5ed1053849be7587d61 ``` rather than this: ```yaml # Shared secrets are available across all environments. shared: api_key: 123 ```
claudiob
force-pushed
the
comment-api-key
branch
from
7693d57
to
4f943eb
Compare
|
@rafaelfranca That makes sense. Let me know if you like this better, or I can just leave as |
rafaelfranca
added a commit
that referenced
this pull request
Mar 22, 2017
Don't add a dummy API key to every new Rails app
|
Backported in 1f1c30d |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Every new Rails app is currently generated with
Rails.application.secrets[:api_key]set to123.This comes from a line in
config/secrets.ymlthat, in my opinion, should be left commented out to only serve as a syntax example, rather than being actually set in every Rails app.Additionally, we might want to give a better example than
123, since in the same file we are suggesting to:The result of this commit is that
config/secrets.ymlwill include something like:rather than: