MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-14 18:43:53 +01:00
Code Issues Projects Releases Wiki Activity

Update links to documentation in sample config (#10287)

Browse source 
Signed-off-by: Dirk Klimpel dirk@klimpel.org
This commit is contained in:
Dirk Klimpel 2021-07-07 13:35:45 +02:00 committed by GitHub
parent 7cb5168087
commit 56fd5fa8e1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 51 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/10287.doc Normal file
View file

@ -0,0 +1 @@
Update links to documentation in sample config. Contributed by @dklimpel.

44
docs/sample_config.yaml
View file

@ -36,7 +36,7 @@
# Server admins can expand Synapse's functionality with external modules. # Server admins can expand Synapse's functionality with external modules.
# #
# See https://matrix-org.github.io/synapse/develop/modules.html for more # See https://matrix-org.github.io/synapse/latest/modules.html for more
# documentation on how to configure or create custom modules for Synapse. # documentation on how to configure or create custom modules for Synapse.
# #
modules: modules:
@ -58,7 +58,7 @@ modules:
# In most cases you should avoid using a matrix specific subdomain such as # 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 # 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. # 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 # See https://matrix-org.github.io/synapse/latest/delegate.html
# for information on how to host Synapse on a subdomain while preserving # for information on how to host Synapse on a subdomain while preserving
# a clean server_name. # a clean server_name.
# #
@ -253,9 +253,9 @@ presence:
# 'all local interfaces'. # 'all local interfaces'.
# #
# type: the type of listener. Normally 'http', but other valid options are: # type: the type of listener. Normally 'http', but other valid options are:
# 'manhole' (see docs/manhole.md), # 'manhole' (see https://matrix-org.github.io/synapse/latest/manhole.html),
# 'metrics' (see docs/metrics-howto.md), # 'metrics' (see https://matrix-org.github.io/synapse/latest/metrics-howto.html),
# 'replication' (see docs/workers.md). # 'replication' (see https://matrix-org.github.io/synapse/latest/workers.html).
# #
# tls: set to true to enable TLS for this listener. Will use the TLS # tls: set to true to enable TLS for this listener. Will use the TLS
# key/cert specified in tls_private_key_path / tls_certificate_path. # key/cert specified in tls_private_key_path / tls_certificate_path.
@ -280,8 +280,8 @@ presence:
# client: the client-server API (/_matrix/client), and the synapse admin # client: the client-server API (/_matrix/client), and the synapse admin
# API (/_synapse/admin). Also implies 'media' and 'static'. # API (/_synapse/admin). Also implies 'media' and 'static'.
# #
# consent: user consent forms (/_matrix/consent). See # consent: user consent forms (/_matrix/consent).
# docs/consent_tracking.md. # See https://matrix-org.github.io/synapse/latest/consent_tracking.html.
# #
# federation: the server-server API (/_matrix/federation). Also implies # federation: the server-server API (/_matrix/federation). Also implies
# 'media', 'keys', 'openid' # 'media', 'keys', 'openid'
@ -290,12 +290,13 @@ presence:
# #
# media: the media API (/_matrix/media). # media: the media API (/_matrix/media).
# #
# metrics: the metrics interface. See docs/metrics-howto.md. # metrics: the metrics interface.
# See https://matrix-org.github.io/synapse/latest/metrics-howto.html.
# #
# openid: OpenID authentication. # openid: OpenID authentication.
# #
# replication: the HTTP replication API (/_synapse/replication). See # replication: the HTTP replication API (/_synapse/replication).
# docs/workers.md. # See https://matrix-org.github.io/synapse/latest/workers.html.
# #
# static: static resources under synapse/static (/_matrix/static). (Mostly # static: static resources under synapse/static (/_matrix/static). (Mostly
# useful for 'fallback authentication'.) # useful for 'fallback authentication'.)
@ -319,7 +320,7 @@ listeners:
# that unwraps TLS. # that unwraps TLS.
# #
# If you plan to use a reverse proxy, please see # If you plan to use a reverse proxy, please see
# https://github.com/matrix-org/synapse/blob/master/docs/reverse_proxy.md. # https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
# #
- port: 8008 - port: 8008
tls: false tls: false
@ -747,7 +748,8 @@ caches:
# cp_min: 5 # cp_min: 5
# cp_max: 10 # cp_max: 10
# #
# For more information on using Synapse with Postgres, see `docs/postgres.md`. # For more information on using Synapse with Postgres,
# see https://matrix-org.github.io/synapse/latest/postgres.html.
# #
database: database:
name: sqlite3 name: sqlite3
@ -900,7 +902,7 @@ media_store_path: "DATADIR/media_store"
# #
# If you are using a reverse proxy you may also need to set this value in # If you are using a reverse proxy you may also need to set this value in
# your reverse proxy's config. Notably Nginx has a small max body size by default. # your reverse proxy's config. Notably Nginx has a small max body size by default.
# See https://matrix-org.github.io/synapse/develop/reverse_proxy.html. # See https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
# #
#max_upload_size: 50M #max_upload_size: 50M
@ -1840,7 +1842,7 @@ saml2_config:
# #
# module: The class name of a custom mapping module. Default is # module: The class name of a custom mapping module. Default is
# 'synapse.handlers.oidc.JinjaOidcMappingProvider'. # 'synapse.handlers.oidc.JinjaOidcMappingProvider'.
# See https://github.com/matrix-org/synapse/blob/master/docs/sso_mapping_providers.md#openid-mapping-providers # See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers
# for information on implementing a custom mapping provider. # for information on implementing a custom mapping provider.
# #
# config: Configuration for the mapping provider module. This section will # config: Configuration for the mapping provider module. This section will
@ -1891,7 +1893,7 @@ saml2_config:
# - attribute: groups # - attribute: groups
# value: "admin" # value: "admin"
# #
# See https://github.com/matrix-org/synapse/blob/master/docs/openid.md # See https://matrix-org.github.io/synapse/latest/openid.html
# for information on how to configure these options. # for information on how to configure these options.
# #
# For backwards compatibility, it is also possible to configure a single OIDC # For backwards compatibility, it is also possible to configure a single OIDC
@ -2169,7 +2171,7 @@ sso:
# Note that this is a non-standard login type and client support is # Note that this is a non-standard login type and client support is
# expected to be non-existent. # expected to be non-existent.
# #
# See https://github.com/matrix-org/synapse/blob/master/docs/jwt.md. # See https://matrix-org.github.io/synapse/latest/jwt.html.
# #
#jwt_config: #jwt_config:
# Uncomment the following to enable authorization using JSON web # Uncomment the following to enable authorization using JSON web
@ -2469,7 +2471,7 @@ email:
# ex. LDAP, external tokens, etc. # ex. LDAP, external tokens, etc.
# #
# For more information and known implementations, please see # For more information and known implementations, please see
# https://github.com/matrix-org/synapse/blob/master/docs/password_auth_providers.md # https://matrix-org.github.io/synapse/latest/password_auth_providers.html
# #
# Note: instances wishing to use SAML or CAS authentication should # Note: instances wishing to use SAML or CAS authentication should
# instead use the `saml2_config` or `cas_config` options, # instead use the `saml2_config` or `cas_config` options,
@ -2571,7 +2573,7 @@ user_directory:
# #
# If you set it true, you'll have to rebuild the user_directory search # If you set it true, you'll have to rebuild the user_directory search
# indexes, see: # indexes, see:
# https://github.com/matrix-org/synapse/blob/master/docs/user_directory.md # https://matrix-org.github.io/synapse/latest/user_directory.html
# #
# Uncomment to return search results containing all known users, even if that # Uncomment to return search results containing all known users, even if that
# user does not share a room with the requester. # user does not share a room with the requester.
@ -2591,7 +2593,7 @@ user_directory:
# User Consent configuration # User Consent configuration
# #
# for detailed instructions, see # for detailed instructions, see
# https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md # https://matrix-org.github.io/synapse/latest/consent_tracking.html
# #
# Parts of this section are required if enabling the 'consent' resource under # Parts of this section are required if enabling the 'consent' resource under
# 'listeners', in particular 'template_dir' and 'version'. # 'listeners', in particular 'template_dir' and 'version'.
@ -2641,7 +2643,7 @@ user_directory:
# Settings for local room and user statistics collection. See # Settings for local room and user statistics collection. See
# docs/room_and_user_statistics.md. # https://matrix-org.github.io/synapse/latest/room_and_user_statistics.html.
# #
stats: stats:
# Uncomment the following to disable room and user statistics. Note that doing # Uncomment the following to disable room and user statistics. Note that doing
@ -2768,7 +2770,7 @@ opentracing:
#enabled: true #enabled: true
# The list of homeservers we wish to send and receive span contexts and span baggage. # The list of homeservers we wish to send and receive span contexts and span baggage.
# See docs/opentracing.rst. # See https://matrix-org.github.io/synapse/latest/opentracing.html.
# #
# This is a list of regexes which are matched against the server_name of the # This is a list of regexes which are matched against the server_name of the
# homeserver. # homeserver.

2
docs/sample_log_config.yaml
View file

@ -7,7 +7,7 @@
# be ingested by ELK stacks. See [2] for details. # be ingested by ELK stacks. See [2] for details.
# #
# [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema # [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
# [2]: https://github.com/matrix-org/synapse/blob/master/docs/structured_logging.md # [2]: https://matrix-org.github.io/synapse/latest/structured_logging.html
version: 1 version: 1

2
synapse/config/consent.py
View file

@ -22,7 +22,7 @@ DEFAULT_CONFIG = """\
# User Consent configuration # User Consent configuration
# #
# for detailed instructions, see # for detailed instructions, see
# https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md # https://matrix-org.github.io/synapse/latest/consent_tracking.html
# #
# Parts of this section are required if enabling the 'consent' resource under # Parts of this section are required if enabling the 'consent' resource under
# 'listeners', in particular 'template_dir' and 'version'. # 'listeners', in particular 'template_dir' and 'version'.

3
synapse/config/database.py
View file

@ -62,7 +62,8 @@ DEFAULT_CONFIG = """\
# cp_min: 5 # cp_min: 5
# cp_max: 10 # cp_max: 10
# #
# For more information on using Synapse with Postgres, see `docs/postgres.md`. # For more information on using Synapse with Postgres,
# see https://matrix-org.github.io/synapse/latest/postgres.html.
# #
database: database:
name: sqlite3 name: sqlite3

2
synapse/config/jwt.py
View file

@ -64,7 +64,7 @@ class JWTConfig(Config):
# Note that this is a non-standard login type and client support is # Note that this is a non-standard login type and client support is
# expected to be non-existent. # expected to be non-existent.
# #
# See https://github.com/matrix-org/synapse/blob/master/docs/jwt.md. # See https://matrix-org.github.io/synapse/latest/jwt.html.
# #
#jwt_config: #jwt_config:
# Uncomment the following to enable authorization using JSON web # Uncomment the following to enable authorization using JSON web

2
synapse/config/logger.py
View file

@ -49,7 +49,7 @@ DEFAULT_LOG_CONFIG = Template(
# be ingested by ELK stacks. See [2] for details. # be ingested by ELK stacks. See [2] for details.
# #
# [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema # [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
# [2]: https://github.com/matrix-org/synapse/blob/master/docs/structured_logging.md # [2]: https://matrix-org.github.io/synapse/latest/structured_logging.html
version: 1 version: 1

2
synapse/config/modules.py
View file

@ -37,7 +37,7 @@ class ModulesConfig(Config):
# Server admins can expand Synapse's functionality with external modules. # Server admins can expand Synapse's functionality with external modules.
# #
# See https://matrix-org.github.io/synapse/develop/modules.html for more # See https://matrix-org.github.io/synapse/latest/modules.html for more
# documentation on how to configure or create custom modules for Synapse. # documentation on how to configure or create custom modules for Synapse.
# #
modules: modules:

4
synapse/config/oidc.py
View file

@ -166,7 +166,7 @@ class OIDCConfig(Config):
# #
# module: The class name of a custom mapping module. Default is # module: The class name of a custom mapping module. Default is
# {mapping_provider!r}. # {mapping_provider!r}.
# See https://github.com/matrix-org/synapse/blob/master/docs/sso_mapping_providers.md#openid-mapping-providers # See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers
# for information on implementing a custom mapping provider. # for information on implementing a custom mapping provider.
# #
# config: Configuration for the mapping provider module. This section will # config: Configuration for the mapping provider module. This section will
@ -217,7 +217,7 @@ class OIDCConfig(Config):
# - attribute: groups # - attribute: groups
# value: "admin" # value: "admin"
# #
# See https://github.com/matrix-org/synapse/blob/master/docs/openid.md # See https://matrix-org.github.io/synapse/latest/openid.html
# for information on how to configure these options. # for information on how to configure these options.
# #
# For backwards compatibility, it is also possible to configure a single OIDC # For backwards compatibility, it is also possible to configure a single OIDC

2
synapse/config/password_auth_providers.py
View file

@ -57,7 +57,7 @@ class PasswordAuthProviderConfig(Config):
# ex. LDAP, external tokens, etc. # ex. LDAP, external tokens, etc.
# #
# For more information and known implementations, please see # For more information and known implementations, please see
# https://github.com/matrix-org/synapse/blob/master/docs/password_auth_providers.md # https://matrix-org.github.io/synapse/latest/password_auth_providers.html
# #
# Note: instances wishing to use SAML or CAS authentication should # Note: instances wishing to use SAML or CAS authentication should
# instead use the `saml2_config` or `cas_config` options, # instead use the `saml2_config` or `cas_config` options,

2
synapse/config/repository.py
View file

@ -250,7 +250,7 @@ class ContentRepositoryConfig(Config):
# #
# If you are using a reverse proxy you may also need to set this value in # If you are using a reverse proxy you may also need to set this value in
# your reverse proxy's config. Notably Nginx has a small max body size by default. # your reverse proxy's config. Notably Nginx has a small max body size by default.
# See https://matrix-org.github.io/synapse/develop/reverse_proxy.html. # See https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
# #
#max_upload_size: 50M #max_upload_size: 50M

23
synapse/config/server.py
View file

@ -153,7 +153,7 @@ ROOM_COMPLEXITY_TOO_GREAT = (
METRICS_PORT_WARNING = """\ METRICS_PORT_WARNING = """\
The metrics_port configuration option is deprecated in Synapse 0.31 in favour of The metrics_port configuration option is deprecated in Synapse 0.31 in favour of
a listener. Please see a listener. Please see
https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md https://matrix-org.github.io/synapse/latest/metrics-howto.html
on how to configure the new listener. on how to configure the new listener.
--------------------------------------------------------------------------------""" --------------------------------------------------------------------------------"""
@ -811,7 +811,7 @@ class ServerConfig(Config):
# In most cases you should avoid using a matrix specific subdomain such as # 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 # 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. # 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 # See https://matrix-org.github.io/synapse/latest/delegate.html
# for information on how to host Synapse on a subdomain while preserving # for information on how to host Synapse on a subdomain while preserving
# a clean server_name. # a clean server_name.
# #
@ -988,9 +988,9 @@ class ServerConfig(Config):
# 'all local interfaces'. # 'all local interfaces'.
# #
# type: the type of listener. Normally 'http', but other valid options are: # type: the type of listener. Normally 'http', but other valid options are:
# 'manhole' (see docs/manhole.md), # 'manhole' (see https://matrix-org.github.io/synapse/latest/manhole.html),
# 'metrics' (see docs/metrics-howto.md), # 'metrics' (see https://matrix-org.github.io/synapse/latest/metrics-howto.html),
# 'replication' (see docs/workers.md). # 'replication' (see https://matrix-org.github.io/synapse/latest/workers.html).
# #
# tls: set to true to enable TLS for this listener. Will use the TLS # tls: set to true to enable TLS for this listener. Will use the TLS
# key/cert specified in tls_private_key_path / tls_certificate_path. # key/cert specified in tls_private_key_path / tls_certificate_path.
@ -1015,8 +1015,8 @@ class ServerConfig(Config):
# client: the client-server API (/_matrix/client), and the synapse admin # client: the client-server API (/_matrix/client), and the synapse admin
# API (/_synapse/admin). Also implies 'media' and 'static'. # API (/_synapse/admin). Also implies 'media' and 'static'.
# #
# consent: user consent forms (/_matrix/consent). See # consent: user consent forms (/_matrix/consent).
# docs/consent_tracking.md. # See https://matrix-org.github.io/synapse/latest/consent_tracking.html.
# #
# federation: the server-server API (/_matrix/federation). Also implies # federation: the server-server API (/_matrix/federation). Also implies
# 'media', 'keys', 'openid' # 'media', 'keys', 'openid'
@ -1025,12 +1025,13 @@ class ServerConfig(Config):
# #
# media: the media API (/_matrix/media). # media: the media API (/_matrix/media).
# #
# metrics: the metrics interface. See docs/metrics-howto.md. # metrics: the metrics interface.
# See https://matrix-org.github.io/synapse/latest/metrics-howto.html.
# #
# openid: OpenID authentication. # openid: OpenID authentication.
# #
# replication: the HTTP replication API (/_synapse/replication). See # replication: the HTTP replication API (/_synapse/replication).
# docs/workers.md. # See https://matrix-org.github.io/synapse/latest/workers.html.
# #
# static: static resources under synapse/static (/_matrix/static). (Mostly # static: static resources under synapse/static (/_matrix/static). (Mostly
# useful for 'fallback authentication'.) # useful for 'fallback authentication'.)
@ -1050,7 +1051,7 @@ class ServerConfig(Config):
# that unwraps TLS. # that unwraps TLS.
# #
# If you plan to use a reverse proxy, please see # If you plan to use a reverse proxy, please see
# https://github.com/matrix-org/synapse/blob/master/docs/reverse_proxy.md. # https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
# #
%(unsecure_http_bindings)s %(unsecure_http_bindings)s

2
synapse/config/spam_checker.py
View file

@ -26,7 +26,7 @@ LEGACY_SPAM_CHECKER_WARNING = """
This server is using a spam checker module that is implementing the deprecated spam This server is using a spam checker module that is implementing the deprecated spam
checker interface. Please check with the module's maintainer to see if a new version checker interface. Please check with the module's maintainer to see if a new version
supporting Synapse's generic modules system is available. supporting Synapse's generic modules system is available.
For more information, please see https://matrix-org.github.io/synapse/develop/modules.html For more information, please see https://matrix-org.github.io/synapse/latest/modules.html
---------------------------------------------------------------------------------------""" ---------------------------------------------------------------------------------------"""

2
synapse/config/stats.py
View file

@ -51,7 +51,7 @@ class StatsConfig(Config):
def generate_config_section(self, config_dir_path, server_name, **kwargs): def generate_config_section(self, config_dir_path, server_name, **kwargs):
return """ return """
# Settings for local room and user statistics collection. See # Settings for local room and user statistics collection. See
# docs/room_and_user_statistics.md. # https://matrix-org.github.io/synapse/latest/room_and_user_statistics.html.
# #
stats: stats:
# Uncomment the following to disable room and user statistics. Note that doing # Uncomment the following to disable room and user statistics. Note that doing

2
synapse/config/tracer.py
View file

@ -81,7 +81,7 @@ class TracerConfig(Config):
#enabled: true #enabled: true
# The list of homeservers we wish to send and receive span contexts and span baggage. # The list of homeservers we wish to send and receive span contexts and span baggage.
# See docs/opentracing.rst. # See https://matrix-org.github.io/synapse/latest/opentracing.html.
# #
# This is a list of regexes which are matched against the server_name of the # This is a list of regexes which are matched against the server_name of the
# homeserver. # homeserver.

2
synapse/config/user_directory.py
View file

@ -50,7 +50,7 @@ class UserDirectoryConfig(Config):
# #
# If you set it true, you'll have to rebuild the user_directory search # If you set it true, you'll have to rebuild the user_directory search
# indexes, see: # indexes, see:
# https://github.com/matrix-org/synapse/blob/master/docs/user_directory.md # https://matrix-org.github.io/synapse/latest/user_directory.html
# #
# Uncomment to return search results containing all known users, even if that # Uncomment to return search results containing all known users, even if that
# user does not share a room with the requester. # user does not share a room with the requester.