homeserver.yaml.j2 47.5 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
65
66
# 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: "4"

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
80
81
82
83
84
85
86
#
#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
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# 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.
#
# (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'

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

  # 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.rst.
  #
196
197
  - port: 8008
    tls: false
198
    bind_addresses: ['::1', '127.0.0.1']
199
200
201
202
    type: http
    x_forwarded: true

    resources:
203
      - names: [client, federation]
204
205
        compress: false

206
    # example additional_resources:
207
    #
208
209
210
211
    #additional_resources:
    #  "/_matrix/my/custom/endpoint":
    #    module: my_module.CustomRequestHandler
    #    config: {}
212

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


## Homeserver blocking ##
222

223
224
# How to reach the server admin, used in ResourceLimitError
#
225
226
227
#admin_contact: 'mailto:admin@server.com'

# Global blocking
228
#
229
230
231
232
#hs_disabled: False
#hs_disabled_message: 'Human readable reason for why the HS is blocked'
#hs_disabled_limit_type: 'error code(str), to help clients decode reason'

233
234
# Monthly Active User Blocking
#
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# 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.
#
251
252
253
254
#limit_usage_by_mau: False
#max_mau_value: 50
#mau_trial_days: 2

255
256
257
258
# 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.
#
259
260
#mau_stats_only: False

261
262
263
# Sometimes the server admin will want to ensure certain accounts are
# never blocked by mau checking. These accounts are specified here.
#
264
265
266
#mau_limit_reserved_threepids:
#  - medium: 'email'
#    address: 'reserved_user@example.com'
267

268
269
270
# Used by phonehome stats to group together related servers.
#server_context: context

271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# 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."

288
289
290
291
292
# Whether to require a user to be in the room to add an alias to it.
# Defaults to 'true'.
#
#require_membership_for_aliases: false

293
294
295
296
297
298
# 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

299

300
301
302
303
304
305
306
307
308
## 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.
#
309
310
311
312
313
# 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`).
#
314
#tls_certificate_path: "CONFDIR/SERVERNAME.tls.crt"
315
316

# PEM-encoded private key for TLS
317
#
318
#tls_private_key_path: "CONFDIR/SERVERNAME.tls.key"
319

320
# Whether to verify TLS server certificates for outbound federation requests.
321
#
322
323
# Defaults to `true`. To disable certificate verification, uncomment the
# following line.
324
#
325
#federation_verify_certificates: false
326

327
328
329
330
331
332
333
334
335
# 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

336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
# 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

363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# 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:
    # ACME support is disabled by default. Uncomment the following line
    # (and tls_certificate_path and tls_private_key_path above) to enable it.
    #
388
    #enabled: true
389
390
391
392
393

    # 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
    #
394
    #url: https://acme-v01.api.letsencrypt.org/directory
395
396
397
398

    # Port number to listen on for the HTTP-01 challenge. Change this if
    # you are forwarding connections through Apache/Nginx/etc.
    #
399
    #port: 80
400
401
402
403
404

    # Local addresses to listen on for incoming connections.
    # Again, you may want to change this if you are forwarding connections
    # through Apache/Nginx/etc.
    #
405
    #bind_addresses: ['::', '0.0.0.0']
406
407
408

    # How many days remaining on a certificate before it is renewed.
    #
409
410
411
412
413
414
415
416
417
418
419
420
421
422
    #reprovision_threshold: 30

    # 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'.
    #
423
424
425
426
427
428
429
430
    #domain: matrix.example.com

    # 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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456

# 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
#
457
#tls_fingerprints: [{"sha256": "<base64_encoded_sha256_fingerprint>"}]
458
459
460



461
462
## Database ##

463
464
database:
  # The database engine name
465
  name: "psycopg2"
466
467
468
469
  # Arguments to pass to the engine
  args:
    dbname: synapse
    user: synapse
470
    password: {{ vault_postgres_users.synapse }}
471
472
473
474
    cp_min: 5
    cp_max: 10

# Number of events to cache in memory.
475
476
#
#event_cache_size: 10K
477
478


479
## Logging ##
480
481

# A yaml python logging config file
482
#
483
log_config: "/etc/synapse/log_config.yaml"
484
485
486
487


## Ratelimiting ##

