homeserver.yaml.j2 53.1 KB
Newer Older
1
# vim:ft=yaml sw=2 et:
2

3
4
5
6
7
8
## 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.
9
#
10
server_name: "{{ matrix_server_name }}"
11
12

# When running as a daemon, the file to store the pid in
13
#
14
15
#pid_file: /var/lib/synapse/homeserver.pid

16
17
18
# The path to the web client which will be served at /_matrix/client/
# if 'webclient' is configured under the 'listeners' configuration.
#
19
#web_client_location: "/path/to/web/root"
20

21
22
23
24
25
# 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.
26
#
27
public_baseurl: https://{{ matrix_domain }}/
28
29
30
31

# 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.
32
33
#
#soft_file_limit: 0
34

35
# Set to false to disable presence tracking on this homeserver.
36
#
37
38
39
40
41
42
43
44
45
46
#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

47
48
49
50
51
52
53
# If set to 'false', requires authentication to access the server's public rooms
# directory through the client API. Defaults to 'true'.
#
#allow_public_rooms_without_auth: false

# If set to 'false', forbids any other homeserver to fetch the server's public
# rooms directory via federation. Defaults to 'true'.
54
#
55
#allow_public_rooms_over_federation: false
56

57
58
59
60
61
62
63
64
# 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".
#
65
#default_room_version: "5"
66

67
# The GC threshold parameters to pass to `gc.set_threshold`, if defined
68
69
#
#gc_thresholds: [700, 10, 10]
70

71
72
# 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.
73
74
#
#filter_timeline_limit: 5000
75
76
77

# Whether room invites to users on this server should be blocked
# (except those sent by local server admins). The default is False.
78
#
79
#block_non_admin_invites: true
80
81
82
83
84
85
86

# 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
87
88
89
90
91
92
93

# 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.
#
94
#federation_domain_whitelist:
95
96
97
98
#  - lon.example.com
#  - nyc.example.com
#  - syd.example.com

99
100
101
102
# 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.
#
103
104
105
# As of Synapse v1.4.0 this option also affects any outbound requests to identity
# servers provided by user input.
#
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# (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'

120
121
# List of ports that Synapse should listen on, their purpose and their
# configuration.
122
123
124
125
126
127
128
129
130
131
#
# 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),
132
133
#       'metrics' (see docs/metrics-howto.md),
#       'replication' (see docs/workers.md).
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
#
#   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:
#
155
156
#   client: the client-server API (/_matrix/client), and the synapse admin
#       API (/_synapse/admin). Also implies 'media' and 'static'.
157
158
159
160
161
162
163
164
165
166
167
#
#   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).
#
168
#   metrics: the metrics interface. See docs/metrics-howto.md.
169
170
171
172
#
#   openid: OpenID authentication.
#
#   replication: the HTTP replication API (/_synapse/replication). See
173
#       docs/workers.md.
174
175
176
177
178
179
#
#   static: static resources under synapse/static (/_matrix/static). (Mostly
#       useful for 'fallback authentication'.)
#
#   webclient: A web client. Requires web_client_location to be set.
#
180
listeners:
181
182
183
184
185
186
  # 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.)
  #
187
188
189
190
191
  #- port: 8448
  #  type: http
  #  tls: true
  #  resources:
  #    - names: [client, federation]
192
193
194
195
196

  # 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
197
  # https://github.com/matrix-org/synapse/blob/master/docs/reverse_proxy.md.
198
  #
199
200
201
202
  - port: 8008
    tls: false
    type: http
    x_forwarded: true
203
    bind_addresses: ['::1', '127.0.0.1']
204
205

    resources:
206
      - names: [client, federation]
207
208
        compress: false

209
    # example additional_resources:
210
    #
211
212
213
214
    #additional_resources:
    #  "/_matrix/my/custom/endpoint":
    #    module: my_module.CustomRequestHandler
    #    config: {}
215

216
217
  # Turn on the twisted ssh manhole service on localhost on the given
  # port.
218
219
220
221
222
223
224
  #
  #- port: 9000
  #  bind_addresses: ['::1', '127.0.0.1']
  #  type: manhole


## Homeserver blocking ##
225

226
227
# How to reach the server admin, used in ResourceLimitError
#
228
229
230
#admin_contact: 'mailto:admin@server.com'

# Global blocking
231
#
232
#hs_disabled: false
233
234
#hs_disabled_message: 'Human readable reason for why the HS is blocked'

235
236
# Monthly Active User Blocking
#
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# 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.
#
253
254
255
256
257
258
259
# '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
260
261
#max_mau_value: 50
#mau_trial_days: 2
262
#mau_limit_alerting: false
263

264
265
266
267
# 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.
#
268
#mau_stats_only: false
269

270
271
272
# Sometimes the server admin will want to ensure certain accounts are
# never blocked by mau checking. These accounts are specified here.
#
273
274
275
#mau_limit_reserved_threepids:
#  - medium: 'email'
#    address: 'reserved_user@example.com'
276

277
278
279
# Used by phonehome stats to group together related servers.
#server_context: context

280
# Resource-constrained homeserver Settings
281
282
283
284
285
286
287
288
289
290
291
292
#
# 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:
293
#  enabled: true
294
295
296
#  complexity: 1.0
#  complexity_error: "This room is too complex."

297
298
299
300
301
# Whether to require a user to be in the room to add an alias to it.
# Defaults to 'true'.
#
#require_membership_for_aliases: false

