summary refs log tree commit diff
path: root/docs/admin_api/version_api.md
diff options
context:
space:
mode:
authorV02460 <git@kaialexhiller.de>2025-02-17 15:25:42 +0100
committerGitHub <noreply@github.com>2025-02-17 14:25:42 +0000
commite46295033819032eb3b50eb6e5a8e9adbff59a84 (patch)
tree179bb7990c026c3b79cf78cbf8698aa11c9581f0 /docs/admin_api/version_api.md
parentBump hiredis from 3.0.0 to 3.1.0 (#18169) (diff)
downloadsynapse-e46295033819032eb3b50eb6e5a8e9adbff59a84.tar.xz
Document consequences of replacing secrets (#18138)
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

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [x] Pull request is based on the develop branch
* [x] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
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.
* [x] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
Diffstat (limited to 'docs/admin_api/version_api.md')
0 files changed, 0 insertions, 0 deletions