# Configuration file for Synapse.

#

# This is a YAML file: see [1] for a quick introduction. Note in particular

# that *indentation is important*: all the elements of a list or dictionary

# should have the same indentation.

#

# [1] https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html

## 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.

#

server_name: "{{matrix_synapse_server_name}}"

# When running as a daemon, the file to store the pid in

#

pid_file: "/var/run/matrix-synapse.pid"

# The absolute URL to the web client which /_matrix/client will redirect

# to if 'webclient' is configured under the 'listeners' configuration.

#

# This option can be also set to the filesystem path to the web client

# which will be served at /_matrix/client/ if 'webclient' is configured

# under the 'listeners' configuration, however this is a security risk:

# https://github.com/matrix-org/synapse#security-note

#

#web_client_location: https://riot.example.com/

# The public-facing base URL that clients use to access this HS

# (not including _matrix/...). This is the same URL a user would

# enter into the 'custom HS URL' field on their client. If you

# use synapse with a reverse proxy, this should be the URL to reach

# synapse via the proxy.

#

#public_baseurl: https://example.com/

# Set the soft limit on the number of file descriptors synapse can use

# Zero is used to indicate synapse should set the soft limit to the

# hard limit.

#

#soft_file_limit: 0

# Set to false to disable presence tracking on this homeserver.

#

#use_presence: false

# Whether to require authentication to retrieve profile data (avatars,

# display names) of other users through the client API. Defaults to

# 'false'. Note that profile data is also available via the federation

# API, so this setting is of limited value if federation is enabled on

# the server.

#

#require_auth_for_profile_requests: true

# Uncomment to require a user to share a room with another user in order

# to retrieve their profile information. Only checked on Client-Server

# requests. Profile requests from other servers should be checked by the

# requesting server. Defaults to 'false'.

#

#limit_profile_requests_to_users_who_share_rooms: true

# If set to 'true', removes the need for authentication to access the server's

# public rooms directory through the client API, meaning that anyone can

# query the room directory. Defaults to 'false'.

#

#allow_public_rooms_without_auth: true

# If set to 'true', allows any other homeserver to fetch the server's public

# rooms directory via federation. Defaults to 'false'.

#

#allow_public_rooms_over_federation: true

# The default room version for newly created rooms.

#

# Known room versions are listed here:

# https://matrix.org/docs/spec/#complete-list-of-room-versions

#

# For example, for room version 1, default_room_version should be set

# to "1".

#

#default_room_version: "5"

# The GC threshold parameters to pass to `gc.set_threshold`, if defined

#

#gc_thresholds: [700, 10, 10]

# Set the limit on the returned events in the timeline in the get

# and sync operations. The default value is -1, means no upper limit.

#

#filter_timeline_limit: 5000

# Whether room invites to users on this server should be blocked

# (except those sent by local server admins). The default is False.

#

#block_non_admin_invites: true

# Room searching

#

# If disabled, new messages will not be indexed for searching and users

# will receive errors when searching for messages. Defaults to enabled.

#

#enable_search: false

# Restrict federation to the following whitelist of domains.

# N.B. we recommend also firewalling your federation listener to limit

# inbound federation traffic as early as possible, rather than relying

# purely on this application-layer restriction.  If not specified, the

# default is to whitelist everything.

#

#federation_domain_whitelist:

#  - lon.example.com

#  - nyc.example.com

#  - syd.example.com

# Prevent federation requests from being sent to the following

# blacklist IP address CIDR ranges. If this option is not specified, or

# specified with an empty list, no ip range blacklist will be enforced.

#

# As of Synapse v1.4.0 this option also affects any outbound requests to identity

# servers provided by user input.

#

# (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly

# listed here, since they correspond to unroutable addresses.)

#

federation_ip_range_blacklist:

  - '127.0.0.0/8'

  - '10.0.0.0/8'

  - '172.16.0.0/12'

  - '192.168.0.0/16'

  - '100.64.0.0/10'

  - '169.254.0.0/16'

  - '::1/128'

  - 'fe80::/64'

  - 'fc00::/7'

# List of ports that Synapse should listen on, their purpose and their

# configuration.

#

# Options for each listener include:

#

#   port: the TCP port to bind to

#

#   bind_addresses: a list of local addresses to listen on. The default is

#       'all local interfaces'.

#

#   type: the type of listener. Normally 'http', but other valid options are:

#       'manhole' (see docs/manhole.md),

#       'metrics' (see docs/metrics-howto.md),

#       'replication' (see docs/workers.md).

#

#   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.

#

#   x_forwarded: Only valid for an 'http' listener. Set to true to use the

#       X-Forwarded-For header as the client IP. Useful when Synapse is

#       behind a reverse-proxy.

#

#   resources: Only valid for an 'http' listener. A list of resources to host

#       on this port. Options for each resource are:

#

#       names: a list of names of HTTP resources. See below for a list of

#           valid resource names.

#

#       compress: set to true to enable HTTP comression for this resource.

