Matrix Docker Ansible eploy
25'ten fazla konu seçemezsiniz Konular bir harf veya rakamla başlamalı, kısa çizgiler ('-') içerebilir ve en fazla 35 karakter uzunluğunda olabilir.
 
 

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