302
303
304
305
306
307
# 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

308
309
310
311
312
313
314
315
316
317
318
319
320
# 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

321

322
323
324
325
326
327
328
329
330
## 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.
#
331
332
333
334
335
# 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`).
#
336
#tls_certificate_path: "CONFDIR/SERVERNAME.tls.crt"
337
338

# PEM-encoded private key for TLS
339
#
340
#tls_private_key_path: "CONFDIR/SERVERNAME.tls.key"
341

342
# Whether to verify TLS server certificates for outbound federation requests.
343
#
344
345
# Defaults to `true`. To disable certificate verification, uncomment the
# following line.
346
#
347
#federation_verify_certificates: false
348

349
350
351
352
353
354
355
356
357
# 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.
#
#federation_client_minimum_tls_version: 1.2

358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# Skip federation certificate verification on the following whitelist
# of domains.
#
# This setting should only be used in very specific cases, such as
# federation over Tor hidden services and similar. For private networks
# of homeservers, you likely want to use a private CA instead.
#
# Only effective if federation_verify_certicates is `true`.
#
#federation_certificate_verification_whitelist:
#  - lon.example.com
#  - *.domain.com
#  - *.onion

# List of custom certificate authorities for federation traffic.
#
# This setting should only normally be used within a private network of
# homeservers.
#
# Note that this list will replace those that are provided by your
# operating environment. Certificates must be in PEM format.
#
#federation_custom_ca_list:
#  - myCA1.pem
#  - myCA2.pem
#  - myCA3.pem

385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
# ACME support: This will configure Synapse to request a valid TLS certificate
# for your configured `server_name` via Let's Encrypt.
#
# Note that provisioning a certificate in this way requires port 80 to be
# routed to Synapse so that it can complete the http-01 ACME challenge.
# By default, if you enable ACME support, Synapse will attempt to listen on
# port 80 for incoming http-01 challenges - however, this will likely fail
# with 'Permission denied' or a similar error.
#
# There are a couple of potential solutions to this:
#
#  * If you already have an Apache, Nginx, or similar listening on port 80,
#    you can configure Synapse to use an alternate port, and have your web
#    server forward the requests. For example, assuming you set 'port: 8009'
#    below, on Apache, you would write:
#
#    ProxyPass /.well-known/acme-challenge http://localhost:8009/.well-known/acme-challenge
#
#  * Alternatively, you can use something like `authbind` to give Synapse
#    permission to listen on port 80.
#
acme:
407
408
    # ACME support is disabled by default. Set this to `true` and uncomment
    # tls_certificate_path and tls_private_key_path above to enable it.
409
    #
410
    enabled: false
411
412
413
414
415

    # Endpoint to use to request certificates. If you only want to test,
    # use Let's Encrypt's staging url:
    #     https://acme-staging.api.letsencrypt.org/directory
    #
416
    #url: https://acme-v01.api.letsencrypt.org/directory
417
418
419
420

    # Port number to listen on for the HTTP-01 challenge. Change this if
    # you are forwarding connections through Apache/Nginx/etc.
    #
421
    port: 80
422
423
424
425
426

    # Local addresses to listen on for incoming connections.
    # Again, you may want to change this if you are forwarding connections
    # through Apache/Nginx/etc.
    #
427
    bind_addresses: ['::', '0.0.0.0']
428
429
430

    # How many days remaining on a certificate before it is renewed.
    #
431
    reprovision_threshold: 30
432
433
434
435
436
437
438
439
440
441
442
443
444

    # 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'.
    #
445
    domain: {{ matrix_domain }}
446
447
448
449
450
451
452

    # file to use for the account key. This will be generated if it doesn't
    # exist.
    #
    # If unspecified, we will use CONFDIR/client.key.
    #
    account_key_file: DATADIR/acme_account.key
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478

# List of allowed TLS fingerprints for this server to publish along
# with the signing keys for this server. Other matrix servers that
# make HTTPS requests to this server will check that the TLS
# certificates returned by this server match one of the fingerprints.
#
# Synapse automatically adds the fingerprint of its own certificate
# to the list. So if federation traffic is handled directly by synapse
# then no modification to the list is required.
#
# If synapse is run behind a load balancer that handles the TLS then it
# will be necessary to add the fingerprints of the certificates used by
# the loadbalancers to this list if they are different to the one
# synapse is using.
#
# Homeservers are permitted to cache the list of TLS fingerprints
# returned in the key responses up to the "valid_until_ts" returned in
# key. It may be necessary to publish the fingerprints of a new
# certificate and wait until the "valid_until_ts" of the previous key
# responses have passed before deploying it.
#
# You can calculate a fingerprint from a given TLS listener via:
# openssl s_client -connect $host:$port < /dev/null 2> /dev/null |
#   openssl x509 -outform DER | openssl sha256 -binary | base64 | tr -d '='
# or by checking matrix.org/federationtester/api/report?server_name=$host
#
479
#tls_fingerprints: [{"sha256": "<base64_encoded_sha256_fingerprint>"}]
480
481
482



483
484
## Database ##

485
486
database:
  # The database engine name
487
  name: "psycopg2"
488
489
490
491
  # Arguments to pass to the engine
  args:
    dbname: synapse
    user: synapse
492
    password: {{ vault_postgres_users.synapse }}
493
494
495
496
    cp_min: 5
    cp_max: 10

# Number of events to cache in memory.
497
498
#
#event_cache_size: 10K
499
500


501
## Logging ##
502

