Matrix-Mirrors/forked-synapse
1
0
Fork 0
mirror of https://mau.dev/maunium/synapse.git synced 2024-10-01 01:36:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update description of server_name config option (#8415)

Browse Source
This commit is contained in:
Aaron Raimist 2020-09-29 12:50:25 -05:00 committed by GitHub
parent c2bdf040aa
commit 8238b55e08
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 35 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/8415.doc Normal file
View File

@ -0,0 +1 @@
Improve description of `server_name` config option in `homserver.yaml`.

21
docs/sample_config.yaml
View File

@ -33,10 +33,23 @@
## Server ## ## Server ##
# The domain name of the server, with optional explicit port. # The public-facing domain of the server
# This is used by remote servers to connect to this server, #
# e.g. matrix.org, localhost:8080, etc. # The server_name name will appear at the end of usernames and room addresses
# This is also the last part of your UserID. # 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 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
# lowercase and may contain an explicit port.
# Examples: matrix.org, localhost:8080
# #
server_name: "SERVERNAME" server_name: "SERVERNAME"

21
synapse/config/server.py
View File

@ -641,10 +641,23 @@ class ServerConfig(Config):
"""\ """\
## Server ## ## Server ##
# The domain name of the server, with optional explicit port. # The public-facing domain of the server
# This is used by remote servers to connect to this server, #
# e.g. matrix.org, localhost:8080, etc. # The server_name name will appear at the end of usernames and room addresses
# This is also the last part of your UserID. # 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 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
# lowercase and may contain an explicit port.
# Examples: matrix.org, localhost:8080
# #
server_name: "%(server_name)s" server_name: "%(server_name)s"