From 6837144f7af64a828b31cd4f9bda8c3ba1752b7f Mon Sep 17 00:00:00 2001 From: haslersn Date: Sat, 1 Dec 2018 09:26:53 +0100 Subject: [PATCH] Comment that secrets mustn't contain quotes/backticks Putting a backtick into the variable `matrix_synapse_macaroon_secret_key` leads to an error when starting `matrix-synapse.service`, so the service can't start. Error Message: ``` [...] [...] docker[19227]: yaml.scanner.ScannerError: while scanning a double-quoted scalar [...] docker[19227]: in /data/homeserver.yaml, line 451, column 29 [...] docker[19227]: found unknown escape character '`' [...] docker[19227]: in /data/homeserver.yaml, line 451, column 37 [...] docker[19227]: Traceback (most recent call last): [...] docker[19227]: File /start.py, line 66, in [...] ``` Therefore, added comments that the secrets mustn't contain quotes or backticks. --- examples/host-vars.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/examples/host-vars.yml b/examples/host-vars.yml index 80a4c13e..d81a6e8d 100644 --- a/examples/host-vars.yml +++ b/examples/host-vars.yml @@ -20,8 +20,10 @@ host_specific_hostname_identity: YOUR_BARE_DOMAIN_NAME_HERE # A shared secret (between Synapse and Coturn) used for authentication. # You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`). +# It must NOT contain any quotes or backticks. matrix_coturn_turn_static_auth_secret: "" # A secret used to protect access keys issued by the server. # You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`). +# It must NOT contain any quotes or backticks. matrix_synapse_macaroon_secret_key: ""