#

#   additional_resources: Only valid for an 'http' listener. A map of

#        additional endpoints which should be loaded via dynamic modules.

#

# Valid resource names are:

#

#   client: the client-server API (/_matrix/client), and the synapse admin

#       API (/_synapse/admin). Also implies 'media' and 'static'.

#

#   consent: user consent forms (/_matrix/consent). See

#       docs/consent_tracking.md.

#

#   federation: the server-server API (/_matrix/federation). Also implies

#       'media', 'keys', 'openid'

#

#   keys: the key discovery API (/_matrix/keys).

#

#   media: the media API (/_matrix/media).

#

#   metrics: the metrics interface. See docs/metrics-howto.md.

#

#   openid: OpenID authentication.

#

#   replication: the HTTP replication API (/_synapse/replication). See

#       docs/workers.md.

#

#   static: static resources under synapse/static (/_matrix/static). (Mostly

#       useful for 'fallback authentication'.)

#

#   webclient: A web client. Requires web_client_location to be set.

#

listeners:

  # TLS-enabled listener: for when matrix traffic is sent directly to synapse.

  #

  # Disabled by default. To enable it, uncomment the following. (Note that you

  # will also need to give Synapse a TLS key and certificate: see the TLS section

  # below.)

  #

  #- port: 8448

  #  type: http

  #  tls: true

  #  resources:

  #    - names: [client, federation]

  # Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy

  # that unwraps TLS.

  #

  # If you plan to use a reverse proxy, please see

  # https://github.com/matrix-org/synapse/blob/master/docs/reverse_proxy.md.

  #

  - port: 8008

    tls: false

    type: http

    x_forwarded: true

    bind_addresses: ['::1', '127.0.0.1']

    resources:

      - names: [client, federation]

        compress: false

    # example additional_resources:

    #

    #additional_resources:

    #  "/_matrix/my/custom/endpoint":

    #    module: my_module.CustomRequestHandler

    #    config: {}

  # Turn on the twisted ssh manhole service on localhost on the given

  # port.

  #

  #- port: 9000

  #  bind_addresses: ['::1', '127.0.0.1']

  #  type: manhole

# Forward extremities can build up in a room due to networking delays between

# homeservers. Once this happens in a large room, calculation of the state of

# that room can become quite expensive. To mitigate this, once the number of

# forward extremities reaches a given threshold, Synapse will send an

# org.matrix.dummy_event event, which will reduce the forward extremities

# in the room.

#

# This setting defines the threshold (i.e. number of forward extremities in the

# room) at which dummy events are sent. The default value is 10.

#

#dummy_events_threshold: 5

## Homeserver blocking ##

# How to reach the server admin, used in ResourceLimitError

#

#admin_contact: 'mailto:[email protected]'

# Global blocking

#

#hs_disabled: false

#hs_disabled_message: 'Human readable reason for why the HS is blocked'

# Monthly Active User Blocking

#

# Used in cases where the admin or server owner wants to limit to the

# number of monthly active users.

#

# 'limit_usage_by_mau' disables/enables monthly active user blocking. When

# anabled and a limit is reached the server returns a 'ResourceLimitError'

# with error type Codes.RESOURCE_LIMIT_EXCEEDED

#

# 'max_mau_value' is the hard limit of monthly active users above which

# the server will start blocking user actions.

#

# 'mau_trial_days' is a means to add a grace period for active users. It

# means that users must be active for this number of days before they

# can be considered active and guards against the case where lots of users

# sign up in a short space of time never to return after their initial

# session.

#

# 'mau_limit_alerting' is a means of limiting client side alerting

# should the mau limit be reached. This is useful for small instances

# where the admin has 5 mau seats (say) for 5 specific people and no

# interest increasing the mau limit further. Defaults to True, which

# means that alerting is enabled

#

#limit_usage_by_mau: false

#max_mau_value: 50

#mau_trial_days: 2

#mau_limit_alerting: false

# If enabled, the metrics for the number of monthly active users will

# be populated, however no one will be limited. If limit_usage_by_mau

# is true, this is implied to be true.

#

#mau_stats_only: false

# Sometimes the server admin will want to ensure certain accounts are

# never blocked by mau checking. These accounts are specified here.

#

#mau_limit_reserved_threepids:

#  - medium: 'email'

#    address: '[email protected]'

# Used by phonehome stats to group together related servers.

#server_context: context

# Resource-constrained homeserver Settings

#

# If limit_remote_rooms.enabled is True, the room complexity will be

# checked before a user joins a new remote room. If it is above

# limit_remote_rooms.complexity, it will disallow joining or

# instantly leave.

#

# limit_remote_rooms.complexity_error can be set to customise the text

# displayed to the user when a room above the complexity threshold has

# its join cancelled.

#

# Uncomment the below lines to enable:

#limit_remote_rooms:

#  enabled: true

#  complexity: 1.0

#  complexity_error: "This room is too complex."