503
504
# A yaml python logging config file as described by
# https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
505
#
506
log_config: "/etc/synapse/log_config.yaml"
507
508
509
510


## Ratelimiting ##

511
# Ratelimiting settings for client actions (registration, login, messaging).
512
513
514
515
516
517
#
# Each ratelimiting configuration is made of two parameters:
#   - per_second: number of requests a client can send per second.
#   - burst_count: number of requests a client can send before being throttled.
#
# Synapse currently uses the following configurations:
518
519
#   - one for messages that ratelimits sending based on the account the client
#     is using
520
521
522
523
524
525
526
527
528
#   - one for registration that ratelimits registration requests based on the
#     client's IP address.
#   - one for login that ratelimits login requests based on the client's IP
#     address.
#   - one for login that ratelimits login requests based on the account the
#     client is attempting to log into.
#   - one for login that ratelimits login requests based on the account the
#     client is attempting to log into, based on the amount of failed login
#     attempts for this account.
529
530
531
#   - one for ratelimiting redactions by room admins. If this is not explicitly
#     set then it uses the same ratelimiting as per rc_message. This is useful
#     to allow room admins to deal with abuse quickly.
532
533
534
#
# The defaults are as shown below.
#
535
536
537
538
#rc_message:
#  per_second: 0.2
#  burst_count: 10
#
539
540
541
542
543
544
545
546
547
548
549
550
551
552
#rc_registration:
#  per_second: 0.17
#  burst_count: 3
#
#rc_login:
#  address:
#    per_second: 0.17
#    burst_count: 3
#  account:
#    per_second: 0.17
#    burst_count: 3
#  failed_attempts:
#    per_second: 0.17
#    burst_count: 3
553
554
555
556
#
#rc_admin_redaction:
#  per_second: 1
#  burst_count: 50
557
558


559
# Ratelimiting settings for incoming federation
560
#
561
562
563
564
565
566
567
568
569
570
# The rc_federation configuration is made up of the following settings:
#   - window_size: window size in milliseconds
#   - sleep_limit: number of federation requests from a single server in
#     a window before the server will delay processing the request.
#   - sleep_delay: duration in milliseconds to delay processing events
#     from remote servers by if they go over the sleep limit.
#   - reject_limit: maximum number of concurrent federation requests
#     allowed from a single server
#   - concurrent: number of federation requests to concurrently process
#     from a single server
571
#
572
# The defaults are as shown below.
573
#
574
575
576
577
578
579
#rc_federation:
#  window_size: 1000
#  sleep_limit: 10
#  sleep_delay: 500
#  reject_limit: 50
#  concurrent: 3
580
581
582
583
584
585
586
587

# Target outgoing federation transaction frequency for sending read-receipts,
# per-room.
#
# If we end up trying to send out more read-receipts, they will get buffered up
# into fewer transactions.
#
#federation_rr_transactions_per_room_per_second: 50
588
589
590



591
592
593
594
595
596
597
## Media Store ##

# Enable the media store service in the Synapse master. Uncomment the
# following if you are using a separate media store worker.
#
#enable_media_repo: false

598
# Directory where uploaded images and attachments are stored.
599
#
600
601
602
603
media_store_path: "/var/lib/synapse/media_store"

# Media storage providers allow media to be stored in different
# locations.
604
605
606
607
608
609
610
611
612
613
614
615
#
#media_storage_providers:
#  - module: file_system
#    # Whether to write new local files.
#    store_local: false
#    # Whether to write new remote media
#    store_remote: false
#    # Whether to block upload requests waiting for write to this
#    # provider to complete
#    store_synchronous: false
#    config:
#       directory: /mnt/some/other/directory
616
617

# Directory where in-progress uploads are stored.
618
#
619
uploads_path: "/var/lib/synapse/uploads"
620
621

# The largest allowed upload size in bytes
622
623
#
#max_upload_size: 10M
624
625

# Maximum number of pixels that will be thumbnailed
626
627
#
#max_image_pixels: 32M
628
629
630
631
632
633

# Whether to generate new thumbnails on the fly to precisely match
# the resolution requested by the client. If true then whenever
# a new resolution is requested by the client the server will
# generate a new thumbnail. If false the server will pick a thumbnail
# from a precalculated list.
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
#
#dynamic_thumbnails: false

# List of thumbnails to precalculate when an image is uploaded.
#
#thumbnail_sizes:
#  - width: 32
#    height: 32
#    method: crop
#  - width: 96
#    height: 96
#    method: crop
#  - width: 320
#    height: 240
#    method: scale
#  - width: 640
#    height: 480
#    method: scale
#  - width: 800
#    height: 600
#    method: scale

# Is the preview URL API enabled?
#
# 'false' by default: uncomment the following to enable it (and specify a
# url_preview_ip_range_blacklist blacklist).
#
url_preview_enabled: true
662
663
664
665
666
667
668
669
670

# List of IP address CIDR ranges that the URL preview spider is denied
# from accessing.  There are no defaults: you must explicitly
# specify a list for URL previewing to work.  You should specify any
# internal services in your network that you do not want synapse to try
# to connect to, otherwise anyone in any Matrix room could cause your
# synapse to issue arbitrary GET requests to your internal services,
# causing serious security issues.
#
671
672
673
# (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly
# listed here, since they correspond to unroutable addresses.)
#
674
# This must be specified if url_preview_enabled is set. It is recommended that
675
# you uncomment the following list as a starting point.
676
#
677
678
679
680
681
682
683
684
685
686
687
url_preview_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'

