homeserver.yaml.j2 34.6 KB
Newer Older
1
2
3
4
5
6
7
# vim:ft=yaml
## 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.
8
#
9
server_name: "{{ matrix_server_name }}"
10
11

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

15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# CPU affinity mask. Setting this restricts the CPUs on which the
# process will be scheduled. It is represented as a bitmask, with the
# lowest order bit corresponding to the first logical CPU and the
# highest order bit corresponding to the last logical CPU. Not all CPUs
# may exist on a given system but a mask may specify more CPUs than are
# present.
#
# For example:
#    0x00000001  is processor #0,
#    0x00000003  is processors #0 and #1,
#    0xFFFFFFFF  is all processors (#0 through #31).
#
# Pinning a Python process to a single CPU is desirable, because Python
# is inherently single-threaded due to the GIL, and can suffer a
# 30-40% slowdown due to cache blow-out and thread context switching
# if the scheduler happens to schedule the underlying threads across
# different cores. See
# https://www.mirantis.com/blog/improve-performance-python-programs-restricting-single-cpu/.
#
# This setting requires the affinity package to be installed!
#
36
#cpu_affinity: 0xFFFFFFFF
37

38
39
40
# The path to the web client which will be served at /_matrix/client/
# if 'webclient' is configured under the 'listeners' configuration.
#
41
#web_client_location: "/path/to/web/root"
42

43
44
45
46
47
# 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.
48
#
49
public_baseurl: https://{{ matrix_domain }}/
50
51
52
53

# 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.
54
55
#
#soft_file_limit: 0
56

57
# Set to false to disable presence tracking on this homeserver.
58
#
59
60
use_presence: true

61
# The GC threshold parameters to pass to `gc.set_threshold`, if defined
62
63
#
#gc_thresholds: [700, 10, 10]
64

65
66
# 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.
67
68
#
#filter_timeline_limit: 5000
69
70
71

# Whether room invites to users on this server should be blocked
# (except those sent by local server admins). The default is False.
72
73
74
75
76
77
78
79
80
#
#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
81
82
83
84
85
86
87

# 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.
#
88
#federation_domain_whitelist:
89
90
91
92
#  - lon.example.com
#  - nyc.example.com
#  - syd.example.com

93
94
# List of ports that Synapse should listen on, their purpose and their
# configuration.
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
152
#
# 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:
#
#   client: the client-server API (/_matrix/client). 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.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.
#
153
listeners:
154
155
156
157
158
159
160
  # 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
161
162
163
    type: http
    tls: true
    resources:
164
165
166
167
168
169
170
171
      - 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.rst.
  #
172
173
  - port: 8008
    tls: false
174
    bind_addresses: ['::1', '127.0.0.1']
175
176
177
178
    type: http
    x_forwarded: true

    resources:
179
      - names: [client, federation]
180
181
        compress: false

182
183
    # example additonal_resources:
    #
184
185
186
187
    #additional_resources:
    #  "/_matrix/my/custom/endpoint":
    #    module: my_module.CustomRequestHandler
    #    config: {}
188

189
190
  # Turn on the twisted ssh manhole service on localhost on the given
  # port.
191
192
193
194
195
196
197
  #
  #- port: 9000
  #  bind_addresses: ['::1', '127.0.0.1']
  #  type: manhole


## Homeserver blocking ##
198

199
200
# How to reach the server admin, used in ResourceLimitError
#
201
202
203
#admin_contact: 'mailto:admin@server.com'

# Global blocking
204
#
205
206
207
208
#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'

209
210
# Monthly Active User Blocking
#
211
212
213
214
#limit_usage_by_mau: False
#max_mau_value: 50
#mau_trial_days: 2

215
216
217
218
# 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.
#
219
220
#mau_stats_only: False

221
222
223
# Sometimes the server admin will want to ensure certain accounts are
# never blocked by mau checking. These accounts are specified here.
#
224
225
226
#mau_limit_reserved_threepids:
#  - medium: 'email'
#    address: 'reserved_user@example.com'
227
228


229
230
231
232
233
234
235
236
237
## 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.
#
238
239
240
241
242
# 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`).
#
243
244
245
tls_certificate_path: "/etc/synapse/{{ matrix_server_name }}.tls.crt"

# PEM-encoded private key for TLS
246
#
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
tls_private_key_path: "/etc/synapse/{{ matrix_server_name }}.tls.key"

# 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.
    #
274
    #enabled: true
275
276
277
278
279

    # 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
    #
280
    #url: https://acme-v01.api.letsencrypt.org/directory