# Whether to require a user to be in the room to add an alias to it.

# Defaults to 'true'.

#

#require_membership_for_aliases: false

# Whether to allow per-room membership profiles through the send of membership

# events with profile information that differ from the target's global profile.

# Defaults to 'true'.

#

#allow_per_room_profiles: false

# How long to keep redacted events in unredacted form in the database. After

# this period redacted events get replaced with their redacted form in the DB.

#

# Defaults to `7d`. Set to `null` to disable.

#

#redaction_retention_period: 28d

# How long to track users' last seen time and IPs in the database.

#

# Defaults to `28d`. Set to `null` to disable clearing out of old rows.

#

#user_ips_max_age: 14d

# Message retention policy at the server level.

#

# Room admins and mods can define a retention period for their rooms using the

# 'm.room.retention' state event, and server admins can cap this period by setting

# the 'allowed_lifetime_min' and 'allowed_lifetime_max' config options.

#

# If this feature is enabled, Synapse will regularly look for and purge events

# which are older than the room's maximum retention period. Synapse will also

# filter events received over federation so that events that should have been

# purged are ignored and not stored again.

#

retention:

  # The message retention policies feature is disabled by default. Uncomment the

  # following line to enable it.

  #

  #enabled: true

  # Default retention policy. If set, Synapse will apply it to rooms that lack the

  # 'm.room.retention' state event. Currently, the value of 'min_lifetime' doesn't

  # matter much because Synapse doesn't take it into account yet.

  #

  #default_policy:

  #  min_lifetime: 1d

  #  max_lifetime: 1y

  # Retention policy limits. If set, a user won't be able to send a

  # 'm.room.retention' event which features a 'min_lifetime' or a 'max_lifetime'

  # that's not within this range. This is especially useful in closed federations,

  # in which server admins can make sure every federating server applies the same

  # rules.

  #

  #allowed_lifetime_min: 1d

  #allowed_lifetime_max: 1y

  # Server admins can define the settings of the background jobs purging the

  # events which lifetime has expired under the 'purge_jobs' section.

  #

  # If no configuration is provided, a single job will be set up to delete expired

  # events in every room daily.

  #

  # Each job's configuration defines which range of message lifetimes the job

  # takes care of. For example, if 'shortest_max_lifetime' is '2d' and

  # 'longest_max_lifetime' is '3d', the job will handle purging expired events in

  # rooms whose state defines a 'max_lifetime' that's both higher than 2 days, and

  # lower than or equal to 3 days. Both the minimum and the maximum value of a

  # range are optional, e.g. a job with no 'shortest_max_lifetime' and a

  # 'longest_max_lifetime' of '3d' will handle every room with a retention policy

  # which 'max_lifetime' is lower than or equal to three days.

  #

  # The rationale for this per-job configuration is that some rooms might have a

  # retention policy with a low 'max_lifetime', where history needs to be purged

  # of outdated messages on a more frequent basis than for the rest of the rooms

  # (e.g. every 12h), but not want that purge to be performed by a job that's

  # iterating over every room it knows, which could be heavy on the server.

  #

  #purge_jobs:

  #  - shortest_max_lifetime: 1d

  #    longest_max_lifetime: 3d

  #    interval: 12h

  #  - shortest_max_lifetime: 3d

  #    longest_max_lifetime: 1y

  #    interval: 1d

# Inhibits the /requestToken endpoints from returning an error that might leak

# information about whether an e-mail address is in use or not on this

# homeserver.

# Note that for some endpoints the error situation is the e-mail already being

# used, and for others the error is entering the e-mail being unused.

# If this option is enabled, instead of returning an error, these endpoints will

# act as if no error happened and return a fake session ID ('sid') to clients.

#

#request_token_inhibit_3pid_errors: true

## TLS ##

# PEM-encoded X509 certificate for TLS.

# This certificate, as of Synapse 1.0, will need to be a valid and verifiable

# certificate, signed by a recognised Certificate Authority.

#

# See 'ACME support' below to enable auto-provisioning this certificate via

# Let's Encrypt.

#

# If supplying your own, be sure to use a `.pem` file that includes the

# full certificate chain including any intermediate certificates (for

# instance, if using certbot, use `fullchain.pem` as your certificate,

# not `cert.pem`).

#

#tls_certificate_path: "path/to/homeserver.tls.crt"

# PEM-encoded private key for TLS

#

#tls_private_key_path: "path/to/homeserver.tls.key"

# Whether to verify TLS server certificates for outbound federation requests.

#

# Defaults to `true`. To disable certificate verification, uncomment the

# following line.

#

#federation_verify_certificates: false

# The minimum TLS version that will be used for outbound federation requests.

#

# Defaults to `1`. Configurable to `1`, `1.1`, `1.2`, or `1.3`. Note

# that setting this value higher than `1.2` will prevent federation to most

# of the public Matrix network: only configure it to `1.3` if you have an

# entirely private federation setup and you can ensure TLS 1.3 support.

#