This repository was archived by the owner on Apr 26, 2024. It is now read-only.
[Docker docs] Fix macaroon key wrongly "mandatory"#3217
Closed
Ezwen wants to merge 1 commit into
Closed
Conversation
Member
|
Can one of the admins verify this patch? |
1 similar comment
Member
|
Can one of the admins verify this patch? |
Contributor
|
Hi Ezwen, thanks for noticing this and raising a PR for it. This token is actually generated automatically if it's missing, so as well as being non-mandatory, it also needs to be in the section about generated secrets. I was doing some updates to the documentation already, so rather than bounce back and forth on this PR over a single doc line, I've made the change on my branch to include this information - #3222 Thanks, |
Author
|
Fine by me! :) |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The
SYNAPSE_MACAROON_SECRET_KEYconfiguration variable is said to be mandatory in the Docker README, while it currently isn't. In fact, the exampledocker-compose.yml(https://github.com/Ezwen/synapse/blob/develop/contrib/docker/docker-compose.yml) does not even use this variable.This PR just removes the word "mandatory" from the README :)