688
689
690
691
692
693
# List of IP address CIDR ranges that the URL preview spider is allowed
# to access even if they are specified in url_preview_ip_range_blacklist.
# This is useful for specifying exceptions to wide-ranging blacklisted
# target IP ranges - e.g. for enabling URL previews for a specific private
# website only visible in your network.
#
694
695
#url_preview_ip_range_whitelist:
#   - '192.168.1.1'
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712

# Optional list of URL matches that the URL preview spider is
# denied from accessing.  You should use url_preview_ip_range_blacklist
# in preference to this, otherwise someone could define a public DNS
# entry that points to a private IP address and circumvent the blacklist.
# This is more useful if you know there is an entire shape of URL that
# you know that will never want synapse to try to spider.
#
# Each list entry is a dictionary of url component attributes as returned
# by urlparse.urlsplit as applied to the absolute form of the URL.  See
# https://docs.python.org/2/library/urlparse.html#urlparse.urlsplit
# The values of the dictionary are treated as an filename match pattern
# applied to that component of URLs, unless they start with a ^ in which
# case they are treated as a regular expression match.  If all the
# specified component matches for a given list item succeed, the URL is
# blacklisted.
#
713
714
715
#url_preview_url_blacklist:
#  # blacklist any URL with a username in its URI
#  - username: '*'
716
#
717
718
719
#  # blacklist all *.google.com URLs
#  - netloc: 'google.com'
#  - netloc: '*.google.com'
720
#
721
722
#  # blacklist all plain HTTP URLs
#  - scheme: 'http'
723
#
724
725
726
#  # blacklist http(s)://www.acme.com/foo
#  - netloc: 'www.acme.com'
#    path: '/foo'
727
#
728
729
#  # blacklist any URL with a literal IPv4 address
#  - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
730
731

# The largest allowed URL preview spidering size in bytes
732
733
#
#max_spider_size: 10M
734
735
736
737
738


## Captcha ##
# See docs/CAPTCHA_SETUP for full details of configuring this.

739
# This homeserver's ReCAPTCHA public key.
740
741
#
#recaptcha_public_key: "YOUR_PUBLIC_KEY"
742

743
# This homeserver's ReCAPTCHA private key.
744
745
#
#recaptcha_private_key: "YOUR_PRIVATE_KEY"
746
747
748
749

# Enables ReCaptcha checks when registering, preventing signup
# unless a captcha is answered. Requires a valid ReCaptcha
# public/private key.
750
751
#
#enable_registration_captcha: false
752
753

# A secret key used to bypass the captcha test entirely.
754
#
755
756
757
#captcha_bypass_secret: "YOUR_SECRET_HERE"

# The API endpoint to use for verifying m.login.recaptcha responses.
758
759
#
#recaptcha_siteverify_api: "https://www.recaptcha.net/recaptcha/api/siteverify"
760
761


762
## TURN ##
763
764

# The public URIs of the TURN server to give to clients
765
#
766
#turn_uris: []
767
768

# The shared secret used to compute passwords for the TURN server
769
#
770
#turn_shared_secret: "YOUR_SHARED_SECRET"
771
772
773

# The Username and password if the TURN server needs them and
# does not use a token
774
#
775
776
777
778
#turn_username: "TURNSERVER_USERNAME"
#turn_password: "TURNSERVER_PASSWORD"

# How long generated TURN credentials last
779
780
#
#turn_user_lifetime: 1h
781

782
783
784
785
786
# Whether guests should be allowed to use the TURN server.
# This defaults to True, otherwise VoIP will be unreliable for guests.
# However, it does introduce a slight security risk as it allows users to
# connect to arbitrary endpoints without having first signed up for a
# valid account (e.g. by passing a CAPTCHA).
787
#
788
#turn_allow_guests: true
789

790
791

## Registration ##
792
793
794
#
# Registration can be rate-limited using the parameters in the "Ratelimiting"
# section of this file.
795
796

# Enable registration for new users.
797
798
#
#enable_registration: false
799

800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
# Optional account validity configuration. This allows for accounts to be denied
# any request after a given period.
#
# ``enabled`` defines whether the account validity feature is enabled. Defaults
# to False.
#
# ``period`` allows setting the period after which an account is valid
# after its registration. When renewing the account, its validity period
# will be extended by this amount of time. This parameter is required when using
# the account validity feature.
#
# ``renew_at`` is the amount of time before an account's expiry date at which
# Synapse will send an email to the account's email address with a renewal link.
# This needs the ``email`` and ``public_baseurl`` configuration sections to be
# filled.
#
# ``renew_email_subject`` is the subject of the email sent out with the renewal
# link. ``%(app)s`` can be used as a placeholder for the ``app_name`` parameter
# from the ``email`` section.
#
820
821
822
823
824
825
# Once this feature is enabled, Synapse will look for registered users without an
# expiration date at startup and will add one to every account it found using the
# current settings at that time.
# This means that, if a validity period is set, and Synapse is restarted (it will
# then derive an expiration date from the current validity period), and some time
# after that the validity period changes and Synapse is restarted, the users'
826
827
828
# expiration dates won't be updated unless their account is manually renewed. This
# date will be randomly selected within a range [now + period - d ; now + period],
# where d is equal to 10% of the validity period.
829
#
830
#account_validity:
831
#  enabled: true
832
833
834
#  period: 6w
#  renew_at: 1w
#  renew_email_subject: "Renew your %(app)s account"
835
836
837
838
839
840
841
842
843
844
#  # Directory in which Synapse will try to find the HTML files to serve to the
#  # user when trying to renew an account. Optional, defaults to
#  # synapse/res/templates.
#  template_dir: "res/templates"
#  # HTML to be displayed to the user after they successfully renewed their
#  # account. Optional.
#  account_renewed_html_path: "account_renewed.html"
#  # HTML to be displayed when the user tries to renew an account with an invalid
#  # renewal token. Optional.
#  invalid_token_html_path: "invalid_token.html"
845