281
282
283
284

    # Port number to listen on for the HTTP-01 challenge. Change this if
    # you are forwarding connections through Apache/Nginx/etc.
    #
285
    #port: 80
286
287
288
289
290

    # Local addresses to listen on for incoming connections.
    # Again, you may want to change this if you are forwarding connections
    # through Apache/Nginx/etc.
    #
291
    #bind_addresses: ['::', '0.0.0.0']
292
293
294

    # How many days remaining on a certificate before it is renewed.
    #
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
    #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'.
    #
    domain: {{ matrix_domain }}
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

# 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
#
336
#tls_fingerprints: [{"sha256": "<base64_encoded_sha256_fingerprint>"}]
337
338
339



340
341
## Database ##

342
343
database:
  # The database engine name
344
  name: "psycopg2"
345
346
347
348
  # Arguments to pass to the engine
  args:
    dbname: synapse
    user: synapse
349
    password: {{ vault_postgres_users.synapse }}
350
351
352
353
    cp_min: 5
    cp_max: 10

# Number of events to cache in memory.
354
355
#
#event_cache_size: 10K
356
357


358
## Logging ##
359
360

# A yaml python logging config file
361
#
362
log_config: "/etc/synapse/log_config.yaml"
363
364
365
366
367


## Ratelimiting ##

# Number of messages a client can send per second
368
369
#
#rc_messages_per_second: 0.2
370
371

# Number of message a client can send before being throttled
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
#
#rc_message_burst_count: 10.0

# Ratelimiting settings for registration and login.
#
# 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:
#   - 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.
#
#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
408
409

# The federation window size in milliseconds
410
411
#
#federation_rc_window_size: 1000
412
413
414

# The number of federation requests from a single server in a window
# before the server will delay processing the request.
415
416
#
#federation_rc_sleep_limit: 10
417
418
419

# The duration in milliseconds to delay processing events from
# remote servers by if they go over the sleep limit.
420
421
#
#federation_rc_sleep_delay: 500
422
423
424

# The maximum number of concurrent federation requests allowed
# from a single server
425
426
#
#federation_rc_reject_limit: 50
427
428
429

# The number of federation requests to concurrently process from a
# single server
430
431
432
433
434
435
436
437
438
439
#
#federation_rc_concurrent: 3

# 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
440
441
442
443



# Directory where uploaded images and attachments are stored.
444
#
445
446
447
448
media_store_path: "/var/lib/synapse/media_store"

# Media storage providers allow media to be stored in different
# locations.
449
450
451
452
453
454
455
456
457
458
459
460
#
#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
461
462

# Directory where in-progress uploads are stored.
463
#
464
uploads_path: "/var/lib/synapse/uploads"
465
466

# The largest allowed upload size in bytes
467
468
#
#max_upload_size: 10M
469
470

# Maximum number of pixels that will be thumbnailed
471
472
#
#max_image_pixels: 32M
473
474
475
476
477
478

# 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.
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
#
#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
507
508
509
510
511
512
513
514
515

# 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.
#
516
517
518
519
520
# (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly
# listed here, since they correspond to unroutable addresses.)
#
# This must be specified if url_preview_enabled is set. It is recommended that 
# you uncomment the following list as a starting point.
521
#
522
523
524
525
526
527
528
529
530
531
532
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'

533
534
535
536
537
538
# 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.
#
539
540
#url_preview_ip_range_whitelist:
#   - '192.168.1.1'
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557

# 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.
#
558
559
560
#url_preview_url_blacklist:
#  # blacklist any URL with a username in its URI
#  - username: '*'
561
#
562
563
564
#  # blacklist all *.google.com URLs
#  - netloc: 'google.com'
#  - netloc: '*.google.com'
565
#
566
567
#  # blacklist all plain HTTP URLs
#  - scheme: 'http'
568
#
569
570
571
#  # blacklist http(s)://www.acme.com/foo
#  - netloc: 'www.acme.com'
#    path: '/foo'
572
#
573
574
#  # blacklist any URL with a literal IPv4 address
#  - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
575
576

# The largest allowed URL preview spidering size in bytes
577
578
#
#max_spider_size: 10M
579
580
581
582
583
584


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

# This Home Server's ReCAPTCHA public key.
585
586
#
#recaptcha_public_key: "YOUR_PUBLIC_KEY"
587
588

# This Home Server's ReCAPTCHA private key.
589
590
#
#recaptcha_private_key: "YOUR_PRIVATE_KEY"
591
592
593
594

# Enables ReCaptcha checks when registering, preventing signup
# unless a captcha is answered. Requires a valid ReCaptcha
# public/private key.
595
596
#
#enable_registration_captcha: false
597
598

