Skip to content
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
matrix-org:developfrom
Ezwen:patch-1
Closed

[Docker docs] Fix macaroon key wrongly "mandatory"#3217
Ezwen wants to merge 1 commit into
matrix-org:developfrom
Ezwen:patch-1

Conversation

@Ezwen
Copy link
Copy Markdown

@Ezwen Ezwen commented May 15, 2018

The SYNAPSE_MACAROON_SECRET_KEY configuration variable is said to be mandatory in the Docker README, while it currently isn't. In fact, the example docker-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 :)

@matrixbot
Copy link
Copy Markdown
Member

Can one of the admins verify this patch?

1 similar comment
@matrixbot
Copy link
Copy Markdown
Member

Can one of the admins verify this patch?

@michaelkaye
Copy link
Copy Markdown
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,
Michael

@Ezwen
Copy link
Copy Markdown
Author

Ezwen commented May 17, 2018

Fine by me! :)

@Ezwen Ezwen closed this May 17, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants