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.
 
 

1701 lines
59 KiB

  1. {#
  2. SPDX-FileCopyrightText: 2025 MDAD project contributors
  3. SPDX-FileCopyrightText: 2025 Slavi Pantaleev
  4. SPDX-FileCopyrightText: 2025 Suguru Hirahara
  5. SPDX-License-Identifier: AGPL-3.0-or-later
  6. #}
  7. ### continuwuity Configuration
  8. ### For more information, see:
  9. ### https://continuwuity.org/configuration.html
  10. [global]
  11. # The server_name is the pretty name of this server. It is used as a
  12. # suffix for user and room IDs/aliases.
  13. #
  14. # See the docs for reverse proxying and delegation:
  15. # https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy
  16. #
  17. # Also see the `[global.well_known]` config section at the very bottom.
  18. #
  19. # Examples of delegation:
  20. # - https://puppygock.gay/.well-known/matrix/server
  21. # - https://puppygock.gay/.well-known/matrix/client
  22. #
  23. # YOU NEED TO EDIT THIS. THIS CANNOT BE CHANGED AFTER WITHOUT A DATABASE
  24. # WIPE.
  25. #
  26. # example: "continuwuity.org"
  27. #
  28. server_name = {{ matrix_continuwuity_config_server_name | to_json }}
  29. # The default address (IPv4 or IPv6) continuwuity will listen on.
  30. #
  31. # If you are using Docker or a container NAT networking setup, this must
  32. # be "0.0.0.0".
  33. #
  34. # To listen on multiple addresses, specify a vector e.g. ["127.0.0.1",
  35. # "::1"]
  36. #
  37. address = "0.0.0.0"
  38. # The port(s) continuwuity will listen on.
  39. #
  40. # For reverse proxying, see:
  41. # https://continuwuity.org/deploying/generic.html#setting-up-the-reverse-proxy
  42. #
  43. # If you are using Docker, don't change this, you'll need to map an
  44. # external port to this.
  45. #
  46. # To listen on multiple ports, specify a vector e.g. [8080, 8448]
  47. #
  48. port = {{ matrix_continuwuity_config_port_number }}
  49. # The UNIX socket continuwuity will listen on.
  50. #
  51. # continuwuity cannot listen on both an IP address and a UNIX socket. If
  52. # listening on a UNIX socket, you MUST remove/comment the `address` key.
  53. #
  54. # Remember to make sure that your reverse proxy has access to this socket
  55. # file, either by adding your reverse proxy to the appropriate user group
  56. # or granting world R/W permissions with `unix_socket_perms` (666
  57. # minimum).
  58. #
  59. # example: "/run/continuwuity/continuwuity.sock"
  60. #
  61. #unix_socket_path =
  62. # The default permissions (in octal) to create the UNIX socket with.
  63. #
  64. #unix_socket_perms = 660
  65. # This is the only directory where continuwuity will save its data,
  66. # including media. Note: this was previously "/var/lib/matrix-conduit".
  67. #
  68. # YOU NEED TO EDIT THIS.
  69. #
  70. # example: "/var/lib/continuwuity"
  71. #
  72. database_path = "/var/lib/continuwuity"
  73. # continuwuity supports online database backups using RocksDB's Backup
  74. # engine API. To use this, set a database backup path that continuwuity
  75. # can write to.
  76. #
  77. # For more information, see:
  78. # https://continuwuity.org/maintenance.html#backups
  79. #
  80. # example: "/opt/continuwuity-db-backups"
  81. #
  82. #database_backup_path =
  83. # The amount of online RocksDB database backups to keep/retain, if using
  84. # "database_backup_path", before deleting the oldest one.
  85. #
  86. #database_backups_to_keep = 1
  87. # Text which will be added to the end of the user's displayname upon
  88. # registration with a space before the text. In Conduit, this was the
  89. # lightning bolt emoji.
  90. #
  91. # To disable, set this to "" (an empty string).
  92. #
  93. # The default is the trans pride flag.
  94. #
  95. # example: "🏳️‍⚧️"
  96. #
  97. new_user_displayname_suffix = {{ matrix_continuwuity_config_new_user_displayname_suffix | to_json }}
  98. # If enabled, continuwuity will send a simple GET request periodically to
  99. # `https://continuwuity.org/.well-known/continuwuity/announcements` for any new
  100. # announcements or major updates. This is not an update check endpoint.
  101. #
  102. allow_check_for_updates = {{ matrix_continuwuity_config_allow_check_for_updates | to_json }}
  103. # Set this to any float value to multiply continuwuity's in-memory LRU
  104. # caches with such as "auth_chain_cache_capacity".
  105. #
  106. # May be useful if you have significant memory to spare to increase
  107. # performance.
  108. #
  109. # If you have low memory, reducing this may be viable.
  110. #
  111. # By default, the individual caches such as "auth_chain_cache_capacity"
  112. # are scaled by your CPU core count.
  113. #
  114. #cache_capacity_modifier = 1.0
  115. # Set this to any float value in megabytes for continuwuity to tell the
  116. # database engine that this much memory is available for database read
  117. # caches.
  118. #
  119. # May be useful if you have significant memory to spare to increase
  120. # performance.
  121. #
  122. # Similar to the individual LRU caches, this is scaled up with your CPU
  123. # core count.
  124. #
  125. # This defaults to 128.0 + (64.0 * CPU core count).
  126. #
  127. #db_cache_capacity_mb = varies by system
  128. # Set this to any float value in megabytes for continuwuity to tell the
  129. # database engine that this much memory is available for database write
  130. # caches.
  131. #
  132. # May be useful if you have significant memory to spare to increase
  133. # performance.
  134. #
  135. # Similar to the individual LRU caches, this is scaled up with your CPU
  136. # core count.
  137. #
  138. # This defaults to 48.0 + (4.0 * CPU core count).
  139. #
  140. #db_write_buffer_capacity_mb = varies by system
  141. # This item is undocumented. Please contribute documentation for it.
  142. #
  143. #pdu_cache_capacity = varies by system
  144. # This item is undocumented. Please contribute documentation for it.
  145. #
  146. #auth_chain_cache_capacity = varies by system
  147. # This item is undocumented. Please contribute documentation for it.
  148. #
  149. #shorteventid_cache_capacity = varies by system
  150. # This item is undocumented. Please contribute documentation for it.
  151. #
  152. #eventidshort_cache_capacity = varies by system
  153. # This item is undocumented. Please contribute documentation for it.
  154. #
  155. #eventid_pdu_cache_capacity = varies by system
  156. # This item is undocumented. Please contribute documentation for it.
  157. #
  158. #shortstatekey_cache_capacity = varies by system
  159. # This item is undocumented. Please contribute documentation for it.
  160. #
  161. #statekeyshort_cache_capacity = varies by system
  162. # This item is undocumented. Please contribute documentation for it.
  163. #
  164. #servernameevent_data_cache_capacity = varies by system
  165. # This item is undocumented. Please contribute documentation for it.
  166. #
  167. #stateinfo_cache_capacity = varies by system
  168. # This item is undocumented. Please contribute documentation for it.
  169. #
  170. #roomid_spacehierarchy_cache_capacity = varies by system
  171. # Maximum entries stored in DNS memory-cache. The size of an entry may
  172. # vary so please take care if raising this value excessively. Only
  173. # decrease this when using an external DNS cache. Please note that
  174. # systemd-resolved does *not* count as an external cache, even when
  175. # configured to do so.
  176. #
  177. #dns_cache_entries = 32768
  178. # Minimum time-to-live in seconds for entries in the DNS cache. The
  179. # default may appear high to most administrators; this is by design as the
  180. # majority of NXDOMAINs are correct for a long time (e.g. the server is no
  181. # longer running Matrix). Only decrease this if you are using an external
  182. # DNS cache.
  183. #
  184. #dns_min_ttl = 10800
  185. # Minimum time-to-live in seconds for NXDOMAIN entries in the DNS cache.
  186. # This value is critical for the server to federate efficiently.
  187. # NXDOMAIN's are assumed to not be returning to the federation and
  188. # aggressively cached rather than constantly rechecked.
  189. #
  190. # Defaults to 3 days as these are *very rarely* false negatives.
  191. #
  192. #dns_min_ttl_nxdomain = 259200
  193. # Number of DNS nameserver retries after a timeout or error.
  194. #
  195. #dns_attempts = 10
  196. # The number of seconds to wait for a reply to a DNS query. Please note
  197. # that recursive queries can take up to several seconds for some domains,
  198. # so this value should not be too low, especially on slower hardware or
  199. # resolvers.
  200. #
  201. #dns_timeout = 10
  202. # Fallback to TCP on DNS errors. Set this to false if unsupported by
  203. # nameserver.
  204. #
  205. #dns_tcp_fallback = true
  206. # Enable to query all nameservers until the domain is found. Referred to
  207. # as "trust_negative_responses" in hickory_resolver. This can avoid
  208. # useless DNS queries if the first nameserver responds with NXDOMAIN or
  209. # an empty NOERROR response.
  210. #
  211. #query_all_nameservers = true
  212. # Enable using *only* TCP for querying your specified nameservers instead
  213. # of UDP.
  214. #
  215. # If you are running continuwuity in a container environment, this config
  216. # option may need to be enabled. For more details, see:
  217. # https://continuwuity.org/troubleshooting.html#potential-dns-issues-when-using-docker
  218. #
  219. #query_over_tcp_only = false
  220. # DNS A/AAAA record lookup strategy
  221. #
  222. # Takes a number of one of the following options:
  223. # 1 - Ipv4Only (Only query for A records, no AAAA/IPv6)
  224. #
  225. # 2 - Ipv6Only (Only query for AAAA records, no A/IPv4)
  226. #
  227. # 3 - Ipv4AndIpv6 (Query for A and AAAA records in parallel, uses whatever
  228. # returns a successful response first)
  229. #
  230. # 4 - Ipv6thenIpv4 (Query for AAAA record, if that fails then query the A
  231. # record)
  232. #
  233. # 5 - Ipv4thenIpv6 (Query for A record, if that fails then query the AAAA
  234. # record)
  235. #
  236. # If you don't have IPv6 networking, then for better DNS performance it
  237. # may be suitable to set this to Ipv4Only (1) as you will never ever use
  238. # the AAAA record contents even if the AAAA record is successful instead
  239. # of the A record.
  240. #
  241. #ip_lookup_strategy = 5
  242. # Max request size for file uploads in bytes. Defaults to 20MB.
  243. #
  244. max_request_size = {{ matrix_continuwuity_config_max_request_size }}
  245. # This item is undocumented. Please contribute documentation for it.
  246. #
  247. #max_fetch_prev_events = 192
  248. # Default/base connection timeout (seconds). This is used only by URL
  249. # previews and update/news endpoint checks.
  250. #
  251. #request_conn_timeout = 10
  252. # Default/base request timeout (seconds). The time waiting to receive more
  253. # data from another server. This is used only by URL previews,
  254. # update/news, and misc endpoint checks.
  255. #
  256. #request_timeout = 35
  257. # Default/base request total timeout (seconds). The time limit for a whole
  258. # request. This is set very high to not cancel healthy requests while
  259. # serving as a backstop. This is used only by URL previews and update/news
  260. # endpoint checks.
  261. #
  262. #request_total_timeout = 320
  263. # Default/base idle connection pool timeout (seconds). This is used only
  264. # by URL previews and update/news endpoint checks.
  265. #
  266. #request_idle_timeout = 5
  267. # Default/base max idle connections per host. This is used only by URL
  268. # previews and update/news endpoint checks. Defaults to 1 as generally the
  269. # same open connection can be re-used.
  270. #
  271. #request_idle_per_host = 1
  272. # Federation well-known resolution connection timeout (seconds).
  273. #
  274. #well_known_conn_timeout = 6
  275. # Federation HTTP well-known resolution request timeout (seconds).
  276. #
  277. #well_known_timeout = 10
  278. # Federation client request timeout (seconds). You most definitely want
  279. # this to be high to account for extremely large room joins, slow
  280. # homeservers, your own resources etc.
  281. #
  282. #federation_timeout = 300
  283. # Federation client idle connection pool timeout (seconds).
  284. #
  285. #federation_idle_timeout = 25
  286. # Federation client max idle connections per host. Defaults to 1 as
  287. # generally the same open connection can be re-used.
  288. #
  289. #federation_idle_per_host = 1
  290. # Federation sender request timeout (seconds). The time it takes for the
  291. # remote server to process sent transactions can take a while.
  292. #
  293. #sender_timeout = 180
  294. # Federation sender idle connection pool timeout (seconds).
  295. #
  296. #sender_idle_timeout = 180
  297. # Federation sender transaction retry backoff limit (seconds).
  298. #
  299. #sender_retry_backoff_limit = 86400
  300. # Appservice URL request connection timeout. Defaults to 35 seconds as
  301. # generally appservices are hosted within the same network.
  302. #
  303. #appservice_timeout = 35
  304. # Appservice URL idle connection pool timeout (seconds).
  305. #
  306. #appservice_idle_timeout = 300
  307. # Notification gateway pusher idle connection pool timeout.
  308. #
  309. #pusher_idle_timeout = 15
  310. # Maximum time to receive a request from a client (seconds).
  311. #
  312. #client_receive_timeout = 75
  313. # Maximum time to process a request received from a client (seconds).
  314. #
  315. #client_request_timeout = 180
  316. # Maximum time to transmit a response to a client (seconds)
  317. #
  318. #client_response_timeout = 120
  319. # Grace period for clean shutdown of client requests (seconds).
  320. #
  321. #client_shutdown_timeout = 10
  322. # Grace period for clean shutdown of federation requests (seconds).
  323. #
  324. #sender_shutdown_timeout = 5
  325. # Enables registration. If set to false, no users can register on this
  326. # server.
  327. #
  328. # If set to true without a token configured, users can register with no
  329. # form of 2nd-step only if you set the following option to true:
  330. # `yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse`
  331. #
  332. # If you would like registration only via token reg, please configure
  333. # `registration_token` or `registration_token_file`.
  334. #
  335. allow_registration = {{ matrix_continuwuity_config_allow_registration | to_json }}
  336. # If registration is enabled, and this setting is true, new users
  337. # registered after the first admin user will be automatically suspended
  338. # and will require an admin to run `!admin users unsuspend <user_id>`.
  339. #
  340. # Suspended users are still able to read messages, make profile updates,
  341. # leave rooms, and deactivate their account, however cannot send messages,
  342. # invites, or create/join or otherwise modify rooms.
  343. # They are effectively read-only.
  344. #
  345. suspend_on_register = {{ matrix_continuwuity_config_suspend_on_register | to_json }}
  346. # Enabling this setting opens registration to anyone without restrictions.
  347. # This makes your server vulnerable to abuse
  348. #
  349. yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = {{ matrix_continuwuity_config_yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse | to_json }}
  350. # A static registration token that new users will have to provide when
  351. # creating an account. If unset and `allow_registration` is true,
  352. # you must set
  353. # `yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse`
  354. # to true to allow open registration without any conditions.
  355. #
  356. # YOU NEED TO EDIT THIS OR USE registration_token_file.
  357. #
  358. # example: "o&^uCtes4HPf0Vu@F20jQeeWE7"
  359. #
  360. registration_token = {{ matrix_continuwuity_config_registration_token | to_json }}
  361. # Path to a file on the system that gets read for additional registration
  362. # tokens. Multiple tokens can be added if you separate them with
  363. # whitespace
  364. #
  365. # continuwuity must be able to access the file, and it must not be empty
  366. #
  367. # example: "/etc/continuwuity/.reg_token"
  368. #
  369. #registration_token_file =
  370. # Controls whether encrypted rooms and events are allowed.
  371. #
  372. #allow_encryption = true
  373. # Controls whether federation is allowed or not. It is not recommended to
  374. # disable this after the fact due to potential federation breakage.
  375. #
  376. allow_federation = {{ matrix_continuwuity_config_allow_federation | to_json }}
  377. # Allows federation requests to be made to itself
  378. #
  379. # This isn't intended and is very likely a bug if federation requests are
  380. # being sent to yourself. This currently mainly exists for development
  381. # purposes.
  382. #
  383. #federation_loopback = false
  384. # Always calls /forget on behalf of the user if leaving a room. This is a
  385. # part of MSC4267 "Automatically forgetting rooms on leave"
  386. #
  387. #forget_forced_upon_leave = false
  388. # Set this to true to require authentication on the normally
  389. # unauthenticated profile retrieval endpoints (GET)
  390. # "/_matrix/client/v3/profile/{userId}".
  391. #
  392. # This can prevent profile scraping.
  393. #
  394. #require_auth_for_profile_requests = false
  395. # Set this to true to allow your server's public room directory to be
  396. # federated. Set this to false to protect against /publicRooms spiders,
  397. # but will forbid external users from viewing your server's public room
  398. # directory. If federation is disabled entirely (`allow_federation`), this
  399. # is inherently false.
  400. #
  401. #allow_public_room_directory_over_federation = false
  402. # Set this to true to allow your server's public room directory to be
  403. # queried without client authentication (access token) through the Client
  404. # APIs. Set this to false to protect against /publicRooms spiders.
  405. #
  406. #allow_public_room_directory_without_auth = false
  407. # Allow guests/unauthenticated users to access TURN credentials.
  408. #
  409. # This is the equivalent of Synapse's `turn_allow_guests` config option.
  410. # This allows any unauthenticated user to call the endpoint
  411. # `/_matrix/client/v3/voip/turnServer`.
  412. #
  413. # It is unlikely you need to enable this as all major clients support
  414. # authentication for this endpoint and prevents misuse of your TURN server
  415. # from potential bots.
  416. #
  417. #turn_allow_guests = false
  418. # Set this to true to lock down your server's public room directory and
  419. # only allow admins to publish rooms to the room directory. Unpublishing
  420. # is still allowed by all users with this enabled.
  421. #
  422. #lockdown_public_room_directory = false
  423. # Set this to true to allow federating device display names / allow
  424. # external users to see your device display name. If federation is
  425. # disabled entirely (`allow_federation`), this is inherently false. For
  426. # privacy reasons, this is best left disabled.
  427. #
  428. #allow_device_name_federation = false
  429. # Config option to allow or disallow incoming federation requests that
  430. # obtain the profiles of our local users from
  431. # `/_matrix/federation/v1/query/profile`
  432. #
  433. # Increases privacy of your local user's such as display names, but some
  434. # remote users may get a false "this user does not exist" error when they
  435. # try to invite you to a DM or room. Also can protect against profile
  436. # spiders.
  437. #
  438. # This is inherently false if `allow_federation` is disabled
  439. #
  440. #allow_inbound_profile_lookup_federation_requests = true
  441. # Allow standard users to create rooms. Appservices and admins are always
  442. # allowed to create rooms
  443. #
  444. #allow_room_creation = true
  445. # Set to false to disable users from joining or creating room versions
  446. # that aren't officially supported by continuwuity.
  447. #
  448. # continuwuity officially supports room versions 6 - 11.
  449. #
  450. # continuwuity has slightly experimental (though works fine in practice)
  451. # support for versions 3 - 5.
  452. #
  453. #allow_unstable_room_versions = true
  454. # Default room version continuwuity will create rooms with.
  455. #
  456. # Per spec, room version 11 is the default.
  457. #
  458. #default_room_version = 11
  459. # This item is undocumented. Please contribute documentation for it.
  460. #
  461. #allow_jaeger = false
  462. # This item is undocumented. Please contribute documentation for it.
  463. #
  464. #jaeger_filter = "info"
  465. # If the 'perf_measurements' compile-time feature is enabled, enables
  466. # collecting folded stack trace profile of tracing spans using
  467. # tracing_flame. The resulting profile can be visualized with inferno[1],
  468. # speedscope[2], or a number of other tools.
  469. #
  470. # [1]: https://github.com/jonhoo/inferno
  471. # [2]: www.speedscope.app
  472. #
  473. #tracing_flame = false
  474. # This item is undocumented. Please contribute documentation for it.
  475. #
  476. #tracing_flame_filter = "info"
  477. # This item is undocumented. Please contribute documentation for it.
  478. #
  479. #tracing_flame_output_path = "./tracing.folded"
  480. # Examples:
  481. #
  482. # - No proxy (default):
  483. #
  484. # proxy = "none"
  485. #
  486. # - For global proxy, create the section at the bottom of this file:
  487. #
  488. # [global.proxy]
  489. # global = { url = "socks5h://localhost:9050" }
  490. #
  491. # - To proxy some domains:
  492. #
  493. # [global.proxy]
  494. # [[global.proxy.by_domain]]
  495. # url = "socks5h://localhost:9050"
  496. # include = ["*.onion", "matrix.myspecial.onion"]
  497. # exclude = ["*.myspecial.onion"]
  498. #
  499. # Include vs. Exclude:
  500. #
  501. # - If include is an empty list, it is assumed to be `["*"]`.
  502. #
  503. # - If a domain matches both the exclude and include list, the proxy will
  504. # only be used if it was included because of a more specific rule than
  505. # it was excluded. In the above example, the proxy would be used for
  506. # `ordinary.onion`, `matrix.myspecial.onion`, but not
  507. # `hello.myspecial.onion`.
  508. #
  509. #proxy = "none"
  510. # Servers listed here will be used to gather public keys of other servers
  511. # (notary trusted key servers).
  512. #
  513. # Currently, continuwuity doesn't support inbound batched key requests, so
  514. # this list should only contain other Synapse servers.
  515. #
  516. # example: ["matrix.org", "tchncs.de"]
  517. #
  518. trusted_servers = {{ matrix_continuwuity_config_trusted_servers | to_json }}
  519. # Whether to query the servers listed in trusted_servers first or query
  520. # the origin server first. For best security, querying the origin server
  521. # first is advised to minimize the exposure to a compromised trusted
  522. # server. For maximum federation/join performance this can be set to true,
  523. # however other options exist to query trusted servers first under
  524. # specific high-load circumstances and should be evaluated before setting
  525. # this to true.
  526. #
  527. #query_trusted_key_servers_first = false
  528. # Whether to query the servers listed in trusted_servers first
  529. # specifically on room joins. This option limits the exposure to a
  530. # compromised trusted server to room joins only. The join operation
  531. # requires gathering keys from many origin servers which can cause
  532. # significant delays. Therefore this defaults to true to mitigate
  533. # unexpected delays out-of-the-box. The security-paranoid or those willing
  534. # to tolerate delays are advised to set this to false. Note that setting
  535. # query_trusted_key_servers_first to true causes this option to be
  536. # ignored.
  537. #
  538. #query_trusted_key_servers_first_on_join = true
  539. # Only query trusted servers for keys and never the origin server. This is
  540. # intended for clusters or custom deployments using their trusted_servers
  541. # as forwarding-agents to cache and deduplicate requests. Notary servers
  542. # do not act as forwarding-agents by default, therefore do not enable this
  543. # unless you know exactly what you are doing.
  544. #
  545. #only_query_trusted_key_servers = false
  546. # Maximum number of keys to request in each trusted server batch query.
  547. #
  548. #trusted_server_batch_size = 1024
  549. # Max log level for continuwuity. Allows debug, info, warn, or error.
  550. #
  551. # See also:
  552. # https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
  553. #
  554. # **Caveat**:
  555. # For release builds, the tracing crate is configured to only implement
  556. # levels higher than error to avoid unnecessary overhead in the compiled
  557. # binary from trace macros. For debug builds, this restriction is not
  558. # applied.
  559. #
  560. log = {{ matrix_continuwuity_config_log | to_json }}
  561. # Output logs with ANSI colours.
  562. #
  563. #log_colors = true
  564. # Configures the span events which will be outputted with the log.
  565. #
  566. #log_span_events = "none"
  567. # Configures whether CONTINUWUITY_LOG EnvFilter matches values using
  568. # regular expressions. See the tracing_subscriber documentation on
  569. # Directives.
  570. #
  571. #log_filter_regex = true
  572. # Toggles the display of ThreadId in tracing log output.
  573. #
  574. #log_thread_ids = false
  575. # OpenID token expiration/TTL in seconds.
  576. #
  577. # These are the OpenID tokens that are primarily used for Matrix account
  578. # integrations (e.g. Vector Integrations in Element), *not* OIDC/OpenID
  579. # Connect/etc.
  580. #
  581. #openid_token_ttl = 3600
  582. # Allow an existing session to mint a login token for another client.
  583. # This requires interactive authentication, but has security ramifications
  584. # as a malicious client could use the mechanism to spawn more than one
  585. # session.
  586. # Enabled by default.
  587. #
  588. #login_via_existing_session = true
  589. # Login token expiration/TTL in milliseconds.
  590. #
  591. # These are short-lived tokens for the m.login.token endpoint.
  592. # This is used to allow existing sessions to create new sessions.
  593. # see login_via_existing_session.
  594. #
  595. #login_token_ttl = 120000
  596. # Static TURN username to provide the client if not using a shared secret
  597. # ("turn_secret"), It is recommended to use a shared secret over static
  598. # credentials.
  599. #
  600. {% if matrix_continuwuity_config_turn_username != '' %}
  601. turn_username = {{ matrix_continuwuity_config_turn_username | to_json }}
  602. {% endif %}
  603. # Static TURN password to provide the client if not using a shared secret
  604. # ("turn_secret"). It is recommended to use a shared secret over static
  605. # credentials.
  606. #
  607. {% if matrix_continuwuity_config_turn_password != '' %}
  608. turn_password = {{ matrix_continuwuity_config_turn_password | to_json }}
  609. {% endif %}
  610. # Vector list of TURN URIs/servers to use.
  611. #
  612. # Replace "example.turn.uri" with your TURN domain, such as the coturn
  613. # "realm" config option. If using TURN over TLS, replace the URI prefix
  614. # "turn:" with "turns:".
  615. #
  616. # example: ["turn:example.turn.uri?transport=udp",
  617. # "turn:example.turn.uri?transport=tcp"]
  618. #
  619. turn_uris = {{ matrix_continuwuity_config_turn_uris | to_json }}
  620. # TURN secret to use for generating the HMAC-SHA1 hash apart of username
  621. # and password generation.
  622. #
  623. # This is more secure, but if needed you can use traditional static
  624. # username/password credentials.
  625. #
  626. {% if matrix_continuwuity_config_turn_secret != '' %}
  627. turn_secret = {{ matrix_continuwuity_config_turn_secret | to_json }}
  628. {% endif %}
  629. # TURN secret to use that's read from the file path specified.
  630. #
  631. # This takes priority over "turn_secret" first, and falls back to
  632. # "turn_secret" if invalid or failed to open.
  633. #
  634. # example: "/etc/continuwuity/.turn_secret"
  635. #
  636. #turn_secret_file =
  637. # TURN TTL, in seconds.
  638. #
  639. #turn_ttl = 86400
  640. # List/vector of room IDs or room aliases that continuwuity will make
  641. # newly registered users join. The rooms specified must be rooms that you
  642. # have joined at least once on the server, and must be public.
  643. #
  644. # example: ["#continuwuity:continuwuity.org",
  645. # "!main-1:continuwuity.org"]
  646. #
  647. #auto_join_rooms = []
  648. # Config option to automatically deactivate the account of any user who
  649. # attempts to join a:
  650. # - banned room
  651. # - forbidden room alias
  652. # - room alias or ID with a forbidden server name
  653. #
  654. # This may be useful if all your banned lists consist of toxic rooms or
  655. # servers that no good faith user would ever attempt to join, and
  656. # to automatically remediate the problem without any admin user
  657. # intervention.
  658. #
  659. # This will also make the user leave all rooms. Federation (e.g. remote
  660. # room invites) are ignored here.
  661. #
  662. # Defaults to false as rooms can be banned for non-moderation-related
  663. # reasons and this performs a full user deactivation.
  664. #
  665. #auto_deactivate_banned_room_attempts = false
  666. # RocksDB log level. This is not the same as continuwuity's log level.
  667. # This is the log level for the RocksDB engine/library which show up in
  668. # your database folder/path as `LOG` files. continuwuity will log RocksDB
  669. # errors as normal through tracing or panics if severe for safety.
  670. #
  671. #rocksdb_log_level = "error"
  672. # This item is undocumented. Please contribute documentation for it.
  673. #
  674. #rocksdb_log_stderr = false
  675. # Max RocksDB `LOG` file size before rotating in bytes. Defaults to 4MB in
  676. # bytes.
  677. #
  678. #rocksdb_max_log_file_size = 4194304
  679. # Time in seconds before RocksDB will forcibly rotate logs.
  680. #
  681. #rocksdb_log_time_to_roll = 0
  682. # Set this to true to use RocksDB config options that are tailored to HDDs
  683. # (slower device storage).
  684. #
  685. # It is worth noting that by default, continuwuity will use RocksDB with
  686. # Direct IO enabled. *Generally* speaking this improves performance as it
  687. # bypasses buffered I/O (system page cache). However there is a potential
  688. # chance that Direct IO may cause issues with database operations if your
  689. # setup is uncommon. This has been observed with FUSE filesystems, and
  690. # possibly ZFS filesystem. RocksDB generally deals/corrects these issues
  691. # but it cannot account for all setups. If you experience any weird
  692. # RocksDB issues, try enabling this option as it turns off Direct IO and
  693. # feel free to report in the continuwuity Matrix room if this option fixes
  694. # your DB issues.
  695. #
  696. # For more information, see:
  697. # https://github.com/facebook/rocksdb/wiki/Direct-IO
  698. #
  699. #rocksdb_optimize_for_spinning_disks = false
  700. # Enables direct-io to increase database performance via unbuffered I/O.
  701. #
  702. # For more details about direct I/O and RockDB, see:
  703. # https://github.com/facebook/rocksdb/wiki/Direct-IO
  704. #
  705. # Set this option to false if the database resides on a filesystem which
  706. # does not support direct-io like FUSE, or any form of complex filesystem
  707. # setup such as possibly ZFS.
  708. #
  709. #rocksdb_direct_io = true
  710. # Amount of threads that RocksDB will use for parallelism on database
  711. # operations such as cleanup, sync, flush, compaction, etc. Set to 0 to
  712. # use all your logical threads. Defaults to your CPU logical thread count.
  713. #
  714. #rocksdb_parallelism_threads = varies by system
  715. # Maximum number of LOG files RocksDB will keep. This must *not* be set to
  716. # 0. It must be at least 1. Defaults to 3 as these are not very useful
  717. # unless troubleshooting/debugging a RocksDB bug.
  718. #
  719. #rocksdb_max_log_files = 3
  720. # Type of RocksDB database compression to use.
  721. #
  722. # Available options are "zstd", "bz2", "lz4", or "none".
  723. #
  724. # It is best to use ZSTD as an overall good balance between
  725. # speed/performance, storage, IO amplification, and CPU usage. For more
  726. # performance but less compression (more storage used) and less CPU usage,
  727. # use LZ4.
  728. #
  729. # For more details, see:
  730. # https://github.com/facebook/rocksdb/wiki/Compression
  731. #
  732. # "none" will disable compression.
  733. #
  734. #rocksdb_compression_algo = "zstd"
  735. # Level of compression the specified compression algorithm for RocksDB to
  736. # use.
  737. #
  738. # Default is 32767, which is internally read by RocksDB as the default
  739. # magic number and translated to the library's default compression level
  740. # as they all differ. See their `kDefaultCompressionLevel`.
  741. #
  742. # Note when using the default value we may override it with a setting
  743. # tailored specifically for continuwuity.
  744. #
  745. #rocksdb_compression_level = 32767
  746. # Level of compression the specified compression algorithm for the
  747. # bottommost level/data for RocksDB to use. Default is 32767, which is
  748. # internally read by RocksDB as the default magic number and translated to
  749. # the library's default compression level as they all differ. See their
  750. # `kDefaultCompressionLevel`.
  751. #
  752. # Since this is the bottommost level (generally old and least used data),
  753. # it may be desirable to have a very high compression level here as it's
  754. # less likely for this data to be used. Research your chosen compression
  755. # algorithm.
  756. #
  757. # Note when using the default value we may override it with a setting
  758. # tailored specifically for continuwuity.
  759. #
  760. #rocksdb_bottommost_compression_level = 32767
  761. # Whether to enable RocksDB's "bottommost_compression".
  762. #
  763. # At the expense of more CPU usage, this will further compress the
  764. # database to reduce more storage. It is recommended to use ZSTD
  765. # compression with this for best compression results. This may be useful
  766. # if you're trying to reduce storage usage from the database.
  767. #
  768. # See https://github.com/facebook/rocksdb/wiki/Compression for more details.
  769. #
  770. #rocksdb_bottommost_compression = true
  771. # Database recovery mode (for RocksDB WAL corruption).
  772. #
  773. # Use this option when the server reports corruption and refuses to start.
  774. # Set mode 2 (PointInTime) to cleanly recover from this corruption. The
  775. # server will continue from the last good state, several seconds or
  776. # minutes prior to the crash. Clients may have to run "clear-cache &
  777. # reload" to account for the rollback. Upon success, you may reset the
  778. # mode back to default and restart again. Please note in some cases the
  779. # corruption error may not be cleared for at least 30 minutes of operation
  780. # in PointInTime mode.
  781. #
  782. # As a very last ditch effort, if PointInTime does not fix or resolve
  783. # anything, you can try mode 3 (SkipAnyCorruptedRecord) but this will
  784. # leave the server in a potentially inconsistent state.
  785. #
  786. # The default mode 1 (TolerateCorruptedTailRecords) will automatically
  787. # drop the last entry in the database if corrupted during shutdown, but
  788. # nothing more. It is extraordinarily unlikely this will desynchronize
  789. # clients. To disable any form of silent rollback set mode 0
  790. # (AbsoluteConsistency).
  791. #
  792. # The options are:
  793. # 0 = AbsoluteConsistency
  794. # 1 = TolerateCorruptedTailRecords (default)
  795. # 2 = PointInTime (use me if trying to recover)
  796. # 3 = SkipAnyCorruptedRecord (you now voided your Continuwuity warranty)
  797. #
  798. # For more information on these modes, see:
  799. # https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes
  800. #
  801. # For more details on recovering a corrupt database, see:
  802. # https://continuwuity.org/troubleshooting.html#database-corruption
  803. #
  804. #rocksdb_recovery_mode = 1
  805. # Enables or disables paranoid SST file checks. This can improve RocksDB
  806. # database consistency at a potential performance impact due to further
  807. # safety checks ran.
  808. #
  809. # For more information, see:
  810. # https://github.com/facebook/rocksdb/wiki/Online-Verification#columnfamilyoptionsparanoid_file_checks
  811. #
  812. #rocksdb_paranoid_file_checks = false
  813. # Enables or disables checksum verification in rocksdb at runtime.
  814. # Checksums are usually hardware accelerated with low overhead; they are
  815. # enabled in rocksdb by default. Older or slower platforms may see gains
  816. # from disabling.
  817. #
  818. #rocksdb_checksums = true
  819. # Enables the "atomic flush" mode in rocksdb. This option is not intended
  820. # for users. It may be removed or ignored in future versions. Atomic flush
  821. # may be enabled by the paranoid to possibly improve database integrity at
  822. # the cost of performance.
  823. #
  824. #rocksdb_atomic_flush = false
  825. # Database repair mode (for RocksDB SST corruption).
  826. #
  827. # Use this option when the server reports corruption while running or
  828. # panics. If the server refuses to start use the recovery mode options
  829. # first. Corruption errors containing the acronym 'SST' which occur after
  830. # startup will likely require this option.
  831. #
  832. # - Backing up your database directory is recommended prior to running the
  833. # repair.
  834. #
  835. # - Disabling repair mode and restarting the server is recommended after
  836. # running the repair.
  837. #
  838. # See https://continuwuity.org/troubleshooting.html#database-corruption for more details on recovering a corrupt database.
  839. #
  840. #rocksdb_repair = false
  841. # This item is undocumented. Please contribute documentation for it.
  842. #
  843. #rocksdb_read_only = false
  844. # This item is undocumented. Please contribute documentation for it.
  845. #
  846. #rocksdb_secondary = false
  847. # Enables idle CPU priority for compaction thread. This is not enabled by
  848. # default to prevent compaction from falling too far behind on busy
  849. # systems.
  850. #
  851. #rocksdb_compaction_prio_idle = false
  852. # Enables idle IO priority for compaction thread. This prevents any
  853. # unexpected lag in the server's operation and is usually a good idea.
  854. # Enabled by default.
  855. #
  856. #rocksdb_compaction_ioprio_idle = true
  857. # Enables RocksDB compaction. You should never ever have to set this
  858. # option to false. If you for some reason find yourself needing to use
  859. # this option as part of troubleshooting or a bug, please reach out to us
  860. # in the continuwuity Matrix room with information and details.
  861. #
  862. # Disabling compaction will lead to a significantly bloated and
  863. # explosively large database, gradually poor performance, unnecessarily
  864. # excessive disk read/writes, and slower shutdowns and startups.
  865. #
  866. #rocksdb_compaction = true
  867. # Level of statistics collection. Some admin commands to display database
  868. # statistics may require this option to be set. Database performance may
  869. # be impacted by higher settings.
  870. #
  871. # Option is a number ranging from 0 to 6:
  872. # 0 = No statistics.
  873. # 1 = No statistics in release mode (default).
  874. # 2 to 3 = Statistics with no performance impact.
  875. # 3 to 5 = Statistics with possible performance impact.
  876. # 6 = All statistics.
  877. #
  878. #rocksdb_stats_level = 1
  879. # This is a password that can be configured that will let you login to the
  880. # server bot account (currently `@conduit`) for emergency troubleshooting
  881. # purposes such as recovering/recreating your admin room, or inviting
  882. # yourself back.
  883. #
  884. # See https://continuwuity.org/troubleshooting.html#lost-access-to-admin-room for other ways to get back into your admin room.
  885. #
  886. # Once this password is unset, all sessions will be logged out for
  887. # security purposes.
  888. #
  889. # example: "F670$2CP@Hw8mG7RY1$%!#Ic7YA"
  890. #
  891. {% if matrix_continuwuity_config_emergency_password != '' %}
  892. emergency_password = {{ matrix_continuwuity_config_emergency_password | to_json }}
  893. {% endif %}
  894. # This item is undocumented. Please contribute documentation for it.
  895. #
  896. #notification_push_path = "/_matrix/push/v1/notify"
  897. # Allow local (your server only) presence updates/requests.
  898. #
  899. # Note that presence on continuwuity is very fast unlike Synapse's. If
  900. # using outgoing presence, this MUST be enabled.
  901. #
  902. #allow_local_presence = true
  903. # Allow incoming federated presence updates/requests.
  904. #
  905. # This option receives presence updates from other servers, but does not
  906. # send any unless `allow_outgoing_presence` is true. Note that presence on
  907. # continuwuity is very fast unlike Synapse's.
  908. #
  909. #allow_incoming_presence = true
  910. # Allow outgoing presence updates/requests.
  911. #
  912. # This option sends presence updates to other servers, but does not
  913. # receive any unless `allow_incoming_presence` is true. Note that presence
  914. # on continuwuity is very fast unlike Synapse's. If using outgoing
  915. # presence, you MUST enable `allow_local_presence` as well.
  916. #
  917. #allow_outgoing_presence = true
  918. # How many seconds without presence updates before you become idle.
  919. # Defaults to 5 minutes.
  920. #
  921. #presence_idle_timeout_s = 300
  922. # How many seconds without presence updates before you become offline.
  923. # Defaults to 30 minutes.
  924. #
  925. #presence_offline_timeout_s = 1800
  926. # Enable the presence idle timer for remote users.
  927. #
  928. # Disabling is offered as an optimization for servers participating in
  929. # many large rooms or when resources are limited. Disabling it may cause
  930. # incorrect presence states (i.e. stuck online) to be seen for some remote
  931. # users.
  932. #
  933. #presence_timeout_remote_users = true
  934. # Allow receiving incoming read receipts from remote servers.
  935. #
  936. #allow_incoming_read_receipts = true
  937. # Allow sending read receipts to remote servers.
  938. #
  939. #allow_outgoing_read_receipts = true
  940. # Allow outgoing typing updates to federation.
  941. #
  942. #allow_outgoing_typing = true
  943. # Allow incoming typing updates from federation.
  944. #
  945. #allow_incoming_typing = true
  946. # Maximum time federation user can indicate typing.
  947. #
  948. #typing_federation_timeout_s = 30
  949. # Minimum time local client can indicate typing. This does not override a
  950. # client's request to stop typing. It only enforces a minimum value in
  951. # case of no stop request.
  952. #
  953. #typing_client_timeout_min_s = 15
  954. # Maximum time local client can indicate typing.
  955. #
  956. #typing_client_timeout_max_s = 45
  957. # Set this to true for continuwuity to compress HTTP response bodies using
  958. # zstd. This option does nothing if continuwuity was not built with
  959. # `zstd_compression` feature. Please be aware that enabling HTTP
  960. # compression may weaken TLS. Most users should not need to enable this.
  961. # See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
  962. # before deciding to enable this.
  963. #
  964. #zstd_compression = false
  965. # Set this to true for continuwuity to compress HTTP response bodies using
  966. # gzip. This option does nothing if continuwuity was not built with
  967. # `gzip_compression` feature. Please be aware that enabling HTTP
  968. # compression may weaken TLS. Most users should not need to enable this.
  969. # See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before
  970. # deciding to enable this.
  971. #
  972. # If you are in a large amount of rooms, you may find that enabling this
  973. # is necessary to reduce the significantly large response bodies.
  974. #
  975. #gzip_compression = false
  976. # Set this to true for continuwuity to compress HTTP response bodies using
  977. # brotli. This option does nothing if continuwuity was not built with
  978. # `brotli_compression` feature. Please be aware that enabling HTTP
  979. # compression may weaken TLS. Most users should not need to enable this.
  980. # See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH
  981. # before deciding to enable this.
  982. #
  983. #brotli_compression = false
  984. # Set to true to allow user type "guest" registrations. Some clients like
  985. # Element attempt to register guest users automatically.
  986. #
  987. #allow_guest_registration = false
  988. # Set to true to log guest registrations in the admin room. Note that
  989. # these may be noisy or unnecessary if you're a public homeserver.
  990. #
  991. #log_guest_registrations = false
  992. # Set to true to allow guest registrations/users to auto join any rooms
  993. # specified in `auto_join_rooms`.
  994. #
  995. #allow_guests_auto_join_rooms = false
  996. # Enable the legacy unauthenticated Matrix media repository endpoints.
  997. # These endpoints consist of:
  998. # - /_matrix/media/*/config
  999. # - /_matrix/media/*/upload
  1000. # - /_matrix/media/*/preview_url
  1001. # - /_matrix/media/*/download/*
  1002. # - /_matrix/media/*/thumbnail/*
  1003. #
  1004. # The authenticated equivalent endpoints are always enabled.
  1005. #
  1006. # Defaults to true for now, but this is highly subject to change, likely
  1007. # in the next release.
  1008. #
  1009. #allow_legacy_media = true
  1010. # This item is undocumented. Please contribute documentation for it.
  1011. #
  1012. #freeze_legacy_media = true
  1013. # Check consistency of the media directory at startup:
  1014. # 1. When `media_compat_file_link` is enabled, this check will upgrade
  1015. # media when switching back and forth between Conduit and conduwuit.
  1016. # Both options must be enabled to handle this.
  1017. # 2. When media is deleted from the directory, this check will also delete
  1018. # its database entry.
  1019. #
  1020. # If none of these checks apply to your use cases, and your media
  1021. # directory is significantly large setting this to false may reduce
  1022. # startup time.
  1023. #
  1024. #media_startup_check = true
  1025. # Enable backward-compatibility with Conduit's media directory by creating
  1026. # symlinks of media.
  1027. #
  1028. # This option is only necessary if you plan on using Conduit again.
  1029. # Otherwise setting this to false reduces filesystem clutter and overhead
  1030. # for managing these symlinks in the directory. This is now disabled by
  1031. # default. You may still return to upstream Conduit but you have to run
  1032. # continuwuity at least once with this set to true and allow the
  1033. # media_startup_check to take place before shutting down to return to
  1034. # Conduit.
  1035. #
  1036. #media_compat_file_link = false
  1037. # Prune missing media from the database as part of the media startup
  1038. # checks.
  1039. #
  1040. # This means if you delete files from the media directory the
  1041. # corresponding entries will be removed from the database. This is
  1042. # disabled by default because if the media directory is accidentally moved
  1043. # or inaccessible, the metadata entries in the database will be lost with
  1044. # sadness.
  1045. #
  1046. #prune_missing_media = false
  1047. # List of forbidden server names via regex patterns that we will block
  1048. # incoming AND outgoing federation with, and block client room joins /
  1049. # remote user invites.
  1050. #
  1051. # Note that your messages can still make it to forbidden servers through
  1052. # backfilling. Events we receive from forbidden servers via backfill
  1053. # from servers we *do* federate with will be stored in the database.
  1054. #
  1055. # This check is applied on the room ID, room alias, sender server name,
  1056. # sender user's server name, inbound federation X-Matrix origin, and
  1057. # outbound federation handler.
  1058. #
  1059. # You can set this to ["*"] to block all servers by default, and then
  1060. # use `allowed_remote_server_names` to allow only specific servers.
  1061. #
  1062. # example: ["badserver\\.tld$", "badphrase", "19dollarfortnitecards"]
  1063. #
  1064. forbidden_remote_server_names = {{ matrix_continuwuity_config_forbidden_remote_server_names | to_json }}
  1065. # List of allowed server names via regex patterns that we will allow,
  1066. # regardless of if they match `forbidden_remote_server_names`.
  1067. #
  1068. # This option has no effect if `forbidden_remote_server_names` is empty.
  1069. #
  1070. # example: ["goodserver\\.tld$", "goodphrase"]
  1071. #
  1072. allowed_remote_server_names = {{ matrix_continuwuity_config_allowed_remote_server_names | to_json }}
  1073. # Vector list of regex patterns of server names that continuwuity will
  1074. # refuse to download remote media from.
  1075. #
  1076. # example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
  1077. #
  1078. prevent_media_downloads_from = {{ matrix_continuwuity_config_prevent_media_downloads_from | to_json }}
  1079. # List of forbidden server names via regex patterns that we will block all
  1080. # outgoing federated room directory requests for. Useful for preventing
  1081. # our users from wandering into bad servers or spaces.
  1082. #
  1083. # example: ["badserver\.tld$", "badphrase", "19dollarfortnitecards"]
  1084. #
  1085. forbidden_remote_room_directory_server_names = {{ matrix_continuwuity_config_forbidden_remote_room_directory_server_names | to_json }}
  1086. # Vector list of regex patterns of server names that continuwuity will not
  1087. # send messages to the client from.
  1088. #
  1089. # Note that there is no way for clients to receive messages once a server
  1090. # has become unignored without doing a full sync. This is a protocol
  1091. # limitation with the current sync protocols. This means this is somewhat
  1092. # of a nuclear option.
  1093. #
  1094. # example: ["reallybadserver\.tld$", "reallybadphrase",
  1095. # "69dollarfortnitecards"]
  1096. #
  1097. ignore_messages_from_server_names = {{ matrix_continuwuity_config_ignore_messages_from_server_names | to_json }}
  1098. # Send messages from users that the user has ignored to the client.
  1099. #
  1100. # There is no way for clients to receive messages sent while a user was
  1101. # ignored without doing a full sync. This is a protocol limitation with
  1102. # the current sync protocols. Disabling this option will move
  1103. # responsibility of ignoring messages to the client, which can avoid this
  1104. # limitation.
  1105. #
  1106. #send_messages_from_ignored_users_to_client = false
  1107. # Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you
  1108. # do not want continuwuity to send outbound requests to. Defaults to
  1109. # RFC1918, unroutable, loopback, multicast, and testnet addresses for
  1110. # security.
  1111. #
  1112. # Please be aware that this is *not* a guarantee. You should be using a
  1113. # firewall with zones as doing this on the application layer may have
  1114. # bypasses.
  1115. #
  1116. # Currently this does not account for proxies in use like Synapse does.
  1117. #
  1118. # To disable, set this to be an empty vector (`[]`).
  1119. #
  1120. # Defaults to:
  1121. # ["127.0.0.0/8", "10.0.0.0/8", "172.16.0.0/12",
  1122. # "192.168.0.0/16", "100.64.0.0/10", "192.0.0.0/24", "169.254.0.0/16",
  1123. # "192.88.99.0/24", "198.18.0.0/15", "192.0.2.0/24", "198.51.100.0/24",
  1124. # "203.0.113.0/24", "224.0.0.0/4", "::1/128", "fe80::/10", "fc00::/7",
  1125. # "2001:db8::/32", "ff00::/8", "fec0::/10"]
  1126. #
  1127. #ip_range_denylist =
  1128. # Optional IP address or network interface-name to bind as the source of
  1129. # URL preview requests. If not set, it will not bind to a specific
  1130. # address or interface.
  1131. #
  1132. # Interface names only supported on Linux, Android, and Fuchsia platforms;
  1133. # all other platforms can specify the IP address. To list the interfaces
  1134. # on your system, use the command `ip link show`.
  1135. #
  1136. # example: `"eth0"` or `"1.2.3.4"`
  1137. #
  1138. #url_preview_bound_interface =
  1139. # Vector list of domains allowed to send requests to for URL previews.
  1140. #
  1141. # This is a *contains* match, not an explicit match. Putting "google.com"
  1142. # will match "https://google.com" and
  1143. # "http://mymaliciousdomainexamplegoogle.com" Setting this to "*" will
  1144. # allow all URL previews. Please note that this opens up significant
  1145. # attack surface to your server, you are expected to be aware of the risks
  1146. # by doing so.
  1147. #
  1148. url_preview_domain_contains_allowlist = {{ matrix_continuwuity_config_url_preview_domain_contains_allowlist | to_json }}
  1149. # Vector list of explicit domains allowed to send requests to for URL
  1150. # previews.
  1151. #
  1152. # This is an *explicit* match, not a contains match. Putting "google.com"
  1153. # will match "https://google.com", "http://google.com", but not
  1154. # "https://mymaliciousdomainexamplegoogle.com". Setting this to "*" will
  1155. # allow all URL previews. Please note that this opens up significant
  1156. # attack surface to your server, you are expected to be aware of the risks
  1157. # by doing so.
  1158. #
  1159. #url_preview_domain_explicit_allowlist = []
  1160. # Vector list of explicit domains not allowed to send requests to for URL
  1161. # previews.
  1162. #
  1163. # This is an *explicit* match, not a contains match. Putting "google.com"
  1164. # will match "https://google.com", "http://google.com", but not
  1165. # "https://mymaliciousdomainexamplegoogle.com". The denylist is checked
  1166. # first before allowlist. Setting this to "*" will not do anything.
  1167. #
  1168. #url_preview_domain_explicit_denylist = []
  1169. # Vector list of URLs allowed to send requests to for URL previews.
  1170. #
  1171. # Note that this is a *contains* match, not an explicit match. Putting
  1172. # "google.com" will match "https://google.com/",
  1173. # "https://google.com/url?q=https://mymaliciousdomainexample.com", and
  1174. # "https://mymaliciousdomainexample.com/hi/google.com" Setting this to "*"
  1175. # will allow all URL previews. Please note that this opens up significant
  1176. # attack surface to your server, you are expected to be aware of the risks
  1177. # by doing so.
  1178. #
  1179. #url_preview_url_contains_allowlist = []
  1180. # Maximum amount of bytes allowed in a URL preview body size when
  1181. # spidering. Defaults to 256KB in bytes.
  1182. #
  1183. #url_preview_max_spider_size = 256000
  1184. # Option to decide whether you would like to run the domain allowlist
  1185. # checks (contains and explicit) on the root domain or not. Does not apply
  1186. # to URL contains allowlist. Defaults to false.
  1187. #
  1188. # Example usecase: If this is enabled and you have "wikipedia.org" allowed
  1189. # in the explicit and/or contains domain allowlist, it will allow all
  1190. # subdomains under "wikipedia.org" such as "en.m.wikipedia.org" as the
  1191. # root domain is checked and matched. Useful if the domain contains
  1192. # allowlist is still too broad for you but you still want to allow all the
  1193. # subdomains under a root domain.
  1194. #
  1195. #url_preview_check_root_domain = false
  1196. # List of forbidden room aliases and room IDs as strings of regex
  1197. # patterns.
  1198. #
  1199. # Regex can be used or explicit contains matches can be done by just
  1200. # specifying the words (see example).
  1201. #
  1202. # This is checked upon room alias creation, custom room ID creation if
  1203. # used, and startup as warnings if any room aliases in your database have
  1204. # a forbidden room alias/ID.
  1205. #
  1206. # example: ["19dollarfortnitecards", "b[4a]droom", "badphrase"]
  1207. #
  1208. #forbidden_alias_names = []
  1209. # List of forbidden username patterns/strings.
  1210. #
  1211. # Regex can be used or explicit contains matches can be done by just
  1212. # specifying the words (see example).
  1213. #
  1214. # This is checked upon username availability check, registration, and
  1215. # startup as warnings if any local users in your database have a forbidden
  1216. # username.
  1217. #
  1218. # example: ["administrator", "b[a4]dusernam[3e]", "badphrase"]
  1219. #
  1220. #forbidden_usernames = []
  1221. # Retry failed and incomplete messages to remote servers immediately upon
  1222. # startup. This is called bursting. If this is disabled, said messages may
  1223. # not be delivered until more messages are queued for that server. Do not
  1224. # change this option unless server resources are extremely limited or the
  1225. # scale of the server's deployment is huge. Do not disable this unless you
  1226. # know what you are doing.
  1227. #
  1228. #startup_netburst = true
  1229. # Messages are dropped and not reattempted. The `startup_netburst` option
  1230. # must be enabled for this value to have any effect. Do not change this
  1231. # value unless you know what you are doing. Set this value to -1 to
  1232. # reattempt every message without trimming the queues; this may consume
  1233. # significant disk. Set this value to 0 to drop all messages without any
  1234. # attempt at redelivery.
  1235. #
  1236. #startup_netburst_keep = 50
  1237. # Block non-admin local users from sending room invites (local and
  1238. # remote), and block non-admin users from receiving remote room invites.
  1239. #
  1240. # Admins are always allowed to send and receive all room invites.
  1241. #
  1242. #block_non_admin_invites = false
  1243. # Allow admins to enter commands in rooms other than "#admins" (admin
  1244. # room) by prefixing your message with "\!admin" or "\\!admin" followed up
  1245. # a normal continuwuity admin command. The reply will be publicly visible
  1246. # to the room, originating from the sender.
  1247. #
  1248. # example: \\!admin debug ping puppygock.gay
  1249. #
  1250. #admin_escape_commands = true
  1251. # Automatically activate the continuwuity admin room console / CLI on
  1252. # startup. This option can also be enabled with `--console` continuwuity
  1253. # argument.
  1254. #
  1255. #admin_console_automatic = false
  1256. # List of admin commands to execute on startup.
  1257. #
  1258. # This option can also be configured with the `--execute` continuwuity
  1259. # argument and can take standard shell commands and environment variables
  1260. #
  1261. # For example: `./continuwuity --execute "server admin-notice continuwuity
  1262. # has started up at $(date)"`
  1263. #
  1264. # example: admin_execute = ["debug ping puppygock.gay", "debug echo hi"]`
  1265. #
  1266. #admin_execute = []
  1267. # Ignore errors in startup commands.
  1268. #
  1269. # If false, continuwuity will error and fail to start if an admin execute
  1270. # command (`--execute` / `admin_execute`) fails.
  1271. #
  1272. #admin_execute_errors_ignore = false
  1273. # List of admin commands to execute on SIGUSR2.
  1274. #
  1275. # Similar to admin_execute, but these commands are executed when the
  1276. # server receives SIGUSR2 on supporting platforms.
  1277. #
  1278. #admin_signal_execute = []
  1279. # Controls the max log level for admin command log captures (logs
  1280. # generated from running admin commands). Defaults to "info" on release
  1281. # builds, else "debug" on debug builds.
  1282. #
  1283. #admin_log_capture = "info"
  1284. # The default room tag to apply on the admin room.
  1285. #
  1286. # On some clients like Element, the room tag "m.server_notice" is a
  1287. # special pinned room at the very bottom of your room list. The
  1288. # continuwuity admin room can be pinned here so you always have an
  1289. # easy-to-access shortcut dedicated to your admin room.
  1290. #
  1291. #admin_room_tag = "m.server_notice"
  1292. # Sentry.io crash/panic reporting, performance monitoring/metrics, etc.
  1293. # This is NOT enabled by default.
  1294. #
  1295. #sentry = false
  1296. # Sentry reporting URL, if a custom one is desired.
  1297. #
  1298. #sentry_endpoint = ""
  1299. # Report your continuwuity server_name in Sentry.io crash reports and
  1300. # metrics.
  1301. #
  1302. #sentry_send_server_name = false
  1303. # Performance monitoring/tracing sample rate for Sentry.io.
  1304. #
  1305. # Note that too high values may impact performance, and can be disabled by
  1306. # setting it to 0.0 (0%) This value is read as a percentage to Sentry,
  1307. # represented as a decimal. Defaults to 15% of traces (0.15)
  1308. #
  1309. #sentry_traces_sample_rate = 0.15
  1310. # Whether to attach a stacktrace to Sentry reports.
  1311. #
  1312. #sentry_attach_stacktrace = false
  1313. # Send panics to Sentry. This is true by default, but Sentry has to be
  1314. # enabled. The global `sentry` config option must be enabled to send any
  1315. # data.
  1316. #
  1317. #sentry_send_panic = true
  1318. # Send errors to sentry. This is true by default, but sentry has to be
  1319. # enabled. This option is only effective in release-mode; forced to false
  1320. # in debug-mode.
  1321. #
  1322. #sentry_send_error = true
  1323. # Controls the tracing log level for Sentry to send things like
  1324. # breadcrumbs and transactions
  1325. #
  1326. #sentry_filter = "info"
  1327. # Enable the tokio-console. This option is only relevant to developers.
  1328. #
  1329. # For more information, see:
  1330. # https://continuwuity.org/development.html#debugging-with-tokio-console
  1331. #
  1332. #tokio_console = false
  1333. # This item is undocumented. Please contribute documentation for it.
  1334. #
  1335. #test = false
  1336. # Controls whether admin room notices like account registrations, password
  1337. # changes, account deactivations, room directory publications, etc will be
  1338. # sent to the admin room. Update notices and normal admin command
  1339. # responses will still be sent.
  1340. #
  1341. #admin_room_notices = true
  1342. # Enable database pool affinity support. On supporting systems, block
  1343. # device queue topologies are detected and the request pool is optimized
  1344. # for the hardware; db_pool_workers is determined automatically.
  1345. #
  1346. #db_pool_affinity = true
  1347. # Sets the number of worker threads in the frontend-pool of the database.
  1348. # This number should reflect the I/O capabilities of the system,
  1349. # such as the queue-depth or the number of simultaneous requests in
  1350. # flight. Defaults to 32 or four times the number of CPU cores, whichever
  1351. # is greater.
  1352. #
  1353. # Note: This value is only used if db_pool_affinity is disabled or not
  1354. # detected on the system, otherwise it is determined automatically.
  1355. #
  1356. #db_pool_workers = 32
  1357. # When db_pool_affinity is enabled and detected, the size of any worker
  1358. # group will not exceed the determined value. This is necessary when
  1359. # thread-pooling approach does not scale to the full capabilities of
  1360. # high-end hardware; using detected values without limitation could
  1361. # degrade performance.
  1362. #
  1363. # The value is multiplied by the number of cores which share a device
  1364. # queue, since group workers can be scheduled on any of those cores.
  1365. #
  1366. #db_pool_workers_limit = 64
  1367. # Determines the size of the queues feeding the database's frontend-pool.
  1368. # The size of the queue is determined by multiplying this value with the
  1369. # number of pool workers. When this queue is full, tokio tasks conducting
  1370. # requests will yield until space is available; this is good for
  1371. # flow-control by avoiding buffer-bloat, but can inhibit throughput if
  1372. # too low.
  1373. #
  1374. #db_pool_queue_mult = 4
  1375. # Sets the initial value for the concurrency of streams. This value simply
  1376. # allows overriding the default in the code. The default is 32, which is
  1377. # the same as the default in the code. Note this value is itself
  1378. # overridden by the computed stream_width_scale, unless that is disabled;
  1379. # this value can serve as a fixed-width instead.
  1380. #
  1381. #stream_width_default = 32
  1382. # Scales the stream width starting from a base value detected for the
  1383. # specific system. The base value is the database pool worker count
  1384. # determined from the hardware queue size (e.g. 32 for SSD or 64 or 128+
  1385. # for NVMe). This float allows scaling the width up or down by multiplying
  1386. # it (e.g. 1.5, 2.0, etc). The maximum result can be the size of the pool
  1387. # queue (see: db_pool_queue_mult) as any larger value will stall the tokio
  1388. # task. The value can also be scaled down (e.g. 0.5) to improve
  1389. # responsiveness for many users at the cost of throughput for each.
  1390. #
  1391. # Setting this value to 0.0 causes the stream width to be fixed at the
  1392. # value of stream_width_default. The default scale is 1.0 to match the
  1393. # capabilities detected for the system.
  1394. #
  1395. #stream_width_scale = 1.0
  1396. # Sets the initial amplification factor. This controls batch sizes of
  1397. # requests made by each pool worker, multiplying the throughput of each
  1398. # stream. This value is somewhat abstract from specific hardware
  1399. # characteristics and can be significantly larger than any thread count or
  1400. # queue size. This is because each database query may require several
  1401. # index lookups, thus many database queries in a batch may make progress
  1402. # independently while also sharing index and data blocks which may or may
  1403. # not be cached. It is worthwhile to submit huge batches to reduce
  1404. # complexity. The maximum value is 32768, though sufficient hardware is
  1405. # still advised for that.
  1406. #
  1407. #stream_amplification = 1024
  1408. # Number of sender task workers; determines sender parallelism. Default is
  1409. # '0' which means the value is determined internally, likely matching the
  1410. # number of tokio worker-threads or number of cores, etc. Override by
  1411. # setting a non-zero value.
  1412. #
  1413. #sender_workers = 0
  1414. # Enables listener sockets; can be set to false to disable listening. This
  1415. # option is intended for developer/diagnostic purposes only.
  1416. #
  1417. #listening = true
  1418. # Enables configuration reload when the server receives SIGUSR1 on
  1419. # supporting platforms.
  1420. #
  1421. #config_reload_signal = true
  1422. [global.tls]
  1423. # Path to a valid TLS certificate file.
  1424. #
  1425. # example: "/path/to/my/certificate.crt"
  1426. #
  1427. #certs =
  1428. # Path to a valid TLS certificate private key.
  1429. #
  1430. # example: "/path/to/my/certificate.key"
  1431. #
  1432. #key =
  1433. # Whether to listen and allow for HTTP and HTTPS connections (insecure!)
  1434. #
  1435. #dual_protocol = false
  1436. [global.well_known]
  1437. # The server URL that the client well-known file will serve. This should
  1438. # not contain a port, and should just be a valid HTTPS URL.
  1439. #
  1440. # example: "https://matrix.example.com"
  1441. #
  1442. #client =
  1443. # The server base domain of the URL with a specific port that the server
  1444. # well-known file will serve. This should contain a port at the end, and
  1445. # should not be a URL.
  1446. #
  1447. # example: "matrix.example.com:443"
  1448. #
  1449. #server =
  1450. # URL to a support page for the server, which will be served as part of
  1451. # the MSC1929 server support endpoint at /.well-known/matrix/support.
  1452. # Will be included alongside any contact information
  1453. #
  1454. #support_page =
  1455. # Role string for server support contacts, to be served as part of the
  1456. # MSC1929 server support endpoint at /.well-known/matrix/support.
  1457. #
  1458. #support_role = "m.role.admin"
  1459. # Email address for server support contacts, to be served as part of the
  1460. # MSC1929 server support endpoint.
  1461. # This will be used along with support_mxid if specified.
  1462. #
  1463. #support_email =
  1464. # Matrix ID for server support contacts, to be served as part of the
  1465. # MSC1929 server support endpoint.
  1466. # This will be used along with support_email if specified.
  1467. #
  1468. # If no email or mxid is specified, all of the server's admins will be
  1469. # listed.
  1470. #
  1471. #support_mxid =
  1472. [global.blurhashing]
  1473. # blurhashing x component, 4 is recommended by https://blurha.sh/
  1474. #
  1475. #components_x = 4
  1476. # blurhashing y component, 3 is recommended by https://blurha.sh/
  1477. #
  1478. #components_y = 3
  1479. # Max raw size that the server will blurhash, this is the size of the
  1480. # image after converting it to raw data, it should be higher than the
  1481. # upload limit but not too high. The higher it is the higher the
  1482. # potential load will be for clients requesting blurhashes. The default
  1483. # is 33.55MB. Setting it to 0 disables blurhashing.
  1484. #
  1485. #blurhash_max_raw_size = 33554432