# A secret key used to bypass the captcha test entirely.
599
#
600
601
602
#captcha_bypass_secret: "YOUR_SECRET_HERE"

# The API endpoint to use for verifying m.login.recaptcha responses.
603
604
#
#recaptcha_siteverify_api: "https://www.recaptcha.net/recaptcha/api/siteverify"
605
606


607
## TURN ##
608
609

# The public URIs of the TURN server to give to clients
610
#
611
#turn_uris: []
612
613

# The shared secret used to compute passwords for the TURN server
614
#
615
#turn_shared_secret: "YOUR_SHARED_SECRET"
616
617
618

# The Username and password if the TURN server needs them and
# does not use a token
619
#
620
621
622
623
#turn_username: "TURNSERVER_USERNAME"
#turn_password: "TURNSERVER_PASSWORD"

# How long generated TURN credentials last
624
625
#
#turn_user_lifetime: 1h
626

627
628
629
630
631
# 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).
632
633
#
#turn_allow_guests: True
634

635
636

## Registration ##
637
638
639
#
# Registration can be rate-limited using the parameters in the "Ratelimiting"
# section of this file.
640
641

# Enable registration for new users.
642
643
#
#enable_registration: false
644

645
646
# The user must provide all of the below types of 3PID when registering.
#
647
648
649
#registrations_require_3pid:
#  - email
#  - msisdn
650

651
652
653
# Explicitly disable asking for MSISDNs from the registration
# flow (overrides registrations_require_3pid if MSISDNs are set as required)
#
654
#disable_msisdn_registration: true
655

656
657
658
# Mandate that users are only allowed to associate certain formats of
# 3PIDs with accounts on this server.
#
659
660
661
662
663
664
665
#allowed_local_3pids:
#  - medium: email
#    pattern: '.*@matrix\.org'
#  - medium: email
#    pattern: '.*@vector\.im'
#  - medium: msisdn
#    pattern: '\+44'
666

667
668
669
# If set, allows registration of standard or admin accounts by anyone who
# has the shared secret, even if registration is otherwise disabled.
#
670
registration_shared_secret: "{{ vault_matrix_secrets[matrix_server_name].registration_shared_secret }}"
671
672
673

# Set the number of bcrypt rounds used to generate password hash.
# Larger numbers increase the work factor needed to generate the hash.
674
675
676
# 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.
677
678
#
#bcrypt_rounds: 12
679
680
681
682

# 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.
683
684
#
#allow_guest_access: false
685

686
687
688
689
690
691
692
693
# 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

694
695
# The list of identity servers trusted to verify third party
# identifiers by this server.
696
697
698
#
# Also defines the ID server which will be called when an account is
# deactivated (one will be picked arbitrarily).
699
700
701
702
#
#trusted_third_party_id_servers:
#  - matrix.org
#  - vector.im
703
704
705

# Users who register on this homeserver will automatically be joined
# to these rooms
706
#
707
#auto_join_rooms:
708
#  - "#example:example.com"
709
710
711
712
713
714

# 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.
715
716
#
#autocreate_auto_join_rooms: true
717
718
719
720
721


## Metrics ###

# Enable collection and rendering of performance metrics
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
#
#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.
# report_stats: true|false
737
738
739
740
741


## API Configuration ##

# A list of event types that will be included in the room_invite_state
742
743
744
745
746
747
748
#
#room_invite_state_types:
#  - "m.room.join_rules"
#  - "m.room.canonical_alias"
#  - "m.room.avatar"
#  - "m.room.encryption"
#  - "m.room.name"
749
750


751
752
753
754
# A list of application service config files to use
#
app_service_config_files:
  - "/etc/synapse/appservice-registration-irc.yaml"
755

756
# Uncomment to enable tracking of application service IP addresses. Implicitly
757
# enables MAU tracking for application service users.
758
759
#
#track_appservice_user_ips: True
760

761

762
763
764
# 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.
765
#
766
macaroon_secret_key: "{{ vault_matrix_secrets[matrix_server_name].macaroon_secret_key }}"
767
768

# Used to enable access token expiration.
769
770
#
#expire_access_token: False
771

772
# a secret which is used to calculate HMACs for form values, to stop
773
774
# falsification of values. Must be specified for the User Consent
# forms to work.
775
#
776
777
form_secret: "{{ vault_matrix_secrets[matrix_server_name].form_secret }}"

778
779
780
## Signing Keys ##

# Path to the signing key to sign messages with
781
#
782
signing_key_path: "/etc/synapse/{{ matrix_server_name }}.signing.key"
783
784
785