846
847
848
849
850
851
852
853
854
855
856
# Time that a user's session remains valid for, after they log in.
#
# Note that this is not currently compatible with guest logins.
#
# Note also that this is calculated at login time: changes are not applied
# retrospectively to users who have already logged in.
#
# By default, this is infinite.
#
#session_lifetime: 24h

857
858
# The user must provide all of the below types of 3PID when registering.
#
859
860
861
#registrations_require_3pid:
#  - email
#  - msisdn
862

863
864
865
# Explicitly disable asking for MSISDNs from the registration
# flow (overrides registrations_require_3pid if MSISDNs are set as required)
#
866
#disable_msisdn_registration: true
867

868
869
870
# Mandate that users are only allowed to associate certain formats of
# 3PIDs with accounts on this server.
#
871
872
873
874
875
876
877
#allowed_local_3pids:
#  - medium: email
#    pattern: '.*@matrix\.org'
#  - medium: email
#    pattern: '.*@vector\.im'
#  - medium: msisdn
#    pattern: '\+44'
878

879
880
881
882
# Enable 3PIDs lookup requests to identity servers from this server.
#
#enable_3pid_lookup: true

883
884
885
# If set, allows registration of standard or admin accounts by anyone who
# has the shared secret, even if registration is otherwise disabled.
#
886
registration_shared_secret: "{{ vault_matrix_secrets[matrix_server_name].registration_shared_secret }}"
887
888
889

# Set the number of bcrypt rounds used to generate password hash.
# Larger numbers increase the work factor needed to generate the hash.
890
891
892
# The default number is 12 (which equates to 2^12 rounds).
# N.B. that increasing this will exponentially increase the time required
# to register or login - e.g. 24 => 2^24 rounds which will take >20 mins.
893
894
#
#bcrypt_rounds: 12
895
896
897
898

# Allows users to register as guests without a password/email/etc, and
# participate in rooms hosted on this server which have been made
# accessible to anonymous users.
899
900
#
#allow_guest_access: false
901

902
903
904
905
906
907
908
909
# The identity server which we suggest that clients should use when users log
# in on this server.
#
# (By default, no suggestion is made, so it is left up to the client.
# This setting is ignored unless public_baseurl is also set.)
#
default_identity_server: https://matrix.org

910
911
# The list of identity servers trusted to verify third party
# identifiers by this server.
912
913
914
#
# Also defines the ID server which will be called when an account is
# deactivated (one will be picked arbitrarily).
915
#
916
917
918
919
920
921
922
923
# Note: This option is deprecated. Since v0.99.4, Synapse has tracked which identity
# server a 3PID has been bound to. For 3PIDs bound before then, Synapse runs a
# background migration script, informing itself that the identity server all of its
# 3PIDs have been bound to is likely one of the below.
#
# As of Synapse v1.4.0, all other functionality of this option has been deprecated, and
# it is now solely used for the purposes of the background migration script, and can be
# removed once it has run.
924
925
926
#trusted_third_party_id_servers:
#  - matrix.org
#  - vector.im
927

928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
# Handle threepid (email/phone etc) registration and password resets through a set of
# *trusted* identity servers. Note that this allows the configured identity server to
# reset passwords for accounts!
#
# Be aware that if `email` is not set, and SMTP options have not been
# configured in the email config block, registration and user password resets via
# email will be globally disabled.
#
# Additionally, if `msisdn` is not set, registration and password resets via msisdn
# will be disabled regardless. This is due to Synapse currently not supporting any
# method of sending SMS messages on its own.
#
# To enable using an identity server for operations regarding a particular third-party
# identifier type, set the value to the URL of that identity server as shown in the
# examples below.
#
# Servers handling the these requests must answer the `/requestToken` endpoints defined
# by the Matrix Identity Service API specification:
# https://matrix.org/docs/spec/identity_service/latest
#
# If a delegate is specified, the config option public_baseurl must also be filled out.
#
account_threepid_delegates:
951
    #email: https://example.com     # Delegate email sending to example.com
952
953
    #msisdn: http://localhost:8090  # Delegate SMS sending to this local process

954
955
# Users who register on this homeserver will automatically be joined
# to these rooms
956
#
957
#auto_join_rooms:
958
#  - "#example:example.com"
959
960
961
962
963
964

# Where auto_join_rooms are specified, setting this flag ensures that the
# the rooms exist by creating them when the first user on the
# homeserver registers.
# Setting to false means that if the rooms are not manually created,
# users cannot be auto-joined since they do not exist.
965
966
#
#autocreate_auto_join_rooms: true
967
968
969
970
971


## Metrics ###

# Enable collection and rendering of performance metrics
972
#
973
#enable_metrics: false
974
975
976
977
978
979
980
981
982
983
984

