diff options
| author | Brendan Abolivier <babolivier@matrix.org> | 2019-02-19 10:59:26 +0000 |
|---|---|---|
| committer | Brendan Abolivier <babolivier@matrix.org> | 2019-02-19 10:59:26 +0000 |
| commit | 5a707a2f9a82ed67f5339ff2c6898790341ce20f (patch) | |
| tree | f6d976d05721a8cc7c0ecf9633742695c5fe2bfe /synapse | |
| parent | Fetch ACME domain into an instance member (diff) | |
| download | synapse-5a707a2f9a82ed67f5339ff2c6898790341ce20f.tar.xz | |
Improve config documentation
Diffstat (limited to 'synapse')
| -rw-r--r-- | synapse/config/tls.py | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/synapse/config/tls.py b/synapse/config/tls.py index a3a5ece681..38425bb056 100644 --- a/synapse/config/tls.py +++ b/synapse/config/tls.py @@ -230,9 +230,17 @@ class TlsConfig(Config): # # reprovision_threshold: 30 - # What domain the certificate should be for. Only useful if - # delegation via a /.well-known/matrix/server file is being used. - # Defaults to the server_name configuration parameter. + # The domain that the certificate should be for. Normally this + # should be the same as your Matrix domain (i.e., 'server_name'), but, + # by putting a file at 'https://<server_name>/.well-known/matrix/server', + # you can delegate incoming traffic to another server. If you do that, + # you should give the target of the delegation here. + # + # For example: if your 'server_name' is 'example.com', but + # 'https://example.com/.well-known/matrix/server' delegates to + # 'matrix.example.com', you should put 'matrix.example.com' here. + # + # If not set, defaults to your 'server_name'. # # domain: matrix.example.com |