# 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
786
787
#
#old_signing_keys:
788
789
790
791
792
793
794
795
796
797
#  "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.
798
799
#
#key_refresh_interval: 1d
800
801

# The trusted servers to download signing keys from.
802
803
804
805
806
807
808
#
#perspectives:
#  servers:
#    "matrix.org":
#      verify_keys:
#        "ed25519:auto":
#          key: "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"
809
810


811
812
# Enable SAML2 for registration and login. Uses pysaml2.
#
813
814
# `sp_config` is the configuration for the pysaml2 Service Provider.
# See pysaml2 docs for format of config.
815
#
816
817
818
# 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.
819
#
820
821
822
823
824
825
826
827
#saml2_config:
#  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
828
#
829
830
831
#    # The rest of sp_config is just used to generate our metadata xml, and you
#    # may well not need it, depending on your setup. Alternatively you
#    # may need a whole lot more detail - see the pysaml2 docs!
832
#
833
834
#    description: ["My awesome SP", "en"]
#    name: ["Test SP", "en"]
835
#
836
837
838
839
840
#    organization:
#      name: Example com
#      display_name:
#        - ["Example co", "en"]
#      url: "http://example.com"
841
#
842
843
844
845
846
#    contact_person:
#      - given_name: Bob
#        sur_name: "the Sysadmin"
#        email_address": ["admin@example.com"]
#        contact_type": technical
847
#
848
849
850
851
#  # Instead of putting the config inline as above, you can specify a
#  # separate pysaml2 configuration file:
#  #
#  config_path: "CONFDIR/sp_conf.py"
852
853
854
855



# Enable CAS for registration and login.
856
#
857
858
859
#cas_config:
#   enabled: true
#   server_url: "https://cas-server.com"
860
#   service_url: "https://homeserver.domain.com:8448"
861
862
863
864
865
866
#   #required_attributes:
#   #    name: value


# The JWT needs to contain a globally unique "sub" (subject) claim.
#
867
868
869
870
#jwt_config:
#   enabled: true
#   secret: "a secret"
#   algorithm: "HS256"
871
872
873


password_config:
874
875
876
877
   # Uncomment to disable password login
   #
   #enabled: false

878
879
   # Uncomment and change to a secret random string for extra security.
   # DO NOT CHANGE THIS AFTER INITIAL SETUP!
880
   #
881
   pepper: "{{ vault_matrix_secrets[matrix_server_name].pepper }}"
882
883
884
885
886
887
888



# Enable sending emails for notification events
# 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.
889
890
891
892
#
# If your SMTP server requires authentication, the optional smtp_user &
# smtp_pass variables should be used
#
893
894
895
896
#email:
#   enable_notifs: false
#   smtp_host: "localhost"
#   smtp_port: 25
897
898
899
#   smtp_user: "exampleusername"
#   smtp_pass: "examplepassword"
#   require_transport_security: False
900
901
#   notif_from: "Your Friendly %(app)s Home Server <noreply@example.com>"
#   app_name: Matrix
902
903
904
#   # if template_dir is unset, uses the example templates that are part of
#   # the Synapse distribution.
#   #template_dir: res/templates
905
906
907
908
909
910
#   notif_template_html: notif_mail.html
#   notif_template_text: notif_mail.txt
#   notif_for_new_users: True
#   riot_base_url: "http://localhost/riot"


911
912
913
914
915
916
917
918
919
920
921
922
923
924
#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)"
925
926
927
928
929
930
931
932
933
934



# 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.
935
#
936
937
938
939
940
# 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:
941
#  include_content: true
942
943


944
945
946
947
#spam_checker:
#  module: "my_custom_project.SuperSpamChecker"
#  config:
#    example_option: 'things'
948
949


950
951
952
# Uncomment to allow non-server-admin users to create groups on this server
#
#enable_group_creation: true
953
954
955

# If enabled, non server admins can only create groups with local parts
# starting with this prefix
956
957
#
#group_creation_prefix: "unofficial/"
958
959
960
961
962



# User Directory configuration
#
963
964
965
966
# 'enabled' defines whether users can search the user directory. If
# false then empty responses are returned to all queries. Defaults to
# true.
#
967
968
969
970
971
972
973
# 'search_all_users' defines whether to search all users visible to your HS
# when searching the user directory, rather than limiting to users visible
# in public rooms.  Defaults to false.  If you set it True, you'll have to run
# UPDATE user_directory_stream_pos SET stream_id = NULL;
# on your database to tell it to rebuild the user_directory search indexes.
#
#user_directory:
974
975
#  enabled: true
#  search_all_users: false
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000


# 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
For faster browsing, not all history is shown. View entire blame