488
# Ratelimiting settings for client actions (registration, login, messaging).
489
490
491
492
493
494
#
# 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:
495
496
#   - one for messages that ratelimits sending based on the account the client
#     is using
497
498
499
500
501
502
503
504
505
506
507
508
#   - 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.
#
# The defaults are as shown below.
#
509
510
511
512
#rc_message:
#  per_second: 0.2
#  burst_count: 10
#
513
514
515
516
517
518
519
520
521
522
523
524
525
526
#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
527
528


529
# Ratelimiting settings for incoming federation
530
#
531
532
533
534
535
536
537
538
539
540
# 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
541
#
542
# The defaults are as shown below.
543
#
544
545
546
547
548
549
#rc_federation:
#  window_size: 1000
#  sleep_limit: 10
#  sleep_delay: 500
#  reject_limit: 50
#  concurrent: 3
550
551
552
553
554
555
556
557

# 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
558
559
560



561
562
563
564
565
566
567
## 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

568
# Directory where uploaded images and attachments are stored.
569
#
570
571
572
573
media_store_path: "/var/lib/synapse/media_store"

# Media storage providers allow media to be stored in different
# locations.
574
575
576
577
578
579
580
581
582
583
584
585
#
#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
586
587

# Directory where in-progress uploads are stored.
588
#
589
uploads_path: "/var/lib/synapse/uploads"
590
591

# The largest allowed upload size in bytes
592
593
#
#max_upload_size: 10M
594
595

# Maximum number of pixels that will be thumbnailed
596
597
#
#max_image_pixels: 32M
598
599
600
601
602
603

# 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.
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
#
#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
632
633
634
635
636
637
638
639
640

# 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.
#
641
642
643
# (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly
# listed here, since they correspond to unroutable addresses.)
#
644
# This must be specified if url_preview_enabled is set. It is recommended that
645
# you uncomment the following list as a starting point.
646
#
647
648
649
650
651
652
653
654
655
656
657
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'

658
659
660
661
662
663
# 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.
#
664
665
#url_preview_ip_range_whitelist:
#   - '192.168.1.1'
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682

# 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.
#
683
684
685
#url_preview_url_blacklist:
#  # blacklist any URL with a username in its URI
#  - username: '*'
686
#
687
688
689
#  # blacklist all *.google.com URLs
#  - netloc: 'google.com'
#  - netloc: '*.google.com'
690
#
691
692
#  # blacklist all plain HTTP URLs
#  - scheme: 'http'
693
#
694
695
696
#  # blacklist http(s)://www.acme.com/foo
#  - netloc: 'www.acme.com'
#    path: '/foo'
697
#
698
699
#  # blacklist any URL with a literal IPv4 address
#  - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
700
701

# The largest allowed URL preview spidering size in bytes
702
703
#
#max_spider_size: 10M
704
705
706
707
708
709


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

# This Home Server's ReCAPTCHA public key.
710
711
#
#recaptcha_public_key: "YOUR_PUBLIC_KEY"
712
713

# This Home Server's ReCAPTCHA private key.
714
715
#
#recaptcha_private_key: "YOUR_PRIVATE_KEY"
716
717
718
719

# Enables ReCaptcha checks when registering, preventing signup
# unless a captcha is answered. Requires a valid ReCaptcha
# public/private key.
720
721
#
#enable_registration_captcha: false
722
723

# A secret key used to bypass the captcha test entirely.
724
#
725
726
727
#captcha_bypass_secret: "YOUR_SECRET_HERE"

# The API endpoint to use for verifying m.login.recaptcha responses.
728
729
#
#recaptcha_siteverify_api: "https://www.recaptcha.net/recaptcha/api/siteverify"
730
731


732
## TURN ##
733
734

# The public URIs of the TURN server to give to clients
735
#
736
#turn_uris: []
737
738

# The shared secret used to compute passwords for the TURN server
739
#
740
#turn_shared_secret: "YOUR_SHARED_SECRET"
741
742
743

# The Username and password if the TURN server needs them and
# does not use a token
744
#
745
746
747
748
#turn_username: "TURNSERVER_USERNAME"
#turn_password: "TURNSERVER_PASSWORD"

# How long generated TURN credentials last
749
750
#
#turn_user_lifetime: 1h
751

752
753
754
755
756
# 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).
757
758
#
#turn_allow_guests: True
759

760
761

## Registration ##
762
763
764
#
# Registration can be rate-limited using the parameters in the "Ratelimiting"
# section of this file.
765
766

# Enable registration for new users.
767
768
#
#enable_registration: false
769