# Enable sentry integration
# NOTE: While attempts are made to ensure that the logs don't contain
# any sensitive information, this cannot be guaranteed. By enabling
# this option the sentry server may therefore receive sensitive
# information, and it in turn may then diseminate sensitive information
# through insecure notification channels if so configured.
#
#sentry:
#    dsn: "..."

985
986
987
988
989
990
991
992
993
994
# Flags to enable Prometheus metrics which are not suitable to be
# enabled by default, either for performance reasons or limited use.
#
metrics_flags:
    # Publish synapse_federation_known_servers, a g auge of the number of
    # servers this homeserver knows about, including itself. May cause
    # performance problems on large homeservers.
    #
    #known_servers: true

995
# Whether or not to report anonymized homeserver usage statistics.
996
report_stats: true
997

998
999
1000
1001
1002
# The endpoint to report the anonymized homeserver usage statistics to.
# Defaults to https://matrix.org/report-usage-stats/push
#
#report_stats_endpoint: https://example.com/report-usage-stats/push

1003
1004
1005
1006

## API Configuration ##

# A list of event types that will be included in the room_invite_state
1007
1008
1009
1010
1011
1012
1013
#
#room_invite_state_types:
#  - "m.room.join_rules"
#  - "m.room.canonical_alias"
#  - "m.room.avatar"
#  - "m.room.encryption"
#  - "m.room.name"
1014
1015


1016
1017
1018
# A list of application service config files to use
#
app_service_config_files:
1019
  - /etc/synapse/appservice-registration-irc.yaml
1020

1021
# Uncomment to enable tracking of application service IP addresses. Implicitly
1022
# enables MAU tracking for application service users.
1023
#
1024
#track_appservice_user_ips: true
1025

1026

1027
1028
1029
# a secret which is used to sign access tokens. If none is specified,
# the registration_shared_secret is used, if one is given; otherwise,
# a secret key is derived from the signing key.
1030
#
1031
macaroon_secret_key: "{{ vault_matrix_secrets[matrix_server_name].macaroon_secret_key }}"
1032

1033
# a secret which is used to calculate HMACs for form values, to stop
1034
1035
# falsification of values. Must be specified for the User Consent
# forms to work.
1036
#
1037
1038
form_secret: "{{ vault_matrix_secrets[matrix_server_name].form_secret }}"

1039
1040
1041
## Signing Keys ##

# Path to the signing key to sign messages with
1042
#
1043
signing_key_path: "/etc/synapse/{{ matrix_server_name }}.signing.key"
1044
1045
1046

# The keys that the server used to sign messages with but won't use
# to sign new messages. E.g. it has lost its private key
1047
1048
#
#old_signing_keys:
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
#  "ed25519:auto":
#    # Base64 encoded public key
#    key: "The public part of your old signing key."
#    # Millisecond POSIX timestamp when the key expired.
#    expired_ts: 123456789123

# How long key response published by this server is valid for.
# Used to set the valid_until_ts in /key/v2 APIs.
# Determines how quickly servers will query to check which keys
# are still valid.
1059
1060
#
#key_refresh_interval: 1d
1061
1062

# The trusted servers to download signing keys from.
1063
#
1064
1065
1066
1067
1068
1069
1070
1071
1072
# When we need to fetch a signing key, each server is tried in parallel.
#
# Normally, the connection to the key server is validated via TLS certificates.
# Additional security can be provided by configuring a `verify key`, which
# will make synapse check that the response is signed by that key.
#
# This setting supercedes an older setting named `perspectives`. The old format
# is still supported for backwards-compatibility, but it is deprecated.
#
1073
1074
1075
1076
# 'trusted_key_servers' defaults to matrix.org, but using it will generate a
# warning on start-up. To suppress this warning, set
# 'suppress_key_server_warning' to true.
#
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
# Options for each entry in the list include:
#
#    server_name: the name of the server. required.
#
#    verify_keys: an optional map from key id to base64-encoded public key.
#       If specified, we will check that the response is signed by at least
#       one of the given keys.
#
#    accept_keys_insecurely: a boolean. Normally, if `verify_keys` is unset,
#       and federation_verify_certificates is not `true`, synapse will refuse
#       to start, because this would allow anyone who can spoof DNS responses
#       to masquerade as the trusted key server. If you know what you are doing
#       and are sure that your network environment provides a secure connection
#       to the key server, you can set this to `true` to override this
#       behaviour.
#
# An example configuration might look like:
#
#trusted_key_servers:
#  - server_name: "my_trusted_server.example.com"
#    verify_keys:
#      "ed25519:auto": "abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr"
#  - server_name: "my_other_trusted_server.example.com"
#
1101
1102
1103
1104
1105
trusted_key_servers:
  - server_name: "matrix.org"

# Uncomment the following to disable the warning that is emitted when the
# trusted_key_servers include 'matrix.org'. See above.
1106
#
1107
1108
1109
1110
1111
1112
1113
1114
suppress_key_server_warning: true

# The signing keys to use when acting as a trusted key server. If not specified
# defaults to the server signing key.
#
# Can contain multiple keys, one per line.
#
#key_server_signing_keys_path: "key_server_signing_keys.key"
1115
1116


