Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

799 regels
27 KiB

  1. # vim:ft=yaml
  2. # PEM encoded X509 certificate for TLS.
  3. # You can replace the self-signed certificate that synapse
  4. # autogenerates on launch with your own SSL certificate + key pair
  5. # if you like. Any required intermediary certificates can be
  6. # appended after the primary certificate in hierarchical order.
  7. tls_certificate_path: "/data/{{ hostname_matrix }}.tls.crt"
  8. # PEM encoded private key for TLS
  9. tls_private_key_path: "/data/{{ hostname_matrix }}.tls.key"
  10. # PEM dh parameters for ephemeral keys
  11. tls_dh_params_path: "/data/{{ hostname_matrix }}.tls.dh"
  12. # Don't bind to the https port
  13. no_tls: False
  14. # List of allowed TLS fingerprints for this server to publish along
  15. # with the signing keys for this server. Other matrix servers that
  16. # make HTTPS requests to this server will check that the TLS
  17. # certificates returned by this server match one of the fingerprints.
  18. #
  19. # Synapse automatically adds the fingerprint of its own certificate
  20. # to the list. So if federation traffic is handled directly by synapse
  21. # then no modification to the list is required.
  22. #
  23. # If synapse is run behind a load balancer that handles the TLS then it
  24. # will be necessary to add the fingerprints of the certificates used by
  25. # the loadbalancers to this list if they are different to the one
  26. # synapse is using.
  27. #
  28. # Homeservers are permitted to cache the list of TLS fingerprints
  29. # returned in the key responses up to the "valid_until_ts" returned in
  30. # key. It may be necessary to publish the fingerprints of a new
  31. # certificate and wait until the "valid_until_ts" of the previous key
  32. # responses have passed before deploying it.
  33. #
  34. # You can calculate a fingerprint from a given TLS listener via:
  35. # openssl s_client -connect $host:$port < /dev/null 2> /dev/null |
  36. # openssl x509 -outform DER | openssl sha256 -binary | base64 | tr -d '='
  37. # or by checking matrix.org/federationtester/api/report?server_name=$host
  38. #
  39. tls_fingerprints: []
  40. # tls_fingerprints: [{"sha256": "<base64_encoded_sha256_fingerprint>"}]
  41. ## Server ##
  42. # The domain name of the server, with optional explicit port.
  43. # This is used by remote servers to connect to this server,
  44. # e.g. matrix.org, localhost:8080, etc.
  45. # This is also the last part of your UserID.
  46. server_name: "{{ hostname_identity }}"
  47. # When running as a daemon, the file to store the pid in
  48. pid_file: /homeserver.pid
  49. # CPU affinity mask. Setting this restricts the CPUs on which the
  50. # process will be scheduled. It is represented as a bitmask, with the
  51. # lowest order bit corresponding to the first logical CPU and the
  52. # highest order bit corresponding to the last logical CPU. Not all CPUs
  53. # may exist on a given system but a mask may specify more CPUs than are
  54. # present.
  55. #
  56. # For example:
  57. # 0x00000001 is processor #0,
  58. # 0x00000003 is processors #0 and #1,
  59. # 0xFFFFFFFF is all processors (#0 through #31).
  60. #
  61. # Pinning a Python process to a single CPU is desirable, because Python
  62. # is inherently single-threaded due to the GIL, and can suffer a
  63. # 30-40% slowdown due to cache blow-out and thread context switching
  64. # if the scheduler happens to schedule the underlying threads across
  65. # different cores. See
  66. # https://www.mirantis.com/blog/improve-performance-python-programs-restricting-single-cpu/.
  67. #
  68. # This setting requires the affinity package to be installed!
  69. #
  70. # cpu_affinity: 0xFFFFFFFF
  71. # Whether to serve a web client from the HTTP/HTTPS root resource.
  72. web_client: False
  73. # The root directory to server for the above web client.
  74. # If left undefined, synapse will serve the matrix-angular-sdk web client.
  75. # Make sure matrix-angular-sdk is installed with pip if web_client is True
  76. # and web_client_location is undefined
  77. # web_client_location: "/path/to/web/root"
  78. # The public-facing base URL for the client API (not including _matrix/...)
  79. public_baseurl: https://{{ hostname_matrix }}/
  80. # Set the soft limit on the number of file descriptors synapse can use
  81. # Zero is used to indicate synapse should set the soft limit to the
  82. # hard limit.
  83. soft_file_limit: 0
  84. # Set to false to disable presence tracking on this homeserver.
  85. use_presence: {{ matrix_synapse_use_presence|to_json }}
  86. # The GC threshold parameters to pass to `gc.set_threshold`, if defined
  87. # gc_thresholds: [700, 10, 10]
  88. # Set the limit on the returned events in the timeline in the get
  89. # and sync operations. The default value is -1, means no upper limit.
  90. # filter_timeline_limit: 5000
  91. # Whether room invites to users on this server should be blocked
  92. # (except those sent by local server admins). The default is False.
  93. # block_non_admin_invites: True
  94. # Restrict federation to the following whitelist of domains.
  95. # N.B. we recommend also firewalling your federation listener to limit
  96. # inbound federation traffic as early as possible, rather than relying
  97. # purely on this application-layer restriction. If not specified, the
  98. # default is to whitelist everything.
  99. #
  100. # federation_domain_whitelist:
  101. # - lon.example.com
  102. # - nyc.example.com
  103. # - syd.example.com
  104. {% if matrix_synapse_federation_domain_whitelist is not none %}
  105. {# Cannot use `|to_nice_yaml` here, as an empty list does not get serialized properly by it. #}
  106. federation_domain_whitelist: {{ matrix_synapse_federation_domain_whitelist|to_json }}
  107. {% endif %}
  108. # List of ports that Synapse should listen on, their purpose and their
  109. # configuration.
  110. listeners:
  111. {% if matrix_synapse_federation_enabled %}
  112. # Main HTTPS listener
  113. # For when matrix traffic is sent directly to synapse.
  114. -
  115. # The port to listen for HTTPS requests on.
  116. port: 8448
  117. # Local addresses to listen on.
  118. # On Linux and Mac OS, `::` will listen on all IPv4 and IPv6
  119. # addresses by default. For most other OSes, this will only listen
  120. # on IPv6.
  121. bind_addresses:
  122. - '::'
  123. - '0.0.0.0'
  124. # This is a 'http' listener, allows us to specify 'resources'.
  125. type: http
  126. tls: true
  127. # Use the X-Forwarded-For (XFF) header as the client IP and not the
  128. # actual client IP.
  129. x_forwarded: false
  130. # List of HTTP resources to serve on this listener.
  131. resources:
  132. - names: [federation] # Federation APIs
  133. compress: false
  134. # optional list of additional endpoints which can be loaded via
  135. # dynamic modules
  136. # additional_resources:
  137. # "/_matrix/my/custom/endpoint":
  138. # module: my_module.CustomRequestHandler
  139. # config: {}
  140. {% endif %}
  141. # Unsecure HTTP listener,
  142. # For when matrix traffic passes through loadbalancer that unwraps TLS.
  143. - port: 8008
  144. tls: false
  145. bind_addresses: ['::', '0.0.0.0']
  146. type: http
  147. x_forwarded: true
  148. resources:
  149. - names: [client]
  150. compress: false
  151. # Turn on the twisted ssh manhole service on localhost on the given
  152. # port.
  153. # - port: 9000
  154. # bind_addresses: ['::1', '127.0.0.1']
  155. # type: manhole
  156. # Homeserver blocking
  157. #
  158. # How to reach the server admin, used in ResourceLimitError
  159. # admin_contact: 'mailto:admin@server.com'
  160. #
  161. # Global block config
  162. #
  163. # hs_disabled: False
  164. # hs_disabled_message: 'Human readable reason for why the HS is blocked'
  165. # hs_disabled_limit_type: 'error code(str), to help clients decode reason'
  166. #
  167. # Monthly Active User Blocking
  168. #
  169. # Enables monthly active user checking
  170. # limit_usage_by_mau: False
  171. # max_mau_value: 50
  172. # mau_trial_days: 2
  173. #
  174. # Sometimes the server admin will want to ensure certain accounts are
  175. # never blocked by mau checking. These accounts are specified here.
  176. #
  177. # mau_limit_reserved_threepids:
  178. # - medium: 'email'
  179. # address: 'reserved_user@example.com'
  180. # Database configuration
  181. database:
  182. # The database engine name
  183. name: "psycopg2"
  184. args:
  185. user: {{ matrix_synapse_database_user|to_json }}
  186. password: {{ matrix_synapse_database_password|to_json }}
  187. database: "{{ matrix_synapse_database_database }}"
  188. host: "{{ matrix_synapse_database_host }}"
  189. cp_min: 5
  190. cp_max: 10
  191. # Number of events to cache in memory.
  192. event_cache_size: "{{ matrix_synapse_event_cache_size }}"
  193. # A yaml python logging config file
  194. log_config: "/data/{{ hostname_matrix }}.log.config"
  195. ## Ratelimiting ##
  196. # Number of messages a client can send per second
  197. rc_messages_per_second: {{ matrix_synapse_rc_messages_per_second }}
  198. # Number of message a client can send before being throttled
  199. rc_message_burst_count: {{ matrix_synapse_rc_message_burst_count }}
  200. # The federation window size in milliseconds
  201. federation_rc_window_size: 1000
  202. # The number of federation requests from a single server in a window
  203. # before the server will delay processing the request.
  204. federation_rc_sleep_limit: 10
  205. # The duration in milliseconds to delay processing events from
  206. # remote servers by if they go over the sleep limit.
  207. federation_rc_sleep_delay: 500
  208. # The maximum number of concurrent federation requests allowed
  209. # from a single server
  210. federation_rc_reject_limit: 50
  211. # The number of federation requests to concurrently process from a
  212. # single server
  213. federation_rc_concurrent: 3
  214. # Directory where uploaded images and attachments are stored.
  215. media_store_path: "/matrix-media-store-parent/{{ matrix_synapse_media_store_directory_name }}"
  216. # Media storage providers allow media to be stored in different
  217. # locations.
  218. # media_storage_providers:
  219. # - module: file_system
  220. # # Whether to write new local files.
  221. # store_local: false
  222. # # Whether to write new remote media
  223. # store_remote: false
  224. # # Whether to block upload requests waiting for write to this
  225. # # provider to complete
  226. # store_synchronous: false
  227. # config:
  228. # directory: /mnt/some/other/directory
  229. # Directory where in-progress uploads are stored.
  230. uploads_path: "/matrix-run/uploads"
  231. # The largest allowed upload size in bytes
  232. max_upload_size: "{{ matrix_synapse_max_upload_size_mb }}M"
  233. # Maximum number of pixels that will be thumbnailed
  234. max_image_pixels: "32M"
  235. # Whether to generate new thumbnails on the fly to precisely match
  236. # the resolution requested by the client. If true then whenever
  237. # a new resolution is requested by the client the server will
  238. # generate a new thumbnail. If false the server will pick a thumbnail
  239. # from a precalculated list.
  240. dynamic_thumbnails: false
  241. # List of thumbnail to precalculate when an image is uploaded.
  242. thumbnail_sizes:
  243. - width: 32
  244. height: 32
  245. method: crop
  246. - width: 96
  247. height: 96
  248. method: crop
  249. - width: 320
  250. height: 240
  251. method: scale
  252. - width: 640
  253. height: 480
  254. method: scale
  255. - width: 800
  256. height: 600
  257. method: scale
  258. # Is the preview URL API enabled? If enabled, you *must* specify
  259. # an explicit url_preview_ip_range_blacklist of IPs that the spider is
  260. # denied from accessing.
  261. url_preview_enabled: True
  262. # List of IP address CIDR ranges that the URL preview spider is denied
  263. # from accessing. There are no defaults: you must explicitly
  264. # specify a list for URL previewing to work. You should specify any
  265. # internal services in your network that you do not want synapse to try
  266. # to connect to, otherwise anyone in any Matrix room could cause your
  267. # synapse to issue arbitrary GET requests to your internal services,
  268. # causing serious security issues.
  269. #
  270. url_preview_ip_range_blacklist:
  271. - '127.0.0.0/8'
  272. - '10.0.0.0/8'
  273. - '172.16.0.0/12'
  274. - '192.168.0.0/16'
  275. - '100.64.0.0/10'
  276. - '169.254.0.0/16'
  277. - '::1/128'
  278. - 'fe80::/64'
  279. - 'fc00::/7'
  280. #
  281. # List of IP address CIDR ranges that the URL preview spider is allowed
  282. # to access even if they are specified in url_preview_ip_range_blacklist.
  283. # This is useful for specifying exceptions to wide-ranging blacklisted
  284. # target IP ranges - e.g. for enabling URL previews for a specific private
  285. # website only visible in your network.
  286. #
  287. # url_preview_ip_range_whitelist:
  288. # - '192.168.1.1'
  289. # Optional list of URL matches that the URL preview spider is
  290. # denied from accessing. You should use url_preview_ip_range_blacklist
  291. # in preference to this, otherwise someone could define a public DNS
  292. # entry that points to a private IP address and circumvent the blacklist.
  293. # This is more useful if you know there is an entire shape of URL that
  294. # you know that will never want synapse to try to spider.
  295. #
  296. # Each list entry is a dictionary of url component attributes as returned
  297. # by urlparse.urlsplit as applied to the absolute form of the URL. See
  298. # https://docs.python.org/2/library/urlparse.html#urlparse.urlsplit
  299. # The values of the dictionary are treated as an filename match pattern
  300. # applied to that component of URLs, unless they start with a ^ in which
  301. # case they are treated as a regular expression match. If all the
  302. # specified component matches for a given list item succeed, the URL is
  303. # blacklisted.
  304. #
  305. # url_preview_url_blacklist:
  306. # # blacklist any URL with a username in its URI
  307. # - username: '*'
  308. #
  309. # # blacklist all *.google.com URLs
  310. # - netloc: 'google.com'
  311. # - netloc: '*.google.com'
  312. #
  313. # # blacklist all plain HTTP URLs
  314. # - scheme: 'http'
  315. #
  316. # # blacklist http(s)://www.acme.com/foo
  317. # - netloc: 'www.acme.com'
  318. # path: '/foo'
  319. #
  320. # # blacklist any URL with a literal IPv4 address
  321. # - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
  322. # The largest allowed URL preview spidering size in bytes
  323. max_spider_size: "10M"
  324. ## Captcha ##
  325. # See docs/CAPTCHA_SETUP for full details of configuring this.
  326. # This Home Server's ReCAPTCHA public key.
  327. recaptcha_public_key: "YOUR_PUBLIC_KEY"
  328. # This Home Server's ReCAPTCHA private key.
  329. recaptcha_private_key: "YOUR_PRIVATE_KEY"
  330. # Enables ReCaptcha checks when registering, preventing signup
  331. # unless a captcha is answered. Requires a valid ReCaptcha
  332. # public/private key.
  333. enable_registration_captcha: False
  334. # A secret key used to bypass the captcha test entirely.
  335. #captcha_bypass_secret: "YOUR_SECRET_HERE"
  336. # The API endpoint to use for verifying m.login.recaptcha responses.
  337. recaptcha_siteverify_api: "https://www.google.com/recaptcha/api/siteverify"
  338. ## Turn ##
  339. # The public URIs of the TURN server to give to clients
  340. turn_uris: {{ matrix_synapse_turn_uris|to_json }}
  341. # The shared secret used to compute passwords for the TURN server
  342. turn_shared_secret: {{ matrix_synapse_turn_shared_secret|to_json }}
  343. # The Username and password if the TURN server needs them and
  344. # does not use a token
  345. #turn_username: "TURNSERVER_USERNAME"
  346. #turn_password: "TURNSERVER_PASSWORD"
  347. # How long generated TURN credentials last
  348. turn_user_lifetime: "1h"
  349. # Whether guests should be allowed to use the TURN server.
  350. # This defaults to True, otherwise VoIP will be unreliable for guests.
  351. # However, it does introduce a slight security risk as it allows users to
  352. # connect to arbitrary endpoints without having first signed up for a
  353. # valid account (e.g. by passing a CAPTCHA).
  354. turn_allow_guests: False
  355. ## Registration ##
  356. # Enable registration for new users.
  357. enable_registration: {{ matrix_synapse_enable_registration|to_json }}
  358. # The user must provide all of the below types of 3PID when registering.
  359. #
  360. # registrations_require_3pid:
  361. # - email
  362. # - msisdn
  363. # Mandate that users are only allowed to associate certain formats of
  364. # 3PIDs with accounts on this server.
  365. #
  366. # allowed_local_3pids:
  367. # - medium: email
  368. # pattern: ".*@matrix\.org"
  369. # - medium: email
  370. # pattern: ".*@vector\.im"
  371. # - medium: msisdn
  372. # pattern: "\+44"
  373. # If set, allows registration by anyone who also has the shared
  374. # secret, even if registration is otherwise disabled.
  375. registration_shared_secret: {{ matrix_synapse_registration_shared_secret|to_json }}
  376. # Set the number of bcrypt rounds used to generate password hash.
  377. # Larger numbers increase the work factor needed to generate the hash.
  378. # The default number is 12 (which equates to 2^12 rounds).
  379. # N.B. that increasing this will exponentially increase the time required
  380. # to register or login - e.g. 24 => 2^24 rounds which will take >20 mins.
  381. bcrypt_rounds: 12
  382. # Allows users to register as guests without a password/email/etc, and
  383. # participate in rooms hosted on this server which have been made
  384. # accessible to anonymous users.
  385. allow_guest_access: False
  386. # The list of identity servers trusted to verify third party
  387. # identifiers by this server.
  388. {% if matrix_synapse_trusted_third_party_id_servers|length > 0 %}
  389. trusted_third_party_id_servers:
  390. {{ matrix_synapse_trusted_third_party_id_servers|to_nice_yaml }}
  391. {% endif %}
  392. # Users who register on this homeserver will automatically be joined
  393. # to these rooms
  394. #auto_join_rooms:
  395. # - "#example:example.com"
  396. {% if matrix_synapse_auto_join_rooms|length > 0 %}
  397. auto_join_rooms:
  398. {{ matrix_synapse_auto_join_rooms|to_nice_yaml }}
  399. {% endif %}
  400. # Where auto_join_rooms are specified, setting this flag ensures that the
  401. # the rooms exist by creating them when the first user on the
  402. # homeserver registers.
  403. # Setting to false means that if the rooms are not manually created,
  404. # users cannot be auto-joined since they do not exist.
  405. autocreate_auto_join_rooms: {{ matrix_synapse_autocreate_auto_join_rooms }}
  406. ## Metrics ###
  407. # Enable collection and rendering of performance metrics
  408. enable_metrics: False
  409. report_stats: {{ matrix_synapse_report_stats|to_json }}
  410. ## API Configuration ##
  411. # A list of event types that will be included in the room_invite_state
  412. room_invite_state_types:
  413. - "m.room.join_rules"
  414. - "m.room.canonical_alias"
  415. - "m.room.avatar"
  416. - "m.room.name"
  417. # A list of application service config file to use
  418. app_service_config_files: {{ matrix_synapse_app_service_config_files }}
  419. macaroon_secret_key: {{ matrix_synapse_macaroon_secret_key|to_json }}
  420. # Used to enable access token expiration.
  421. expire_access_token: False
  422. # a secret which is used to calculate HMACs for form values, to stop
  423. # falsification of values
  424. form_secret: {{ matrix_synapse_form_secret|to_json }}
  425. ## Signing Keys ##
  426. # Path to the signing key to sign messages with
  427. signing_key_path: "/data/{{ hostname_matrix }}.signing.key"
  428. # The keys that the server used to sign messages with but won't use
  429. # to sign new messages. E.g. it has lost its private key
  430. old_signing_keys: {}
  431. # "ed25519:auto":
  432. # # Base64 encoded public key
  433. # key: "The public part of your old signing key."
  434. # # Millisecond POSIX timestamp when the key expired.
  435. # expired_ts: 123456789123
  436. # How long key response published by this server is valid for.
  437. # Used to set the valid_until_ts in /key/v2 APIs.
  438. # Determines how quickly servers will query to check which keys
  439. # are still valid.
  440. key_refresh_interval: "1d" # 1 Day.
  441. # The trusted servers to download signing keys from.
  442. perspectives:
  443. servers:
  444. "matrix.org":
  445. verify_keys:
  446. "ed25519:auto":
  447. key: "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"
  448. # Enable SAML2 for registration and login. Uses pysaml2
  449. # config_path: Path to the sp_conf.py configuration file
  450. # idp_redirect_url: Identity provider URL which will redirect
  451. # the user back to /login/saml2 with proper info.
  452. # See pysaml2 docs for format of config.
  453. #saml2_config:
  454. # enabled: true
  455. # config_path: "/data/sp_conf.py"
  456. # idp_redirect_url: "http://{{ hostname_matrix }}/idp"
  457. # Enable CAS for registration and login.
  458. #cas_config:
  459. # enabled: true
  460. # server_url: "https://cas-server.com"
  461. # service_url: "https://homeserver.domain.com:8448"
  462. # #required_attributes:
  463. # # name: value
  464. # The JWT needs to contain a globally unique "sub" (subject) claim.
  465. #
  466. # jwt_config:
  467. # enabled: true
  468. # secret: "a secret"
  469. # algorithm: "HS256"
  470. # Enable password for login.
  471. password_config:
  472. enabled: true
  473. # Uncomment and change to a secret random string for extra security.
  474. # DO NOT CHANGE THIS AFTER INITIAL SETUP!
  475. pepper: {{ matrix_synapse_password_config_pepper|to_json }}
  476. # Enable sending emails for notification events
  477. # Defining a custom URL for Riot is only needed if email notifications
  478. # should contain links to a self-hosted installation of Riot; when set
  479. # the "app_name" setting is ignored.
  480. #
  481. # If your SMTP server requires authentication, the optional smtp_user &
  482. # smtp_pass variables should be used
  483. #
  484. {% if matrix_synapse_email_enabled %}
  485. email:
  486. enable_notifs: true
  487. smtp_host: {{ matrix_synapse_email_smtp_host|to_json }}
  488. smtp_port: {{ matrix_synapse_email_smtp_port|to_json }}
  489. require_transport_security: {{ matrix_synapse_email_smtp_require_transport_security|to_json }}
  490. notif_from: {{ matrix_synapse_email_notif_from|to_json }}
  491. app_name: Matrix
  492. notif_template_html: notif_mail.html
  493. notif_template_text: notif_mail.txt
  494. notif_for_new_users: True
  495. riot_base_url: {{ matrix_synapse_email_riot_base_url|to_json }}
  496. {% endif %}
  497. # password_providers:
  498. # - module: "ldap_auth_provider.LdapAuthProvider"
  499. # config:
  500. # enabled: true
  501. # uri: "ldap://ldap.example.com:389"
  502. # start_tls: true
  503. # base: "ou=users,dc=example,dc=com"
  504. # attributes:
  505. # uid: "cn"
  506. # mail: "email"
  507. # name: "givenName"
  508. # #bind_dn:
  509. # #bind_password:
  510. # #filter: "(objectClass=posixAccount)"
  511. {% if matrix_synapse_password_providers_enabled %}
  512. password_providers:
  513. {% if matrix_synapse_ext_password_provider_shared_secret_auth_enabled %}
  514. - module: "shared_secret_authenticator.SharedSecretAuthenticator"
  515. config:
  516. sharedSecret: {{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret|to_json }}
  517. {% endif %}
  518. {% if matrix_synapse_ext_password_provider_rest_auth_enabled %}
  519. - module: "rest_auth_provider.RestAuthProvider"
  520. config:
  521. endpoint: {{ matrix_synapse_ext_password_provider_rest_auth_endpoint|to_json }}
  522. policy:
  523. registration:
  524. username:
  525. enforceLowercase: {{ matrix_synapse_ext_password_provider_rest_auth_registration_enforce_lowercase }}
  526. profile:
  527. name: {{ matrix_synapse_ext_password_provider_rest_auth_registration_profile_name_autofill }}
  528. login:
  529. profile:
  530. name: {{ matrix_synapse_ext_password_provider_rest_auth_login_profile_name_autofill }}
  531. {% endif %}
  532. {% if matrix_synapse_ext_password_provider_ldap_enabled %}
  533. - module: "ldap_auth_provider.LdapAuthProvider"
  534. config:
  535. enabled: true
  536. uri: {{ matrix_synapse_ext_password_provider_ldap_uri|to_json }}
  537. start_tls: {{ matrix_synapse_ext_password_provider_ldap_start_tls|to_json }}
  538. base: {{ matrix_synapse_ext_password_provider_ldap_base|to_json }}
  539. attributes:
  540. uid: {{ matrix_synapse_ext_password_provider_ldap_attributes_uid|to_json }}
  541. mail: {{ matrix_synapse_ext_password_provider_ldap_attributes_mail|to_json }}
  542. name: {{ matrix_synapse_ext_password_provider_ldap_attributes_name|to_json }}
  543. bind_dn: {{ matrix_synapse_ext_password_provider_ldap_bind_dn|to_json }}
  544. bind_password: {{ matrix_synapse_ext_password_provider_ldap_bind_password|to_json }}
  545. filter: {{ matrix_synapse_ext_password_provider_ldap_filter|to_json }}
  546. {% endif %}
  547. {% endif %}
  548. # Clients requesting push notifications can either have the body of
  549. # the message sent in the notification poke along with other details
  550. # like the sender, or just the event ID and room ID (`event_id_only`).
  551. # If clients choose the former, this option controls whether the
  552. # notification request includes the content of the event (other details
  553. # like the sender are still included). For `event_id_only` push, it
  554. # has no effect.
  555. # For modern android devices the notification content will still appear
  556. # because it is loaded by the app. iPhone, however will send a
  557. # notification saying only that a message arrived and who it came from.
  558. #
  559. #push:
  560. # include_content: true
  561. # spam_checker:
  562. # module: "my_custom_project.SuperSpamChecker"
  563. # config:
  564. # example_option: 'things'
  565. # Whether to allow non server admins to create groups on this server
  566. enable_group_creation: false
  567. # If enabled, non server admins can only create groups with local parts
  568. # starting with this prefix
  569. # group_creation_prefix: "unofficial/"
  570. # User Directory configuration
  571. #
  572. # 'search_all_users' defines whether to search all users visible to your HS
  573. # when searching the user directory, rather than limiting to users visible
  574. # in public rooms. Defaults to false. If you set it True, you'll have to run
  575. # UPDATE user_directory_stream_pos SET stream_id = NULL;
  576. # on your database to tell it to rebuild the user_directory search indexes.
  577. #
  578. #user_directory:
  579. # search_all_users: false
  580. # User Consent configuration
  581. #
  582. # for detailed instructions, see
  583. # https://github.com/matrix-org/synapse/blob/master/docs/consent_tracking.md
  584. #
  585. # Parts of this section are required if enabling the 'consent' resource under
  586. # 'listeners', in particular 'template_dir' and 'version'.
  587. #
  588. # 'template_dir' gives the location of the templates for the HTML forms.
  589. # This directory should contain one subdirectory per language (eg, 'en', 'fr'),
  590. # and each language directory should contain the policy document (named as
  591. # '<version>.html') and a success page (success.html).
  592. #
  593. # 'version' specifies the 'current' version of the policy document. It defines
  594. # the version to be served by the consent resource if there is no 'v'
  595. # parameter.
  596. #
  597. # 'server_notice_content', if enabled, will send a user a "Server Notice"
  598. # asking them to consent to the privacy policy. The 'server_notices' section
  599. # must also be configured for this to work. Notices will *not* be sent to
  600. # guest users unless 'send_server_notice_to_guests' is set to true.
  601. #
  602. # 'block_events_error', if set, will block any attempts to send events
  603. # until the user consents to the privacy policy. The value of the setting is
  604. # used as the text of the error.
  605. #
  606. # 'require_at_registration', if enabled, will add a step to the registration
  607. # process, similar to how captcha works. Users will be required to accept the
  608. # policy before their account is created.
  609. #
  610. # 'policy_name' is the display name of the policy users will see when registering
  611. # for an account. Has no effect unless `require_at_registration` is enabled.
  612. # Defaults to "Privacy Policy".
  613. #
  614. # user_consent:
  615. # template_dir: res/templates/privacy
  616. # version: 1.0
  617. # server_notice_content:
  618. # msgtype: m.text
  619. # body: >-
  620. # To continue using this homeserver you must review and agree to the
  621. # terms and conditions at %(consent_uri)s
  622. # send_server_notice_to_guests: True
  623. # block_events_error: >-
  624. # To continue using this homeserver you must review and agree to the
  625. # terms and conditions at %(consent_uri)s
  626. # require_at_registration: False
  627. # policy_name: Privacy Policy
  628. #
  629. # Server Notices room configuration
  630. #
  631. # Uncomment this section to enable a room which can be used to send notices
  632. # from the server to users. It is a special room which cannot be left; notices
  633. # come from a special "notices" user id.
  634. #
  635. # If you uncomment this section, you *must* define the system_mxid_localpart
  636. # setting, which defines the id of the user which will be used to send the
  637. # notices.
  638. #
  639. # It's also possible to override the room name, the display name of the
  640. # "notices" user, and the avatar for the user.
  641. #
  642. # server_notices:
  643. # system_mxid_localpart: notices
  644. # system_mxid_display_name: "Server Notices"
  645. # system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
  646. # room_name: "Server Notices"
  647. # The `alias_creation` option controls who's allowed to create aliases
  648. # on this server.
  649. #
  650. # The format of this option is a list of rules that contain globs that
  651. # match against user_id and the new alias (fully qualified with server
  652. # name). The action in the first rule that matches is taken, which can
  653. # currently either be "allow" or "deny".
  654. #
  655. # If no rules match the request is denied.
  656. alias_creation_rules:
  657. - user_id: "*"
  658. alias: "*"
  659. action: allow