770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
# 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.
#
790
791
792
793
794
795
# 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'
796
797
798
# 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.
799
#
800
801
802
803
804
#account_validity:
#  enabled: True
#  period: 6w
#  renew_at: 1w
#  renew_email_subject: "Renew your %(app)s account"
805
806
807
808
809
810
811
812
813
814
#  # 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"
815

816
817
818
819
820
821
822
823
824
825
826
# 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

827
828
# The user must provide all of the below types of 3PID when registering.
#
829
830
831
#registrations_require_3pid:
#  - email
#  - msisdn
832

833
834
835
# Explicitly disable asking for MSISDNs from the registration
# flow (overrides registrations_require_3pid if MSISDNs are set as required)
#
836
#disable_msisdn_registration: true
837

838
839
840
# Mandate that users are only allowed to associate certain formats of
# 3PIDs with accounts on this server.
#
841
842
843
844
845
846
847
#allowed_local_3pids:
#  - medium: email
#    pattern: '.*@matrix\.org'
#  - medium: email
#    pattern: '.*@vector\.im'
#  - medium: msisdn
#    pattern: '\+44'
848

849
850
851
852
# Enable 3PIDs lookup requests to identity servers from this server.
#
#enable_3pid_lookup: true

853
854
855
# If set, allows registration of standard or admin accounts by anyone who
# has the shared secret, even if registration is otherwise disabled.
#
856
registration_shared_secret: "{{ vault_matrix_secrets[matrix_server_name].registration_shared_secret }}"
857
858
859

# Set the number of bcrypt rounds used to generate password hash.
# Larger numbers increase the work factor needed to generate the hash.
860
861
862
# 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.
863
864
#
#bcrypt_rounds: 12
865
866
867
868

# 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.
869
870
#
#allow_guest_access: false
871

872
873
874
875
876
877
878
879
# 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

880
881
# The list of identity servers trusted to verify third party
# identifiers by this server.
882
883
884
#
# Also defines the ID server which will be called when an account is
# deactivated (one will be picked arbitrarily).
885
886
887
888
#
#trusted_third_party_id_servers:
#  - matrix.org
#  - vector.im
889
890
891

# Users who register on this homeserver will automatically be joined
# to these rooms
892
#
893
#auto_join_rooms:
894
#  - "#example:example.com"
895
896
897
898
899
900

# 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.
901
902
#
#autocreate_auto_join_rooms: true
903
904
905
906
907


## Metrics ###

# Enable collection and rendering of performance metrics
908
909
910
911
912
913
914
915
916
917
918
919
920
921
#
#enable_metrics: False

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

# Whether or not to report anonymized homeserver usage statistics.
922
report_stats: true
923
924
925
926
927


## API Configuration ##

# A list of event types that will be included in the room_invite_state
928
929
930
931
932
933
934
#
#room_invite_state_types:
#  - "m.room.join_rules"
#  - "m.room.canonical_alias"
#  - "m.room.avatar"
#  - "m.room.encryption"
#  - "m.room.name"
935
936


937
938
939
# A list of application service config files to use
#
app_service_config_files:
940
  - /etc/synapse/appservice-registration-irc.yaml
941

942
# Uncomment to enable tracking of application service IP addresses. Implicitly
943
# enables MAU tracking for application service users.
944
945
#
#track_appservice_user_ips: True
946

947

948
949
950
# 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.
951
#
952
macaroon_secret_key: "{{ vault_matrix_secrets[matrix_server_name].macaroon_secret_key }}"
953
954

# Used to enable access token expiration.
955
956
#
#expire_access_token: False
957

958
# a secret which is used to calculate HMACs for form values, to stop
959
960
# falsification of values. Must be specified for the User Consent
# forms to work.
961
#
962
963
form_secret: "{{ vault_matrix_secrets[matrix_server_name].form_secret }}"

964
965
966
## Signing Keys ##

# Path to the signing key to sign messages with
967
#
968
signing_key_path: "/etc/synapse/{{ matrix_server_name }}.signing.key"
969
970
971

# 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
972
973
#
#old_signing_keys:
974
975
976
977
978
979
980
981
982
983
#  "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.
984
985
#
#key_refresh_interval: 1d
986
987

# The trusted servers to download signing keys from.
988
#
989
990
991
992
993
994
995
996
997
998
999
1000
# 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.
#
# Options for each entry in the list include:
#
#    server_name: the name of the server. required.