1117
1118
# Enable SAML2 for registration and login. Uses pysaml2.
#
1119
1120
# At least one of `sp_config` or `config_path` must be set in this section to
# enable SAML login.
1121
#
1122
1123
1124
1125
# (You will probably also want to set the following options to `false` to
# disable the regular login/registration flows:
#   * enable_registration
#   * password_config.enabled
1126
#
1127
1128
1129
1130
1131
1132
# Once SAML support is enabled, a metadata file will be exposed at
# https://<server>:<port>/_matrix/saml2/metadata.xml, which you may be able to
# use to configure your SAML IdP with. Alternatively, you can manually configure
# the IdP to use an ACS location of
# https://<server>:<port>/_matrix/saml2/authn_response.
#
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
saml2_config:
  # `sp_config` is the configuration for the pysaml2 Service Provider.
  # See pysaml2 docs for format of config.
  #
  # Default values will be used for the 'entityid' and 'service' settings,
  # so it is not normally necessary to specify them unless you need to
  # override them.
  #
  #sp_config:
  #  # point this to the IdP's metadata. You can use either a local file or
  #  # (preferably) a URL.
  #  metadata:
  #    #local: ["saml2/idp.xml"]
  #    remote:
  #      - url: https://our_idp/metadata.xml
  #
  #    # By default, the user has to go to our login page first. If you'd like
1150
  #    # to allow IdP-initiated login, set 'allow_unsolicited: true' in a
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
  #    # 'service.sp' section:
  #    #
  #    #service:
  #    #  sp:
  #    #    allow_unsolicited: true
  #
  #    # The examples below are just used to generate our metadata xml, and you
  #    # may well not need them, depending on your setup. Alternatively you
  #    # may need a whole lot more detail - see the pysaml2 docs!
  #
  #    description: ["My awesome SP", "en"]
  #    name: ["Test SP", "en"]
  #
  #    organization:
  #      name: Example com
  #      display_name:
  #        - ["Example co", "en"]
  #      url: "http://example.com"
  #
  #    contact_person:
  #      - given_name: Bob
  #        sur_name: "the Sysadmin"
  #        email_address": ["admin@example.com"]
  #        contact_type": technical

  # Instead of putting the config inline as above, you can specify a
  # separate pysaml2 configuration file:
  #
  #config_path: "CONFDIR/sp_conf.py"

  # the lifetime of a SAML session. This defines how long a user has to
  # complete the authentication process, if allow_unsolicited is unset.
  # The default is 5 minutes.
  #
  #saml_session_lifetime: 5m

  # The SAML attribute (after mapping via the attribute maps) to use to derive
  # the Matrix ID from. 'uid' by default.
  #
  #mxid_source_attribute: displayName

  # The mapping system to use for mapping the saml attribute onto a matrix ID.
  # Options include:
  #  * 'hexencode' (which maps unpermitted characters to '=xx')
  #  * 'dotreplace' (which replaces unpermitted characters with '.').
  # The default is 'hexencode'.
  #
  #mxid_mapping: dotreplace

  # In previous versions of synapse, the mapping from SAML attribute to MXID was
  # always calculated dynamically rather than stored in a table. For backwards-
  # compatibility, we will look for user_ids matching such a pattern before
  # creating a new account.
  #
  # This setting controls the SAML attribute which will be used for this
  # backwards-compatibility lookup. Typically it should be 'uid', but if the
  # attribute maps are changed, it may be necessary to change it.
  #
  # The default is 'uid'.
  #
  #grandfathered_mxid_source_attribute: upn
1212
1213
1214
1215



# Enable CAS for registration and login.
1216
#
1217
1218
1219
#cas_config:
#   enabled: true
#   server_url: "https://cas-server.com"
1220
#   service_url: "https://homeserver.domain.com:8448"
1221
#   #displayname_attribute: name
1222
1223
1224
1225
1226
1227
#   #required_attributes:
#   #    name: value


# The JWT needs to contain a globally unique "sub" (subject) claim.
#
1228
1229
1230
1231
#jwt_config:
#   enabled: true
#   secret: "a secret"
#   algorithm: "HS256"
1232
1233
1234


password_config:
1235
1236
1237
1238
   # Uncomment to disable password login
   #
   #enabled: false

1239
1240
1241
1242
1243
1244
   # Uncomment to disable authentication against the local password
   # database. This is ignored if `enabled` is false, and is only useful
   # if you have other password_providers.
   #
   #localdb_enabled: false

1245
1246
   # Uncomment and change to a secret random string for extra security.
   # DO NOT CHANGE THIS AFTER INITIAL SETUP!
1247
   #
1248
   pepper: "{{ vault_matrix_secrets[matrix_server_name].pepper }}"
1249
1250
1251



