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

Document consequences of replacing secrets #18138

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

V02460
Copy link
Contributor

@V02460 V02460 commented Feb 6, 2025

Document consequences of replacing secrets. The covered config options are registration_shared_secret, macaroon_secret_key, form_secret and worker_replication_secret.

Even though I looked at the source code to check the added documentation is right, I would appreciate additional verification of the statements made.

In an hand-wavy attempt at classifying how bad the consequences of secret replacement are, I added some explanations as warnings and others as regular paragraphs.

Closes #17971

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Code style is correct
    (run the linters)

@V02460 V02460 requested a review from a team as a code owner February 6, 2025 11:47
@github-actions github-actions bot deployed to PR Documentation Preview February 6, 2025 11:49 Active
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Clarify behavior when changing secrets
1 participant