Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add context when changing secret_key_base #47723

Merged
merged 1 commit into from
Apr 5, 2023
Merged

Conversation

kinduff
Copy link
Contributor

@kinduff kinduff commented Mar 21, 2023

Motivation / Background

The current documentation in https://github.com/rails/rails/blob/main/guides/source/security.md#L118 only mentions that changing secret_key_base will expire currently active sessions, but it does not list other things that will be affected such as encrypted cookies, signed cookies, and Action Text attachments.

This Pull Request aims to add additional context to the documentation to better inform users of the potential impacts of changing the secret_key_base.

Detail

N/A

Additional information

N/A

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@rails-bot rails-bot bot added the docs label Mar 21, 2023
Fixes rails#47060

Adds additional context of what it will be lost in case the `secret_key_base` changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants