From fbaa35d85fe9e729a0272fea4289b1952d530b0f Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Mon, 28 Sep 2020 14:25:51 -0500 Subject: [PATCH 1/6] Update description of server_name config option Signed-off-by: Aaron Raimist --- synapse/config/server.py | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/synapse/config/server.py b/synapse/config/server.py index 532b91047024..fa8fcff6b860 100644 --- a/synapse/config/server.py +++ b/synapse/config/server.py @@ -641,10 +641,22 @@ def generate_config_section( """\ ## Server ## - # The domain name of the server, with optional explicit port. - # This is used by remote servers to connect to this server, - # e.g. matrix.org, localhost:8080, etc. - # This is also the last part of your UserID. + # The public facing domain of the server + # + # The server_name name will appear at the end of usernames and room addresses + # created on this server. For example if the server_name was example.com, + # usernames on this server would be in the format @user:example.com + # + # In most cases you should avoid using a matrix specific subdomain such as + # matrix.example.com or synapse.example.com as the server_name for the same + # reasons you wouldn't use user@email.example.com as your email address. + # See docs/delegate.md for information on how to host Synapse on a subdomain + # while preserving a clean server_name. + # + # The server_name cannot be changed later so it is important to + # configure this correctly before you start Synapse. It should be all + # lowercase and may contain an explicit port. + # Examples: matrix.org, localhost:8080 # server_name: "%(server_name)s" From 72d76278f6c14d99ca64888ed49cc9922ab63282 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Mon, 28 Sep 2020 14:28:11 -0500 Subject: [PATCH 2/6] Add changelog Signed-off-by: Aaron Raimist --- changelog.d/8415.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/8415.doc diff --git a/changelog.d/8415.doc b/changelog.d/8415.doc new file mode 100644 index 000000000000..28b579853364 --- /dev/null +++ b/changelog.d/8415.doc @@ -0,0 +1 @@ +Improve description of `server_name` config option in `homserver.yaml`. \ No newline at end of file From 423c65a4e5190aa9a67a2eb19326f2eddd30bcc9 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Mon, 28 Sep 2020 14:34:14 -0500 Subject: [PATCH 3/6] Actually regenerate the sample config Signed-off-by: Aaron Raimist --- docs/sample_config.yaml | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 845f53779530..b59c185e5fa9 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -33,10 +33,22 @@ ## Server ## -# The domain name of the server, with optional explicit port. -# This is used by remote servers to connect to this server, -# e.g. matrix.org, localhost:8080, etc. -# This is also the last part of your UserID. +# The public facing domain of the server +# +# The server_name name will appear at the end of usernames and room addresses +# created on this server. For example if the server_name was example.com, +# usernames on this server would be in the format @user:example.com +# +# In most cases you should avoid using a matrix specific subdomain such as +# matrix.example.com or synapse.example.com as the server_name for the same +# reasons you wouldn't use user@email.example.com as your email address. +# See docs/delegate.md for information on how to host Synapse on a subdomain +# while preserving a clean server_name. +# +# The server_name cannot be changed later so it is important to +# configure this correctly before you start Synapse. It should be all +# lowercase and may contain an explicit port. +# Examples: matrix.org, localhost:8080 # server_name: "SERVERNAME" From 9b045a63ab9fdfd2f77efbd873343e8da55df441 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Mon, 28 Sep 2020 17:55:48 -0500 Subject: [PATCH 4/6] public facing -> public-facing Co-authored-by: Patrick Cloke --- synapse/config/server.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/synapse/config/server.py b/synapse/config/server.py index fa8fcff6b860..6ae7c661f8c4 100644 --- a/synapse/config/server.py +++ b/synapse/config/server.py @@ -641,7 +641,7 @@ def generate_config_section( """\ ## Server ## - # The public facing domain of the server + # The public-facing domain of the server # # The server_name name will appear at the end of usernames and room addresses # created on this server. For example if the server_name was example.com, From 808a966123f4d448f36dbe55b848646e126dfdcc Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Tue, 29 Sep 2020 06:58:28 -0400 Subject: [PATCH 5/6] Sync sample config. --- docs/sample_config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index b59c185e5fa9..37066aef0167 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -33,7 +33,7 @@ ## Server ## -# The public facing domain of the server +# The public-facing domain of the server # # The server_name name will appear at the end of usernames and room addresses # created on this server. For example if the server_name was example.com, From 6d8562dd98b49a322c6a1a7bcf33ca4a935044c4 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Tue, 29 Sep 2020 12:20:56 -0500 Subject: [PATCH 6/6] Use full link Signed-off-by: Aaron Raimist --- docs/sample_config.yaml | 5 +++-- synapse/config/server.py | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 37066aef0167..70cc06a6d87d 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -42,8 +42,9 @@ # In most cases you should avoid using a matrix specific subdomain such as # matrix.example.com or synapse.example.com as the server_name for the same # reasons you wouldn't use user@email.example.com as your email address. -# See docs/delegate.md for information on how to host Synapse on a subdomain -# while preserving a clean server_name. +# See https://github.com/matrix-org/synapse/blob/master/docs/delegate.md +# for information on how to host Synapse on a subdomain while preserving +# a clean server_name. # # The server_name cannot be changed later so it is important to # configure this correctly before you start Synapse. It should be all diff --git a/synapse/config/server.py b/synapse/config/server.py index 6ae7c661f8c4..ef6d70e3f857 100644 --- a/synapse/config/server.py +++ b/synapse/config/server.py @@ -650,8 +650,9 @@ def generate_config_section( # In most cases you should avoid using a matrix specific subdomain such as # matrix.example.com or synapse.example.com as the server_name for the same # reasons you wouldn't use user@email.example.com as your email address. - # See docs/delegate.md for information on how to host Synapse on a subdomain - # while preserving a clean server_name. + # See https://github.com/matrix-org/synapse/blob/master/docs/delegate.md + # for information on how to host Synapse on a subdomain while preserving + # a clean server_name. # # The server_name cannot be changed later so it is important to # configure this correctly before you start Synapse. It should be all