1252
1253
# Enable sending emails for password resets, notification events or
# account expiry notices
1254
1255
1256
1257
#
# If your SMTP server requires authentication, the optional smtp_user &
# smtp_pass variables should be used
#
1258
1259
1260
#email:
#   enable_notifs: false
#   smtp_host: "localhost"
1261
#   smtp_port: 25 # SSL: 465, STARTTLS: 587
1262
1263
#   smtp_user: "exampleusername"
#   smtp_pass: "examplepassword"
1264
#   require_transport_security: false
1265
#   notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
1266
#   app_name: Matrix
1267
1268
#
#   # Enable email notifications by default
1269
#   #
1270
#   notif_for_new_users: true
1271
1272
1273
1274
#
#   # Defining a custom URL for Riot is only needed if email notifications
#   # should contain links to a self-hosted installation of Riot; when set
#   # the "app_name" setting is ignored
1275
#   #
1276
1277
1278
1279
1280
1281
#   riot_base_url: "http://localhost/riot"
#
#   # Configure the time that a validation email or text message code
#   # will expire after sending
#   #
#   # This is currently used for password resets
1282
#   #
1283
1284
1285
#   #validation_token_lifetime: 1h
#
#   # Template directory. All template files should be stored within this
1286
1287
1288
1289
1290
#   # directory. If not set, default templates from within the Synapse
#   # package will be used
#   #
#   # For the list of default templates, please see
#   # https://github.com/matrix-org/synapse/tree/master/synapse/res/templates
1291
#   #
1292
#   #template_dir: res/templates
1293
1294
1295
#
#   # Templates for email notifications
#   #
1296
1297
#   notif_template_html: notif_mail.html
#   notif_template_text: notif_mail.txt
1298
1299
1300
#
#   # Templates for account expiry notices
#   #
1301
1302
#   expiry_template_html: notice_expiry.html
#   expiry_template_text: notice_expiry.txt
1303
1304
1305
1306
1307
1308
#
#   # Templates for password reset emails sent by the homeserver
#   #
#   #password_reset_template_html: password_reset.html
#   #password_reset_template_text: password_reset.txt
#
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
#   # Templates for registration emails sent by the homeserver
#   #
#   #registration_template_html: registration.html
#   #registration_template_text: registration.txt
#
#   # Templates for validation emails sent by the homeserver when adding an email to
#   # your user account
#   #
#   #add_threepid_template_html: add_threepid.html
#   #add_threepid_template_text: add_threepid.txt
#
1320
1321
1322
1323
1324
#   # Templates for password reset success and failure pages that a user
#   # will see after attempting to reset their password
#   #
#   #password_reset_template_success_html: password_reset_success.html
#   #password_reset_template_failure_html: password_reset_failure.html
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
#
#   # Templates for registration success and failure pages that a user
#   # will see after attempting to register using an email or phone
#   #
#   #registration_template_success_html: registration_success.html
#   #registration_template_failure_html: registration_failure.html
#
#   # Templates for success and failure pages that a user will see after attempting
#   # to add an email or phone to their account
#   #
#   #add_threepid_success_html: add_threepid_success.html
#   #add_threepid_failure_html: add_threepid_failure.html
1337
1338


1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
#password_providers:
#    - module: "ldap_auth_provider.LdapAuthProvider"
#      config:
#        enabled: true
#        uri: "ldap://ldap.example.com:389"
#        start_tls: true
#        base: "ou=users,dc=example,dc=com"
#        attributes:
#           uid: "cn"
#           mail: "email"
#           name: "givenName"
#        #bind_dn:
#        #bind_password:
#        #filter: "(objectClass=posixAccount)"
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362



# Clients requesting push notifications can either have the body of
# the message sent in the notification poke along with other details
# like the sender, or just the event ID and room ID (`event_id_only`).
# If clients choose the former, this option controls whether the
# notification request includes the content of the event (other details
# like the sender are still included). For `event_id_only` push, it
# has no effect.
1363
#
1364
1365
1366
1367
1368
# For modern android devices the notification content will still appear
# because it is loaded by the app. iPhone, however will send a
# notification saying only that a message arrived and who it came from.
#
#push:
1369
#  include_content: true
1370
1371


1372
1373
1374
1375
#spam_checker:
#  module: "my_custom_project.SuperSpamChecker"
#  config:
#    example_option: 'things'
1376
1377


1378
1379
1380
# Uncomment to allow non-server-admin users to create groups on this server
#
#enable_group_creation: true
1381
1382
1383

# If enabled, non server admins can only create groups with local parts
# starting with this prefix
1384
1385
#
#group_creation_prefix: "unofficial/"
1386
1387
1388
1389
1390



# User Directory configuration
#
1391
1392
1393
1394
# 'enabled' defines whether users can search the user directory. If
# false then empty responses are returned to all queries. Defaults to
# true.
#
1395
1396
# 'search_all_users' defines whether to search all users visible to your HS
# when searching the user directory, rather than limiting to users visible
1397
1398
1399
# in public rooms.  Defaults to false.  If you set it True, you'll have to
# rebuild the user_directory search indexes, see
# https://github.com/matrix-org/synapse/blob/master/docs/user_directory.md
1400
1401
#
#user_directory:
1402
1403
#  enabled: true
#  search_all_users: false
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439


# User Consent configuration
#
# for detailed instructions, see
# https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md
#
# Parts of this section are required if enabling the 'consent' resource under
# 'listeners', in particular 'template_dir' and 'version'.
#
# 'template_dir' gives the location of the templates for the HTML forms.
# This directory should contain one subdirectory per language (eg, 'en', 'fr'),
# and each language directory should contain the policy document (named as
# '<version>.html') and a success page (success.html).
#
# 'version' specifies the 'current' version of the policy document. It defines
# the version to be served by the consent resource if there is no 'v'
# parameter.
#
# 'server_notice_content', if enabled, will send a user a "Server Notice"
# asking them to consent to the privacy policy. The 'server_notices' section
# must also be configured for this to work. Notices will *not* be sent to
# guest users unless 'send_server_notice_to_guests' is set to true.
#
# 'block_events_error', if set, will block any attempts to send events
# until the user consents to the privacy policy. The value of the setting is
# used as the text of the error.
#
# 'require_at_registration', if enabled, will add a step to the registration
# process, similar to how captcha works. Users will be required to accept the
# policy before their account is created.
#
# 'policy_name' is the display name of the policy users will see when registering
# for an account. Has no effect unless `require_at_registration` is enabled.
# Defaults to "Privacy Policy".
#