sample_config.yaml 92 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646
  1. # This file is maintained as an up-to-date snapshot of the default
  2. # homeserver.yaml configuration generated by Synapse.
  3. #
  4. # It is intended to act as a reference for the default configuration,
  5. # helping admins keep track of new options and other changes, and compare
  6. # their configs with the current default. As such, many of the actual
  7. # config values shown are placeholders.
  8. #
  9. # It is *not* intended to be copied and used as the basis for a real
  10. # homeserver.yaml. Instead, if you are starting from scratch, please generate
  11. # a fresh config using Synapse by following the instructions in
  12. # https://matrix-org.github.io/synapse/latest/setup/installation.html.
  13. # Configuration options that take a time period can be set using a number
  14. # followed by a letter. Letters have the following meanings:
  15. # s = second
  16. # m = minute
  17. # h = hour
  18. # d = day
  19. # w = week
  20. # y = year
  21. # For example, setting redaction_retention_period: 5m would remove redacted
  22. # messages from the database after 5 minutes, rather than 5 months.
  23. ################################################################################
  24. # Configuration file for Synapse.
  25. #
  26. # This is a YAML file: see [1] for a quick introduction. Note in particular
  27. # that *indentation is important*: all the elements of a list or dictionary
  28. # should have the same indentation.
  29. #
  30. # [1] https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html
  31. ## Modules ##
  32. # Server admins can expand Synapse's functionality with external modules.
  33. #
  34. # See https://matrix-org.github.io/synapse/latest/modules.html for more
  35. # documentation on how to configure or create custom modules for Synapse.
  36. #
  37. modules:
  38. # - module: my_super_module.MySuperClass
  39. # config:
  40. # do_thing: true
  41. # - module: my_other_super_module.SomeClass
  42. # config: {}
  43. ## Server ##
  44. # The public-facing domain of the server
  45. #
  46. # The server_name name will appear at the end of usernames and room addresses
  47. # created on this server. For example if the server_name was example.com,
  48. # usernames on this server would be in the format @user:example.com
  49. #
  50. # In most cases you should avoid using a matrix specific subdomain such as
  51. # matrix.example.com or synapse.example.com as the server_name for the same
  52. # reasons you wouldn't use user@email.example.com as your email address.
  53. # See https://matrix-org.github.io/synapse/latest/delegate.html
  54. # for information on how to host Synapse on a subdomain while preserving
  55. # a clean server_name.
  56. #
  57. # The server_name cannot be changed later so it is important to
  58. # configure this correctly before you start Synapse. It should be all
  59. # lowercase and may contain an explicit port.
  60. # Examples: matrix.org, localhost:8080
  61. #
  62. server_name: "SERVERNAME"
  63. # When running as a daemon, the file to store the pid in
  64. #
  65. pid_file: DATADIR/homeserver.pid
  66. # The absolute URL to the web client which /_matrix/client will redirect
  67. # to if 'webclient' is configured under the 'listeners' configuration.
  68. #
  69. # This option can be also set to the filesystem path to the web client
  70. # which will be served at /_matrix/client/ if 'webclient' is configured
  71. # under the 'listeners' configuration, however this is a security risk:
  72. # https://github.com/matrix-org/synapse#security-note
  73. #
  74. #web_client_location: https://riot.example.com/
  75. # The public-facing base URL that clients use to access this Homeserver (not
  76. # including _matrix/...). This is the same URL a user might enter into the
  77. # 'Custom Homeserver URL' field on their client. If you use Synapse with a
  78. # reverse proxy, this should be the URL to reach Synapse via the proxy.
  79. # Otherwise, it should be the URL to reach Synapse's client HTTP listener (see
  80. # 'listeners' below).
  81. #
  82. # Defaults to 'https://<server_name>/'.
  83. #
  84. #public_baseurl: https://example.com/
  85. # Uncomment the following to tell other servers to send federation traffic on
  86. # port 443.
  87. #
  88. # By default, other servers will try to reach our server on port 8448, which can
  89. # be inconvenient in some environments.
  90. #
  91. # Provided 'https://<server_name>/' on port 443 is routed to Synapse, this
  92. # option configures Synapse to serve a file at
  93. # 'https://<server_name>/.well-known/matrix/server'. This will tell other
  94. # servers to send traffic to port 443 instead.
  95. #
  96. # See https://matrix-org.github.io/synapse/latest/delegate.html for more
  97. # information.
  98. #
  99. # Defaults to 'false'.
  100. #
  101. #serve_server_wellknown: true
  102. # Set the soft limit on the number of file descriptors synapse can use
  103. # Zero is used to indicate synapse should set the soft limit to the
  104. # hard limit.
  105. #
  106. #soft_file_limit: 0
  107. # Presence tracking allows users to see the state (e.g online/offline)
  108. # of other local and remote users.
  109. #
  110. presence:
  111. # Uncomment to disable presence tracking on this homeserver. This option
  112. # replaces the previous top-level 'use_presence' option.
  113. #
  114. #enabled: false
  115. # Whether to require authentication to retrieve profile data (avatars,
  116. # display names) of other users through the client API. Defaults to
  117. # 'false'. Note that profile data is also available via the federation
  118. # API, unless allow_profile_lookup_over_federation is set to false.
  119. #
  120. #require_auth_for_profile_requests: true
  121. # Uncomment to require a user to share a room with another user in order
  122. # to retrieve their profile information. Only checked on Client-Server
  123. # requests. Profile requests from other servers should be checked by the
  124. # requesting server. Defaults to 'false'.
  125. #
  126. #limit_profile_requests_to_users_who_share_rooms: true
  127. # Uncomment to prevent a user's profile data from being retrieved and
  128. # displayed in a room until they have joined it. By default, a user's
  129. # profile data is included in an invite event, regardless of the values
  130. # of the above two settings, and whether or not the users share a server.
  131. # Defaults to 'true'.
  132. #
  133. #include_profile_data_on_invite: false
  134. # If set to 'true', removes the need for authentication to access the server's
  135. # public rooms directory through the client API, meaning that anyone can
  136. # query the room directory. Defaults to 'false'.
  137. #
  138. #allow_public_rooms_without_auth: true
  139. # If set to 'true', allows any other homeserver to fetch the server's public
  140. # rooms directory via federation. Defaults to 'false'.
  141. #
  142. #allow_public_rooms_over_federation: true
  143. # The default room version for newly created rooms.
  144. #
  145. # Known room versions are listed here:
  146. # https://matrix.org/docs/spec/#complete-list-of-room-versions
  147. #
  148. # For example, for room version 1, default_room_version should be set
  149. # to "1".
  150. #
  151. #default_room_version: "6"
  152. # The GC threshold parameters to pass to `gc.set_threshold`, if defined
  153. #
  154. #gc_thresholds: [700, 10, 10]
  155. # The minimum time in seconds between each GC for a generation, regardless of
  156. # the GC thresholds. This ensures that we don't do GC too frequently.
  157. #
  158. # A value of `[1s, 10s, 30s]` indicates that a second must pass between consecutive
  159. # generation 0 GCs, etc.
  160. #
  161. # Defaults to `[1s, 10s, 30s]`.
  162. #
  163. #gc_min_interval: [0.5s, 30s, 1m]
  164. # Set the limit on the returned events in the timeline in the get
  165. # and sync operations. The default value is 100. -1 means no upper limit.
  166. #
  167. # Uncomment the following to increase the limit to 5000.
  168. #
  169. #filter_timeline_limit: 5000
  170. # Whether room invites to users on this server should be blocked
  171. # (except those sent by local server admins). The default is False.
  172. #
  173. #block_non_admin_invites: true
  174. # Room searching
  175. #
  176. # If disabled, new messages will not be indexed for searching and users
  177. # will receive errors when searching for messages. Defaults to enabled.
  178. #
  179. #enable_search: false
  180. # Prevent outgoing requests from being sent to the following blacklisted IP address
  181. # CIDR ranges. If this option is not specified then it defaults to private IP
  182. # address ranges (see the example below).
  183. #
  184. # The blacklist applies to the outbound requests for federation, identity servers,
  185. # push servers, and for checking key validity for third-party invite events.
  186. #
  187. # (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly
  188. # listed here, since they correspond to unroutable addresses.)
  189. #
  190. # This option replaces federation_ip_range_blacklist in Synapse v1.25.0.
  191. #
  192. # Note: The value is ignored when an HTTP proxy is in use
  193. #
  194. #ip_range_blacklist:
  195. # - '127.0.0.0/8'
  196. # - '10.0.0.0/8'
  197. # - '172.16.0.0/12'
  198. # - '192.168.0.0/16'
  199. # - '100.64.0.0/10'
  200. # - '192.0.0.0/24'
  201. # - '169.254.0.0/16'
  202. # - '192.88.99.0/24'
  203. # - '198.18.0.0/15'
  204. # - '192.0.2.0/24'
  205. # - '198.51.100.0/24'
  206. # - '203.0.113.0/24'
  207. # - '224.0.0.0/4'
  208. # - '::1/128'
  209. # - 'fe80::/10'
  210. # - 'fc00::/7'
  211. # - '2001:db8::/32'
  212. # - 'ff00::/8'
  213. # - 'fec0::/10'
  214. # List of IP address CIDR ranges that should be allowed for federation,
  215. # identity servers, push servers, and for checking key validity for
  216. # third-party invite events. This is useful for specifying exceptions to
  217. # wide-ranging blacklisted target IP ranges - e.g. for communication with
  218. # a push server only visible in your network.
  219. #
  220. # This whitelist overrides ip_range_blacklist and defaults to an empty
  221. # list.
  222. #
  223. #ip_range_whitelist:
  224. # - '192.168.1.1'
  225. # List of ports that Synapse should listen on, their purpose and their
  226. # configuration.
  227. #
  228. # Options for each listener include:
  229. #
  230. # port: the TCP port to bind to
  231. #
  232. # bind_addresses: a list of local addresses to listen on. The default is
  233. # 'all local interfaces'.
  234. #
  235. # type: the type of listener. Normally 'http', but other valid options are:
  236. # 'manhole' (see https://matrix-org.github.io/synapse/latest/manhole.html),
  237. # 'metrics' (see https://matrix-org.github.io/synapse/latest/metrics-howto.html),
  238. # 'replication' (see https://matrix-org.github.io/synapse/latest/workers.html).
  239. #
  240. # tls: set to true to enable TLS for this listener. Will use the TLS
  241. # key/cert specified in tls_private_key_path / tls_certificate_path.
  242. #
  243. # x_forwarded: Only valid for an 'http' listener. Set to true to use the
  244. # X-Forwarded-For header as the client IP. Useful when Synapse is
  245. # behind a reverse-proxy.
  246. #
  247. # resources: Only valid for an 'http' listener. A list of resources to host
  248. # on this port. Options for each resource are:
  249. #
  250. # names: a list of names of HTTP resources. See below for a list of
  251. # valid resource names.
  252. #
  253. # compress: set to true to enable HTTP compression for this resource.
  254. #
  255. # additional_resources: Only valid for an 'http' listener. A map of
  256. # additional endpoints which should be loaded via dynamic modules.
  257. #
  258. # Valid resource names are:
  259. #
  260. # client: the client-server API (/_matrix/client), and the synapse admin
  261. # API (/_synapse/admin). Also implies 'media' and 'static'.
  262. #
  263. # consent: user consent forms (/_matrix/consent).
  264. # See https://matrix-org.github.io/synapse/latest/consent_tracking.html.
  265. #
  266. # federation: the server-server API (/_matrix/federation). Also implies
  267. # 'media', 'keys', 'openid'
  268. #
  269. # keys: the key discovery API (/_matrix/keys).
  270. #
  271. # media: the media API (/_matrix/media).
  272. #
  273. # metrics: the metrics interface.
  274. # See https://matrix-org.github.io/synapse/latest/metrics-howto.html.
  275. #
  276. # openid: OpenID authentication.
  277. #
  278. # replication: the HTTP replication API (/_synapse/replication).
  279. # See https://matrix-org.github.io/synapse/latest/workers.html.
  280. #
  281. # static: static resources under synapse/static (/_matrix/static). (Mostly
  282. # useful for 'fallback authentication'.)
  283. #
  284. # webclient: A web client. Requires web_client_location to be set.
  285. #
  286. listeners:
  287. # TLS-enabled listener: for when matrix traffic is sent directly to synapse.
  288. #
  289. # Disabled by default. To enable it, uncomment the following. (Note that you
  290. # will also need to give Synapse a TLS key and certificate: see the TLS section
  291. # below.)
  292. #
  293. #- port: 8448
  294. # type: http
  295. # tls: true
  296. # resources:
  297. # - names: [client, federation]
  298. # Unsecure HTTP listener: for when matrix traffic passes through a reverse proxy
  299. # that unwraps TLS.
  300. #
  301. # If you plan to use a reverse proxy, please see
  302. # https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
  303. #
  304. - port: 8008
  305. tls: false
  306. type: http
  307. x_forwarded: true
  308. bind_addresses: ['::1', '127.0.0.1']
  309. resources:
  310. - names: [client, federation]
  311. compress: false
  312. # example additional_resources:
  313. #
  314. #additional_resources:
  315. # "/_matrix/my/custom/endpoint":
  316. # module: my_module.CustomRequestHandler
  317. # config: {}
  318. # Turn on the twisted ssh manhole service on localhost on the given
  319. # port.
  320. #
  321. #- port: 9000
  322. # bind_addresses: ['::1', '127.0.0.1']
  323. # type: manhole
  324. # Connection settings for the manhole
  325. #
  326. manhole_settings:
  327. # The username for the manhole. This defaults to 'matrix'.
  328. #
  329. #username: manhole
  330. # The password for the manhole. This defaults to 'rabbithole'.
  331. #
  332. #password: mypassword
  333. # The private and public SSH key pair used to encrypt the manhole traffic.
  334. # If these are left unset, then hardcoded and non-secret keys are used,
  335. # which could allow traffic to be intercepted if sent over a public network.
  336. #
  337. #ssh_priv_key_path: CONFDIR/id_rsa
  338. #ssh_pub_key_path: CONFDIR/id_rsa.pub
  339. # Forward extremities can build up in a room due to networking delays between
  340. # homeservers. Once this happens in a large room, calculation of the state of
  341. # that room can become quite expensive. To mitigate this, once the number of
  342. # forward extremities reaches a given threshold, Synapse will send an
  343. # org.matrix.dummy_event event, which will reduce the forward extremities
  344. # in the room.
  345. #
  346. # This setting defines the threshold (i.e. number of forward extremities in the
  347. # room) at which dummy events are sent. The default value is 10.
  348. #
  349. #dummy_events_threshold: 5
  350. ## Homeserver blocking ##
  351. # How to reach the server admin, used in ResourceLimitError
  352. #
  353. #admin_contact: 'mailto:admin@server.com'
  354. # Global blocking
  355. #
  356. #hs_disabled: false
  357. #hs_disabled_message: 'Human readable reason for why the HS is blocked'
  358. # Monthly Active User Blocking
  359. #
  360. # Used in cases where the admin or server owner wants to limit to the
  361. # number of monthly active users.
  362. #
  363. # 'limit_usage_by_mau' disables/enables monthly active user blocking. When
  364. # enabled and a limit is reached the server returns a 'ResourceLimitError'
  365. # with error type Codes.RESOURCE_LIMIT_EXCEEDED
  366. #
  367. # 'max_mau_value' is the hard limit of monthly active users above which
  368. # the server will start blocking user actions.
  369. #
  370. # 'mau_trial_days' is a means to add a grace period for active users. It
  371. # means that users must be active for this number of days before they
  372. # can be considered active and guards against the case where lots of users
  373. # sign up in a short space of time never to return after their initial
  374. # session.
  375. #
  376. # 'mau_limit_alerting' is a means of limiting client side alerting
  377. # should the mau limit be reached. This is useful for small instances
  378. # where the admin has 5 mau seats (say) for 5 specific people and no
  379. # interest increasing the mau limit further. Defaults to True, which
  380. # means that alerting is enabled
  381. #
  382. #limit_usage_by_mau: false
  383. #max_mau_value: 50
  384. #mau_trial_days: 2
  385. #mau_limit_alerting: false
  386. # If enabled, the metrics for the number of monthly active users will
  387. # be populated, however no one will be limited. If limit_usage_by_mau
  388. # is true, this is implied to be true.
  389. #
  390. #mau_stats_only: false
  391. # Sometimes the server admin will want to ensure certain accounts are
  392. # never blocked by mau checking. These accounts are specified here.
  393. #
  394. #mau_limit_reserved_threepids:
  395. # - medium: 'email'
  396. # address: 'reserved_user@example.com'
  397. # Used by phonehome stats to group together related servers.
  398. #server_context: context
  399. # Resource-constrained homeserver settings
  400. #
  401. # When this is enabled, the room "complexity" will be checked before a user
  402. # joins a new remote room. If it is above the complexity limit, the server will
  403. # disallow joining, or will instantly leave.
  404. #
  405. # Room complexity is an arbitrary measure based on factors such as the number of
  406. # users in the room.
  407. #
  408. limit_remote_rooms:
  409. # Uncomment to enable room complexity checking.
  410. #
  411. #enabled: true
  412. # the limit above which rooms cannot be joined. The default is 1.0.
  413. #
  414. #complexity: 0.5
  415. # override the error which is returned when the room is too complex.
  416. #
  417. #complexity_error: "This room is too complex."
  418. # allow server admins to join complex rooms. Default is false.
  419. #
  420. #admins_can_join: true
  421. # Whether to require a user to be in the room to add an alias to it.
  422. # Defaults to 'true'.
  423. #
  424. #require_membership_for_aliases: false
  425. # Whether to allow per-room membership profiles through the send of membership
  426. # events with profile information that differ from the target's global profile.
  427. # Defaults to 'true'.
  428. #
  429. #allow_per_room_profiles: false
  430. # How long to keep redacted events in unredacted form in the database. After
  431. # this period redacted events get replaced with their redacted form in the DB.
  432. #
  433. # Defaults to `7d`. Set to `null` to disable.
  434. #
  435. #redaction_retention_period: 28d
  436. # How long to track users' last seen time and IPs in the database.
  437. #
  438. # Defaults to `28d`. Set to `null` to disable clearing out of old rows.
  439. #
  440. #user_ips_max_age: 14d
  441. # Inhibits the /requestToken endpoints from returning an error that might leak
  442. # information about whether an e-mail address is in use or not on this
  443. # homeserver.
  444. # Note that for some endpoints the error situation is the e-mail already being
  445. # used, and for others the error is entering the e-mail being unused.
  446. # If this option is enabled, instead of returning an error, these endpoints will
  447. # act as if no error happened and return a fake session ID ('sid') to clients.
  448. #
  449. #request_token_inhibit_3pid_errors: true
  450. # A list of domains that the domain portion of 'next_link' parameters
  451. # must match.
  452. #
  453. # This parameter is optionally provided by clients while requesting
  454. # validation of an email or phone number, and maps to a link that
  455. # users will be automatically redirected to after validation
  456. # succeeds. Clients can make use this parameter to aid the validation
  457. # process.
  458. #
  459. # The whitelist is applied whether the homeserver or an
  460. # identity server is handling validation.
  461. #
  462. # The default value is no whitelist functionality; all domains are
  463. # allowed. Setting this value to an empty list will instead disallow
  464. # all domains.
  465. #
  466. #next_link_domain_whitelist: ["matrix.org"]
  467. # Templates to use when generating email or HTML page contents.
  468. #
  469. templates:
  470. # Directory in which Synapse will try to find template files to use to generate
  471. # email or HTML page contents.
  472. # If not set, or a file is not found within the template directory, a default
  473. # template from within the Synapse package will be used.
  474. #
  475. # See https://matrix-org.github.io/synapse/latest/templates.html for more
  476. # information about using custom templates.
  477. #
  478. #custom_template_directory: /path/to/custom/templates/
  479. # Message retention policy at the server level.
  480. #
  481. # Room admins and mods can define a retention period for their rooms using the
  482. # 'm.room.retention' state event, and server admins can cap this period by setting
  483. # the 'allowed_lifetime_min' and 'allowed_lifetime_max' config options.
  484. #
  485. # If this feature is enabled, Synapse will regularly look for and purge events
  486. # which are older than the room's maximum retention period. Synapse will also
  487. # filter events received over federation so that events that should have been
  488. # purged are ignored and not stored again.
  489. #
  490. retention:
  491. # The message retention policies feature is disabled by default. Uncomment the
  492. # following line to enable it.
  493. #
  494. #enabled: true
  495. # Default retention policy. If set, Synapse will apply it to rooms that lack the
  496. # 'm.room.retention' state event. Currently, the value of 'min_lifetime' doesn't
  497. # matter much because Synapse doesn't take it into account yet.
  498. #
  499. #default_policy:
  500. # min_lifetime: 1d
  501. # max_lifetime: 1y
  502. # Retention policy limits. If set, and the state of a room contains a
  503. # 'm.room.retention' event in its state which contains a 'min_lifetime' or a
  504. # 'max_lifetime' that's out of these bounds, Synapse will cap the room's policy
  505. # to these limits when running purge jobs.
  506. #
  507. #allowed_lifetime_min: 1d
  508. #allowed_lifetime_max: 1y
  509. # Server admins can define the settings of the background jobs purging the
  510. # events which lifetime has expired under the 'purge_jobs' section.
  511. #
  512. # If no configuration is provided, a single job will be set up to delete expired
  513. # events in every room daily.
  514. #
  515. # Each job's configuration defines which range of message lifetimes the job
  516. # takes care of. For example, if 'shortest_max_lifetime' is '2d' and
  517. # 'longest_max_lifetime' is '3d', the job will handle purging expired events in
  518. # rooms whose state defines a 'max_lifetime' that's both higher than 2 days, and
  519. # lower than or equal to 3 days. Both the minimum and the maximum value of a
  520. # range are optional, e.g. a job with no 'shortest_max_lifetime' and a
  521. # 'longest_max_lifetime' of '3d' will handle every room with a retention policy
  522. # which 'max_lifetime' is lower than or equal to three days.
  523. #
  524. # The rationale for this per-job configuration is that some rooms might have a
  525. # retention policy with a low 'max_lifetime', where history needs to be purged
  526. # of outdated messages on a more frequent basis than for the rest of the rooms
  527. # (e.g. every 12h), but not want that purge to be performed by a job that's
  528. # iterating over every room it knows, which could be heavy on the server.
  529. #
  530. # If any purge job is configured, it is strongly recommended to have at least
  531. # a single job with neither 'shortest_max_lifetime' nor 'longest_max_lifetime'
  532. # set, or one job without 'shortest_max_lifetime' and one job without
  533. # 'longest_max_lifetime' set. Otherwise some rooms might be ignored, even if
  534. # 'allowed_lifetime_min' and 'allowed_lifetime_max' are set, because capping a
  535. # room's policy to these values is done after the policies are retrieved from
  536. # Synapse's database (which is done using the range specified in a purge job's
  537. # configuration).
  538. #
  539. #purge_jobs:
  540. # - longest_max_lifetime: 3d
  541. # interval: 12h
  542. # - shortest_max_lifetime: 3d
  543. # interval: 1d
  544. ## TLS ##
  545. # PEM-encoded X509 certificate for TLS.
  546. # This certificate, as of Synapse 1.0, will need to be a valid and verifiable
  547. # certificate, signed by a recognised Certificate Authority.
  548. #
  549. # Be sure to use a `.pem` file that includes the full certificate chain including
  550. # any intermediate certificates (for instance, if using certbot, use
  551. # `fullchain.pem` as your certificate, not `cert.pem`).
  552. #
  553. #tls_certificate_path: "CONFDIR/SERVERNAME.tls.crt"
  554. # PEM-encoded private key for TLS
  555. #
  556. #tls_private_key_path: "CONFDIR/SERVERNAME.tls.key"
  557. # Whether to verify TLS server certificates for outbound federation requests.
  558. #
  559. # Defaults to `true`. To disable certificate verification, uncomment the
  560. # following line.
  561. #
  562. #federation_verify_certificates: false
  563. # The minimum TLS version that will be used for outbound federation requests.
  564. #
  565. # Defaults to `1`. Configurable to `1`, `1.1`, `1.2`, or `1.3`. Note
  566. # that setting this value higher than `1.2` will prevent federation to most
  567. # of the public Matrix network: only configure it to `1.3` if you have an
  568. # entirely private federation setup and you can ensure TLS 1.3 support.
  569. #
  570. #federation_client_minimum_tls_version: 1.2
  571. # Skip federation certificate verification on the following whitelist
  572. # of domains.
  573. #
  574. # This setting should only be used in very specific cases, such as
  575. # federation over Tor hidden services and similar. For private networks
  576. # of homeservers, you likely want to use a private CA instead.
  577. #
  578. # Only effective if federation_verify_certicates is `true`.
  579. #
  580. #federation_certificate_verification_whitelist:
  581. # - lon.example.com
  582. # - "*.domain.com"
  583. # - "*.onion"
  584. # List of custom certificate authorities for federation traffic.
  585. #
  586. # This setting should only normally be used within a private network of
  587. # homeservers.
  588. #
  589. # Note that this list will replace those that are provided by your
  590. # operating environment. Certificates must be in PEM format.
  591. #
  592. #federation_custom_ca_list:
  593. # - myCA1.pem
  594. # - myCA2.pem
  595. # - myCA3.pem
  596. ## Federation ##
  597. # Restrict federation to the following whitelist of domains.
  598. # N.B. we recommend also firewalling your federation listener to limit
  599. # inbound federation traffic as early as possible, rather than relying
  600. # purely on this application-layer restriction. If not specified, the
  601. # default is to whitelist everything.
  602. #
  603. #federation_domain_whitelist:
  604. # - lon.example.com
  605. # - nyc.example.com
  606. # - syd.example.com
  607. # Report prometheus metrics on the age of PDUs being sent to and received from
  608. # the following domains. This can be used to give an idea of "delay" on inbound
  609. # and outbound federation, though be aware that any delay can be due to problems
  610. # at either end or with the intermediate network.
  611. #
  612. # By default, no domains are monitored in this way.
  613. #
  614. #federation_metrics_domains:
  615. # - matrix.org
  616. # - example.com
  617. # Uncomment to disable profile lookup over federation. By default, the
  618. # Federation API allows other homeservers to obtain profile data of any user
  619. # on this homeserver. Defaults to 'true'.
  620. #
  621. #allow_profile_lookup_over_federation: false
  622. # Uncomment to disable device display name lookup over federation. By default, the
  623. # Federation API allows other homeservers to obtain device display names of any user
  624. # on this homeserver. Defaults to 'true'.
  625. #
  626. #allow_device_name_lookup_over_federation: false
  627. ## Caching ##
  628. # Caching can be configured through the following options.
  629. #
  630. # A cache 'factor' is a multiplier that can be applied to each of
  631. # Synapse's caches in order to increase or decrease the maximum
  632. # number of entries that can be stored.
  633. # The number of events to cache in memory. Not affected by
  634. # caches.global_factor.
  635. #
  636. #event_cache_size: 10K
  637. caches:
  638. # Controls the global cache factor, which is the default cache factor
  639. # for all caches if a specific factor for that cache is not otherwise
  640. # set.
  641. #
  642. # This can also be set by the "SYNAPSE_CACHE_FACTOR" environment
  643. # variable. Setting by environment variable takes priority over
  644. # setting through the config file.
  645. #
  646. # Defaults to 0.5, which will half the size of all caches.
  647. #
  648. #global_factor: 1.0
  649. # A dictionary of cache name to cache factor for that individual
  650. # cache. Overrides the global cache factor for a given cache.
  651. #
  652. # These can also be set through environment variables comprised
  653. # of "SYNAPSE_CACHE_FACTOR_" + the name of the cache in capital
  654. # letters and underscores. Setting by environment variable
  655. # takes priority over setting through the config file.
  656. # Ex. SYNAPSE_CACHE_FACTOR_GET_USERS_WHO_SHARE_ROOM_WITH_USER=2.0
  657. #
  658. # Some caches have '*' and other characters that are not
  659. # alphanumeric or underscores. These caches can be named with or
  660. # without the special characters stripped. For example, to specify
  661. # the cache factor for `*stateGroupCache*` via an environment
  662. # variable would be `SYNAPSE_CACHE_FACTOR_STATEGROUPCACHE=2.0`.
  663. #
  664. per_cache_factors:
  665. #get_users_who_share_room_with_user: 2.0
  666. # Controls how long an entry can be in a cache without having been
  667. # accessed before being evicted. Defaults to None, which means
  668. # entries are never evicted based on time.
  669. #
  670. #expiry_time: 30m
  671. # Controls how long the results of a /sync request are cached for after
  672. # a successful response is returned. A higher duration can help clients with
  673. # intermittent connections, at the cost of higher memory usage.
  674. #
  675. # By default, this is zero, which means that sync responses are not cached
  676. # at all.
  677. #
  678. #sync_response_cache_duration: 2m
  679. ## Database ##
  680. # The 'database' setting defines the database that synapse uses to store all of
  681. # its data.
  682. #
  683. # 'name' gives the database engine to use: either 'sqlite3' (for SQLite) or
  684. # 'psycopg2' (for PostgreSQL).
  685. #
  686. # 'txn_limit' gives the maximum number of transactions to run per connection
  687. # before reconnecting. Defaults to 0, which means no limit.
  688. #
  689. # 'args' gives options which are passed through to the database engine,
  690. # except for options starting 'cp_', which are used to configure the Twisted
  691. # connection pool. For a reference to valid arguments, see:
  692. # * for sqlite: https://docs.python.org/3/library/sqlite3.html#sqlite3.connect
  693. # * for postgres: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS
  694. # * for the connection pool: https://twistedmatrix.com/documents/current/api/twisted.enterprise.adbapi.ConnectionPool.html#__init__
  695. #
  696. #
  697. # Example SQLite configuration:
  698. #
  699. #database:
  700. # name: sqlite3
  701. # args:
  702. # database: /path/to/homeserver.db
  703. #
  704. #
  705. # Example Postgres configuration:
  706. #
  707. #database:
  708. # name: psycopg2
  709. # txn_limit: 10000
  710. # args:
  711. # user: synapse_user
  712. # password: secretpassword
  713. # database: synapse
  714. # host: localhost
  715. # port: 5432
  716. # cp_min: 5
  717. # cp_max: 10
  718. #
  719. # For more information on using Synapse with Postgres,
  720. # see https://matrix-org.github.io/synapse/latest/postgres.html.
  721. #
  722. database:
  723. name: sqlite3
  724. args:
  725. database: DATADIR/homeserver.db
  726. ## Logging ##
  727. # A yaml python logging config file as described by
  728. # https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
  729. #
  730. log_config: "CONFDIR/SERVERNAME.log.config"
  731. ## Ratelimiting ##
  732. # Ratelimiting settings for client actions (registration, login, messaging).
  733. #
  734. # Each ratelimiting configuration is made of two parameters:
  735. # - per_second: number of requests a client can send per second.
  736. # - burst_count: number of requests a client can send before being throttled.
  737. #
  738. # Synapse currently uses the following configurations:
  739. # - one for messages that ratelimits sending based on the account the client
  740. # is using
  741. # - one for registration that ratelimits registration requests based on the
  742. # client's IP address.
  743. # - one for checking the validity of registration tokens that ratelimits
  744. # requests based on the client's IP address.
  745. # - one for login that ratelimits login requests based on the client's IP
  746. # address.
  747. # - one for login that ratelimits login requests based on the account the
  748. # client is attempting to log into.
  749. # - one for login that ratelimits login requests based on the account the
  750. # client is attempting to log into, based on the amount of failed login
  751. # attempts for this account.
  752. # - one for ratelimiting redactions by room admins. If this is not explicitly
  753. # set then it uses the same ratelimiting as per rc_message. This is useful
  754. # to allow room admins to deal with abuse quickly.
  755. # - two for ratelimiting number of rooms a user can join, "local" for when
  756. # users are joining rooms the server is already in (this is cheap) vs
  757. # "remote" for when users are trying to join rooms not on the server (which
  758. # can be more expensive)
  759. # - one for ratelimiting how often a user or IP can attempt to validate a 3PID.
  760. # - two for ratelimiting how often invites can be sent in a room or to a
  761. # specific user.
  762. #
  763. # The defaults are as shown below.
  764. #
  765. #rc_message:
  766. # per_second: 0.2
  767. # burst_count: 10
  768. #
  769. #rc_registration:
  770. # per_second: 0.17
  771. # burst_count: 3
  772. #
  773. #rc_registration_token_validity:
  774. # per_second: 0.1
  775. # burst_count: 5
  776. #
  777. #rc_login:
  778. # address:
  779. # per_second: 0.17
  780. # burst_count: 3
  781. # account:
  782. # per_second: 0.17
  783. # burst_count: 3
  784. # failed_attempts:
  785. # per_second: 0.17
  786. # burst_count: 3
  787. #
  788. #rc_admin_redaction:
  789. # per_second: 1
  790. # burst_count: 50
  791. #
  792. #rc_joins:
  793. # local:
  794. # per_second: 0.1
  795. # burst_count: 10
  796. # remote:
  797. # per_second: 0.01
  798. # burst_count: 10
  799. #
  800. #rc_3pid_validation:
  801. # per_second: 0.003
  802. # burst_count: 5
  803. #
  804. #rc_invites:
  805. # per_room:
  806. # per_second: 0.3
  807. # burst_count: 10
  808. # per_user:
  809. # per_second: 0.003
  810. # burst_count: 5
  811. # Ratelimiting settings for incoming federation
  812. #
  813. # The rc_federation configuration is made up of the following settings:
  814. # - window_size: window size in milliseconds
  815. # - sleep_limit: number of federation requests from a single server in
  816. # a window before the server will delay processing the request.
  817. # - sleep_delay: duration in milliseconds to delay processing events
  818. # from remote servers by if they go over the sleep limit.
  819. # - reject_limit: maximum number of concurrent federation requests
  820. # allowed from a single server
  821. # - concurrent: number of federation requests to concurrently process
  822. # from a single server
  823. #
  824. # The defaults are as shown below.
  825. #
  826. #rc_federation:
  827. # window_size: 1000
  828. # sleep_limit: 10
  829. # sleep_delay: 500
  830. # reject_limit: 50
  831. # concurrent: 3
  832. # Target outgoing federation transaction frequency for sending read-receipts,
  833. # per-room.
  834. #
  835. # If we end up trying to send out more read-receipts, they will get buffered up
  836. # into fewer transactions.
  837. #
  838. #federation_rr_transactions_per_room_per_second: 50
  839. ## Media Store ##
  840. # Enable the media store service in the Synapse master. Uncomment the
  841. # following if you are using a separate media store worker.
  842. #
  843. #enable_media_repo: false
  844. # Directory where uploaded images and attachments are stored.
  845. #
  846. media_store_path: "DATADIR/media_store"
  847. # Media storage providers allow media to be stored in different
  848. # locations.
  849. #
  850. #media_storage_providers:
  851. # - module: file_system
  852. # # Whether to store newly uploaded local files
  853. # store_local: false
  854. # # Whether to store newly downloaded remote files
  855. # store_remote: false
  856. # # Whether to wait for successful storage for local uploads
  857. # store_synchronous: false
  858. # config:
  859. # directory: /mnt/some/other/directory
  860. # The largest allowed upload size in bytes
  861. #
  862. # If you are using a reverse proxy you may also need to set this value in
  863. # your reverse proxy's config. Notably Nginx has a small max body size by default.
  864. # See https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
  865. #
  866. #max_upload_size: 50M
  867. # Maximum number of pixels that will be thumbnailed
  868. #
  869. #max_image_pixels: 32M
  870. # Whether to generate new thumbnails on the fly to precisely match
  871. # the resolution requested by the client. If true then whenever
  872. # a new resolution is requested by the client the server will
  873. # generate a new thumbnail. If false the server will pick a thumbnail
  874. # from a precalculated list.
  875. #
  876. #dynamic_thumbnails: false
  877. # List of thumbnails to precalculate when an image is uploaded.
  878. #
  879. #thumbnail_sizes:
  880. # - width: 32
  881. # height: 32
  882. # method: crop
  883. # - width: 96
  884. # height: 96
  885. # method: crop
  886. # - width: 320
  887. # height: 240
  888. # method: scale
  889. # - width: 640
  890. # height: 480
  891. # method: scale
  892. # - width: 800
  893. # height: 600
  894. # method: scale
  895. # Is the preview URL API enabled?
  896. #
  897. # 'false' by default: uncomment the following to enable it (and specify a
  898. # url_preview_ip_range_blacklist blacklist).
  899. #
  900. #url_preview_enabled: true
  901. # List of IP address CIDR ranges that the URL preview spider is denied
  902. # from accessing. There are no defaults: you must explicitly
  903. # specify a list for URL previewing to work. You should specify any
  904. # internal services in your network that you do not want synapse to try
  905. # to connect to, otherwise anyone in any Matrix room could cause your
  906. # synapse to issue arbitrary GET requests to your internal services,
  907. # causing serious security issues.
  908. #
  909. # (0.0.0.0 and :: are always blacklisted, whether or not they are explicitly
  910. # listed here, since they correspond to unroutable addresses.)
  911. #
  912. # This must be specified if url_preview_enabled is set. It is recommended that
  913. # you uncomment the following list as a starting point.
  914. #
  915. # Note: The value is ignored when an HTTP proxy is in use
  916. #
  917. #url_preview_ip_range_blacklist:
  918. # - '127.0.0.0/8'
  919. # - '10.0.0.0/8'
  920. # - '172.16.0.0/12'
  921. # - '192.168.0.0/16'
  922. # - '100.64.0.0/10'
  923. # - '192.0.0.0/24'
  924. # - '169.254.0.0/16'
  925. # - '192.88.99.0/24'
  926. # - '198.18.0.0/15'
  927. # - '192.0.2.0/24'
  928. # - '198.51.100.0/24'
  929. # - '203.0.113.0/24'
  930. # - '224.0.0.0/4'
  931. # - '::1/128'
  932. # - 'fe80::/10'
  933. # - 'fc00::/7'
  934. # - '2001:db8::/32'
  935. # - 'ff00::/8'
  936. # - 'fec0::/10'
  937. # List of IP address CIDR ranges that the URL preview spider is allowed
  938. # to access even if they are specified in url_preview_ip_range_blacklist.
  939. # This is useful for specifying exceptions to wide-ranging blacklisted
  940. # target IP ranges - e.g. for enabling URL previews for a specific private
  941. # website only visible in your network.
  942. #
  943. #url_preview_ip_range_whitelist:
  944. # - '192.168.1.1'
  945. # Optional list of URL matches that the URL preview spider is
  946. # denied from accessing. You should use url_preview_ip_range_blacklist
  947. # in preference to this, otherwise someone could define a public DNS
  948. # entry that points to a private IP address and circumvent the blacklist.
  949. # This is more useful if you know there is an entire shape of URL that
  950. # you know that will never want synapse to try to spider.
  951. #
  952. # Each list entry is a dictionary of url component attributes as returned
  953. # by urlparse.urlsplit as applied to the absolute form of the URL. See
  954. # https://docs.python.org/2/library/urlparse.html#urlparse.urlsplit
  955. # The values of the dictionary are treated as an filename match pattern
  956. # applied to that component of URLs, unless they start with a ^ in which
  957. # case they are treated as a regular expression match. If all the
  958. # specified component matches for a given list item succeed, the URL is
  959. # blacklisted.
  960. #
  961. #url_preview_url_blacklist:
  962. # # blacklist any URL with a username in its URI
  963. # - username: '*'
  964. #
  965. # # blacklist all *.google.com URLs
  966. # - netloc: 'google.com'
  967. # - netloc: '*.google.com'
  968. #
  969. # # blacklist all plain HTTP URLs
  970. # - scheme: 'http'
  971. #
  972. # # blacklist http(s)://www.acme.com/foo
  973. # - netloc: 'www.acme.com'
  974. # path: '/foo'
  975. #
  976. # # blacklist any URL with a literal IPv4 address
  977. # - netloc: '^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$'
  978. # The largest allowed URL preview spidering size in bytes
  979. #
  980. #max_spider_size: 10M
  981. # A list of values for the Accept-Language HTTP header used when
  982. # downloading webpages during URL preview generation. This allows
  983. # Synapse to specify the preferred languages that URL previews should
  984. # be in when communicating with remote servers.
  985. #
  986. # Each value is a IETF language tag; a 2-3 letter identifier for a
  987. # language, optionally followed by subtags separated by '-', specifying
  988. # a country or region variant.
  989. #
  990. # Multiple values can be provided, and a weight can be added to each by
  991. # using quality value syntax (;q=). '*' translates to any language.
  992. #
  993. # Defaults to "en".
  994. #
  995. # Example:
  996. #
  997. # url_preview_accept_language:
  998. # - en-UK
  999. # - en-US;q=0.9
  1000. # - fr;q=0.8
  1001. # - *;q=0.7
  1002. #
  1003. url_preview_accept_language:
  1004. # - en
  1005. # oEmbed allows for easier embedding content from a website. It can be
  1006. # used for generating URLs previews of services which support it.
  1007. #
  1008. oembed:
  1009. # A default list of oEmbed providers is included with Synapse.
  1010. #
  1011. # Uncomment the following to disable using these default oEmbed URLs.
  1012. # Defaults to 'false'.
  1013. #
  1014. #disable_default_providers: true
  1015. # Additional files with oEmbed configuration (each should be in the
  1016. # form of providers.json).
  1017. #
  1018. # By default, this list is empty (so only the default providers.json
  1019. # is used).
  1020. #
  1021. #additional_providers:
  1022. # - oembed/my_providers.json
  1023. ## Captcha ##
  1024. # See docs/CAPTCHA_SETUP.md for full details of configuring this.
  1025. # This homeserver's ReCAPTCHA public key. Must be specified if
  1026. # enable_registration_captcha is enabled.
  1027. #
  1028. #recaptcha_public_key: "YOUR_PUBLIC_KEY"
  1029. # This homeserver's ReCAPTCHA private key. Must be specified if
  1030. # enable_registration_captcha is enabled.
  1031. #
  1032. #recaptcha_private_key: "YOUR_PRIVATE_KEY"
  1033. # Uncomment to enable ReCaptcha checks when registering, preventing signup
  1034. # unless a captcha is answered. Requires a valid ReCaptcha
  1035. # public/private key. Defaults to 'false'.
  1036. #
  1037. #enable_registration_captcha: true
  1038. # The API endpoint to use for verifying m.login.recaptcha responses.
  1039. # Defaults to "https://www.recaptcha.net/recaptcha/api/siteverify".
  1040. #
  1041. #recaptcha_siteverify_api: "https://my.recaptcha.site"
  1042. ## TURN ##
  1043. # The public URIs of the TURN server to give to clients
  1044. #
  1045. #turn_uris: []
  1046. # The shared secret used to compute passwords for the TURN server
  1047. #
  1048. #turn_shared_secret: "YOUR_SHARED_SECRET"
  1049. # The Username and password if the TURN server needs them and
  1050. # does not use a token
  1051. #
  1052. #turn_username: "TURNSERVER_USERNAME"
  1053. #turn_password: "TURNSERVER_PASSWORD"
  1054. # How long generated TURN credentials last
  1055. #
  1056. #turn_user_lifetime: 1h
  1057. # Whether guests should be allowed to use the TURN server.
  1058. # This defaults to True, otherwise VoIP will be unreliable for guests.
  1059. # However, it does introduce a slight security risk as it allows users to
  1060. # connect to arbitrary endpoints without having first signed up for a
  1061. # valid account (e.g. by passing a CAPTCHA).
  1062. #
  1063. #turn_allow_guests: true
  1064. ## Registration ##
  1065. #
  1066. # Registration can be rate-limited using the parameters in the "Ratelimiting"
  1067. # section of this file.
  1068. # Enable registration for new users.
  1069. #
  1070. #enable_registration: false
  1071. # Time that a user's session remains valid for, after they log in.
  1072. #
  1073. # Note that this is not currently compatible with guest logins.
  1074. #
  1075. # Note also that this is calculated at login time: changes are not applied
  1076. # retrospectively to users who have already logged in.
  1077. #
  1078. # By default, this is infinite.
  1079. #
  1080. #session_lifetime: 24h
  1081. # The user must provide all of the below types of 3PID when registering.
  1082. #
  1083. #registrations_require_3pid:
  1084. # - email
  1085. # - msisdn
  1086. # Explicitly disable asking for MSISDNs from the registration
  1087. # flow (overrides registrations_require_3pid if MSISDNs are set as required)
  1088. #
  1089. #disable_msisdn_registration: true
  1090. # Mandate that users are only allowed to associate certain formats of
  1091. # 3PIDs with accounts on this server.
  1092. #
  1093. #allowed_local_3pids:
  1094. # - medium: email
  1095. # pattern: '^[^@]+@matrix\.org$'
  1096. # - medium: email
  1097. # pattern: '^[^@]+@vector\.im$'
  1098. # - medium: msisdn
  1099. # pattern: '\+44'
  1100. # Enable 3PIDs lookup requests to identity servers from this server.
  1101. #
  1102. #enable_3pid_lookup: true
  1103. # Require users to submit a token during registration.
  1104. # Tokens can be managed using the admin API:
  1105. # https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/registration_tokens.html
  1106. # Note that `enable_registration` must be set to `true`.
  1107. # Disabling this option will not delete any tokens previously generated.
  1108. # Defaults to false. Uncomment the following to require tokens:
  1109. #
  1110. #registration_requires_token: true
  1111. # If set, allows registration of standard or admin accounts by anyone who
  1112. # has the shared secret, even if registration is otherwise disabled.
  1113. #
  1114. #registration_shared_secret: <PRIVATE STRING>
  1115. # Set the number of bcrypt rounds used to generate password hash.
  1116. # Larger numbers increase the work factor needed to generate the hash.
  1117. # The default number is 12 (which equates to 2^12 rounds).
  1118. # N.B. that increasing this will exponentially increase the time required
  1119. # to register or login - e.g. 24 => 2^24 rounds which will take >20 mins.
  1120. #
  1121. #bcrypt_rounds: 12
  1122. # Allows users to register as guests without a password/email/etc, and
  1123. # participate in rooms hosted on this server which have been made
  1124. # accessible to anonymous users.
  1125. #
  1126. #allow_guest_access: false
  1127. # The identity server which we suggest that clients should use when users log
  1128. # in on this server.
  1129. #
  1130. # (By default, no suggestion is made, so it is left up to the client.
  1131. # This setting is ignored unless public_baseurl is also explicitly set.)
  1132. #
  1133. #default_identity_server: https://matrix.org
  1134. # Handle threepid (email/phone etc) registration and password resets through a set of
  1135. # *trusted* identity servers. Note that this allows the configured identity server to
  1136. # reset passwords for accounts!
  1137. #
  1138. # Be aware that if `email` is not set, and SMTP options have not been
  1139. # configured in the email config block, registration and user password resets via
  1140. # email will be globally disabled.
  1141. #
  1142. # Additionally, if `msisdn` is not set, registration and password resets via msisdn
  1143. # will be disabled regardless, and users will not be able to associate an msisdn
  1144. # identifier to their account. This is due to Synapse currently not supporting
  1145. # any method of sending SMS messages on its own.
  1146. #
  1147. # To enable using an identity server for operations regarding a particular third-party
  1148. # identifier type, set the value to the URL of that identity server as shown in the
  1149. # examples below.
  1150. #
  1151. # Servers handling the these requests must answer the `/requestToken` endpoints defined
  1152. # by the Matrix Identity Service API specification:
  1153. # https://matrix.org/docs/spec/identity_service/latest
  1154. #
  1155. account_threepid_delegates:
  1156. #email: https://example.com # Delegate email sending to example.com
  1157. #msisdn: http://localhost:8090 # Delegate SMS sending to this local process
  1158. # Whether users are allowed to change their displayname after it has
  1159. # been initially set. Useful when provisioning users based on the
  1160. # contents of a third-party directory.
  1161. #
  1162. # Does not apply to server administrators. Defaults to 'true'
  1163. #
  1164. #enable_set_displayname: false
  1165. # Whether users are allowed to change their avatar after it has been
  1166. # initially set. Useful when provisioning users based on the contents
  1167. # of a third-party directory.
  1168. #
  1169. # Does not apply to server administrators. Defaults to 'true'
  1170. #
  1171. #enable_set_avatar_url: false
  1172. # Whether users can change the 3PIDs associated with their accounts
  1173. # (email address and msisdn).
  1174. #
  1175. # Defaults to 'true'
  1176. #
  1177. #enable_3pid_changes: false
  1178. # Users who register on this homeserver will automatically be joined
  1179. # to these rooms.
  1180. #
  1181. # By default, any room aliases included in this list will be created
  1182. # as a publicly joinable room when the first user registers for the
  1183. # homeserver. This behaviour can be customised with the settings below.
  1184. # If the room already exists, make certain it is a publicly joinable
  1185. # room. The join rule of the room must be set to 'public'.
  1186. #
  1187. #auto_join_rooms:
  1188. # - "#example:example.com"
  1189. # Where auto_join_rooms are specified, setting this flag ensures that the
  1190. # the rooms exist by creating them when the first user on the
  1191. # homeserver registers.
  1192. #
  1193. # By default the auto-created rooms are publicly joinable from any federated
  1194. # server. Use the autocreate_auto_join_rooms_federated and
  1195. # autocreate_auto_join_room_preset settings below to customise this behaviour.
  1196. #
  1197. # Setting to false means that if the rooms are not manually created,
  1198. # users cannot be auto-joined since they do not exist.
  1199. #
  1200. # Defaults to true. Uncomment the following line to disable automatically
  1201. # creating auto-join rooms.
  1202. #
  1203. #autocreate_auto_join_rooms: false
  1204. # Whether the auto_join_rooms that are auto-created are available via
  1205. # federation. Only has an effect if autocreate_auto_join_rooms is true.
  1206. #
  1207. # Note that whether a room is federated cannot be modified after
  1208. # creation.
  1209. #
  1210. # Defaults to true: the room will be joinable from other servers.
  1211. # Uncomment the following to prevent users from other homeservers from
  1212. # joining these rooms.
  1213. #
  1214. #autocreate_auto_join_rooms_federated: false
  1215. # The room preset to use when auto-creating one of auto_join_rooms. Only has an
  1216. # effect if autocreate_auto_join_rooms is true.
  1217. #
  1218. # This can be one of "public_chat", "private_chat", or "trusted_private_chat".
  1219. # If a value of "private_chat" or "trusted_private_chat" is used then
  1220. # auto_join_mxid_localpart must also be configured.
  1221. #
  1222. # Defaults to "public_chat", meaning that the room is joinable by anyone, including
  1223. # federated servers if autocreate_auto_join_rooms_federated is true (the default).
  1224. # Uncomment the following to require an invitation to join these rooms.
  1225. #
  1226. #autocreate_auto_join_room_preset: private_chat
  1227. # The local part of the user id which is used to create auto_join_rooms if
  1228. # autocreate_auto_join_rooms is true. If this is not provided then the
  1229. # initial user account that registers will be used to create the rooms.
  1230. #
  1231. # The user id is also used to invite new users to any auto-join rooms which
  1232. # are set to invite-only.
  1233. #
  1234. # It *must* be configured if autocreate_auto_join_room_preset is set to
  1235. # "private_chat" or "trusted_private_chat".
  1236. #
  1237. # Note that this must be specified in order for new users to be correctly
  1238. # invited to any auto-join rooms which have been set to invite-only (either
  1239. # at the time of creation or subsequently).
  1240. #
  1241. # Note that, if the room already exists, this user must be joined and
  1242. # have the appropriate permissions to invite new members.
  1243. #
  1244. #auto_join_mxid_localpart: system
  1245. # When auto_join_rooms is specified, setting this flag to false prevents
  1246. # guest accounts from being automatically joined to the rooms.
  1247. #
  1248. # Defaults to true.
  1249. #
  1250. #auto_join_rooms_for_guests: false
  1251. ## Metrics ###
  1252. # Enable collection and rendering of performance metrics
  1253. #
  1254. #enable_metrics: false
  1255. # Enable sentry integration
  1256. # NOTE: While attempts are made to ensure that the logs don't contain
  1257. # any sensitive information, this cannot be guaranteed. By enabling
  1258. # this option the sentry server may therefore receive sensitive
  1259. # information, and it in turn may then diseminate sensitive information
  1260. # through insecure notification channels if so configured.
  1261. #
  1262. #sentry:
  1263. # dsn: "..."
  1264. # Flags to enable Prometheus metrics which are not suitable to be
  1265. # enabled by default, either for performance reasons or limited use.
  1266. #
  1267. metrics_flags:
  1268. # Publish synapse_federation_known_servers, a gauge of the number of
  1269. # servers this homeserver knows about, including itself. May cause
  1270. # performance problems on large homeservers.
  1271. #
  1272. #known_servers: true
  1273. # Whether or not to report anonymized homeserver usage statistics.
  1274. #
  1275. #report_stats: true|false
  1276. # The endpoint to report the anonymized homeserver usage statistics to.
  1277. # Defaults to https://matrix.org/report-usage-stats/push
  1278. #
  1279. #report_stats_endpoint: https://example.com/report-usage-stats/push
  1280. ## API Configuration ##
  1281. # Controls for the state that is shared with users who receive an invite
  1282. # to a room
  1283. #
  1284. room_prejoin_state:
  1285. # By default, the following state event types are shared with users who
  1286. # receive invites to the room:
  1287. #
  1288. # - m.room.join_rules
  1289. # - m.room.canonical_alias
  1290. # - m.room.avatar
  1291. # - m.room.encryption
  1292. # - m.room.name
  1293. # - m.room.create
  1294. #
  1295. # Uncomment the following to disable these defaults (so that only the event
  1296. # types listed in 'additional_event_types' are shared). Defaults to 'false'.
  1297. #
  1298. #disable_default_event_types: true
  1299. # Additional state event types to share with users when they are invited
  1300. # to a room.
  1301. #
  1302. # By default, this list is empty (so only the default event types are shared).
  1303. #
  1304. #additional_event_types:
  1305. # - org.example.custom.event.type
  1306. # A list of application service config files to use
  1307. #
  1308. #app_service_config_files:
  1309. # - app_service_1.yaml
  1310. # - app_service_2.yaml
  1311. # Uncomment to enable tracking of application service IP addresses. Implicitly
  1312. # enables MAU tracking for application service users.
  1313. #
  1314. #track_appservice_user_ips: true
  1315. # a secret which is used to sign access tokens. If none is specified,
  1316. # the registration_shared_secret is used, if one is given; otherwise,
  1317. # a secret key is derived from the signing key.
  1318. #
  1319. #macaroon_secret_key: <PRIVATE STRING>
  1320. # a secret which is used to calculate HMACs for form values, to stop
  1321. # falsification of values. Must be specified for the User Consent
  1322. # forms to work.
  1323. #
  1324. #form_secret: <PRIVATE STRING>
  1325. ## Signing Keys ##
  1326. # Path to the signing key to sign messages with
  1327. #
  1328. signing_key_path: "CONFDIR/SERVERNAME.signing.key"
  1329. # The keys that the server used to sign messages with but won't use
  1330. # to sign new messages.
  1331. #
  1332. old_signing_keys:
  1333. # For each key, `key` should be the base64-encoded public key, and
  1334. # `expired_ts`should be the time (in milliseconds since the unix epoch) that
  1335. # it was last used.
  1336. #
  1337. # It is possible to build an entry from an old signing.key file using the
  1338. # `export_signing_key` script which is provided with synapse.
  1339. #
  1340. # For example:
  1341. #
  1342. #"ed25519:id": { key: "base64string", expired_ts: 123456789123 }
  1343. # How long key response published by this server is valid for.
  1344. # Used to set the valid_until_ts in /key/v2 APIs.
  1345. # Determines how quickly servers will query to check which keys
  1346. # are still valid.
  1347. #
  1348. #key_refresh_interval: 1d
  1349. # The trusted servers to download signing keys from.
  1350. #
  1351. # When we need to fetch a signing key, each server is tried in parallel.
  1352. #
  1353. # Normally, the connection to the key server is validated via TLS certificates.
  1354. # Additional security can be provided by configuring a `verify key`, which
  1355. # will make synapse check that the response is signed by that key.
  1356. #
  1357. # This setting supercedes an older setting named `perspectives`. The old format
  1358. # is still supported for backwards-compatibility, but it is deprecated.
  1359. #
  1360. # 'trusted_key_servers' defaults to matrix.org, but using it will generate a
  1361. # warning on start-up. To suppress this warning, set
  1362. # 'suppress_key_server_warning' to true.
  1363. #
  1364. # Options for each entry in the list include:
  1365. #
  1366. # server_name: the name of the server. required.
  1367. #
  1368. # verify_keys: an optional map from key id to base64-encoded public key.
  1369. # If specified, we will check that the response is signed by at least
  1370. # one of the given keys.
  1371. #
  1372. # accept_keys_insecurely: a boolean. Normally, if `verify_keys` is unset,
  1373. # and federation_verify_certificates is not `true`, synapse will refuse
  1374. # to start, because this would allow anyone who can spoof DNS responses
  1375. # to masquerade as the trusted key server. If you know what you are doing
  1376. # and are sure that your network environment provides a secure connection
  1377. # to the key server, you can set this to `true` to override this
  1378. # behaviour.
  1379. #
  1380. # An example configuration might look like:
  1381. #
  1382. #trusted_key_servers:
  1383. # - server_name: "my_trusted_server.example.com"
  1384. # verify_keys:
  1385. # "ed25519:auto": "abcdefghijklmnopqrstuvwxyzabcdefghijklmopqr"
  1386. # - server_name: "my_other_trusted_server.example.com"
  1387. #
  1388. trusted_key_servers:
  1389. - server_name: "matrix.org"
  1390. # Uncomment the following to disable the warning that is emitted when the
  1391. # trusted_key_servers include 'matrix.org'. See above.
  1392. #
  1393. #suppress_key_server_warning: true
  1394. # The signing keys to use when acting as a trusted key server. If not specified
  1395. # defaults to the server signing key.
  1396. #
  1397. # Can contain multiple keys, one per line.
  1398. #
  1399. #key_server_signing_keys_path: "key_server_signing_keys.key"
  1400. ## Single sign-on integration ##
  1401. # The following settings can be used to make Synapse use a single sign-on
  1402. # provider for authentication, instead of its internal password database.
  1403. #
  1404. # You will probably also want to set the following options to `false` to
  1405. # disable the regular login/registration flows:
  1406. # * enable_registration
  1407. # * password_config.enabled
  1408. #
  1409. # You will also want to investigate the settings under the "sso" configuration
  1410. # section below.
  1411. # Enable SAML2 for registration and login. Uses pysaml2.
  1412. #
  1413. # At least one of `sp_config` or `config_path` must be set in this section to
  1414. # enable SAML login.
  1415. #
  1416. # Once SAML support is enabled, a metadata file will be exposed at
  1417. # https://<server>:<port>/_synapse/client/saml2/metadata.xml, which you may be able to
  1418. # use to configure your SAML IdP with. Alternatively, you can manually configure
  1419. # the IdP to use an ACS location of
  1420. # https://<server>:<port>/_synapse/client/saml2/authn_response.
  1421. #
  1422. saml2_config:
  1423. # `sp_config` is the configuration for the pysaml2 Service Provider.
  1424. # See pysaml2 docs for format of config.
  1425. #
  1426. # Default values will be used for the 'entityid' and 'service' settings,
  1427. # so it is not normally necessary to specify them unless you need to
  1428. # override them.
  1429. #
  1430. sp_config:
  1431. # Point this to the IdP's metadata. You must provide either a local
  1432. # file via the `local` attribute or (preferably) a URL via the
  1433. # `remote` attribute.
  1434. #
  1435. #metadata:
  1436. # local: ["saml2/idp.xml"]
  1437. # remote:
  1438. # - url: https://our_idp/metadata.xml
  1439. # Allowed clock difference in seconds between the homeserver and IdP.
  1440. #
  1441. # Uncomment the below to increase the accepted time difference from 0 to 3 seconds.
  1442. #
  1443. #accepted_time_diff: 3
  1444. # By default, the user has to go to our login page first. If you'd like
  1445. # to allow IdP-initiated login, set 'allow_unsolicited: true' in a
  1446. # 'service.sp' section:
  1447. #
  1448. #service:
  1449. # sp:
  1450. # allow_unsolicited: true
  1451. # The examples below are just used to generate our metadata xml, and you
  1452. # may well not need them, depending on your setup. Alternatively you
  1453. # may need a whole lot more detail - see the pysaml2 docs!
  1454. #description: ["My awesome SP", "en"]
  1455. #name: ["Test SP", "en"]
  1456. #ui_info:
  1457. # display_name:
  1458. # - lang: en
  1459. # text: "Display Name is the descriptive name of your service."
  1460. # description:
  1461. # - lang: en
  1462. # text: "Description should be a short paragraph explaining the purpose of the service."
  1463. # information_url:
  1464. # - lang: en
  1465. # text: "https://example.com/terms-of-service"
  1466. # privacy_statement_url:
  1467. # - lang: en
  1468. # text: "https://example.com/privacy-policy"
  1469. # keywords:
  1470. # - lang: en
  1471. # text: ["Matrix", "Element"]
  1472. # logo:
  1473. # - lang: en
  1474. # text: "https://example.com/logo.svg"
  1475. # width: "200"
  1476. # height: "80"
  1477. #organization:
  1478. # name: Example com
  1479. # display_name:
  1480. # - ["Example co", "en"]
  1481. # url: "http://example.com"
  1482. #contact_person:
  1483. # - given_name: Bob
  1484. # sur_name: "the Sysadmin"
  1485. # email_address": ["admin@example.com"]
  1486. # contact_type": technical
  1487. # Instead of putting the config inline as above, you can specify a
  1488. # separate pysaml2 configuration file:
  1489. #
  1490. #config_path: "CONFDIR/sp_conf.py"
  1491. # The lifetime of a SAML session. This defines how long a user has to
  1492. # complete the authentication process, if allow_unsolicited is unset.
  1493. # The default is 15 minutes.
  1494. #
  1495. #saml_session_lifetime: 5m
  1496. # An external module can be provided here as a custom solution to
  1497. # mapping attributes returned from a saml provider onto a matrix user.
  1498. #
  1499. user_mapping_provider:
  1500. # The custom module's class. Uncomment to use a custom module.
  1501. #
  1502. #module: mapping_provider.SamlMappingProvider
  1503. # Custom configuration values for the module. Below options are
  1504. # intended for the built-in provider, they should be changed if
  1505. # using a custom module. This section will be passed as a Python
  1506. # dictionary to the module's `parse_config` method.
  1507. #
  1508. config:
  1509. # The SAML attribute (after mapping via the attribute maps) to use
  1510. # to derive the Matrix ID from. 'uid' by default.
  1511. #
  1512. # Note: This used to be configured by the
  1513. # saml2_config.mxid_source_attribute option. If that is still
  1514. # defined, its value will be used instead.
  1515. #
  1516. #mxid_source_attribute: displayName
  1517. # The mapping system to use for mapping the saml attribute onto a
  1518. # matrix ID.
  1519. #
  1520. # Options include:
  1521. # * 'hexencode' (which maps unpermitted characters to '=xx')
  1522. # * 'dotreplace' (which replaces unpermitted characters with
  1523. # '.').
  1524. # The default is 'hexencode'.
  1525. #
  1526. # Note: This used to be configured by the
  1527. # saml2_config.mxid_mapping option. If that is still defined, its
  1528. # value will be used instead.
  1529. #
  1530. #mxid_mapping: dotreplace
  1531. # In previous versions of synapse, the mapping from SAML attribute to
  1532. # MXID was always calculated dynamically rather than stored in a
  1533. # table. For backwards- compatibility, we will look for user_ids
  1534. # matching such a pattern before creating a new account.
  1535. #
  1536. # This setting controls the SAML attribute which will be used for this
  1537. # backwards-compatibility lookup. Typically it should be 'uid', but if
  1538. # the attribute maps are changed, it may be necessary to change it.
  1539. #
  1540. # The default is 'uid'.
  1541. #
  1542. #grandfathered_mxid_source_attribute: upn
  1543. # It is possible to configure Synapse to only allow logins if SAML attributes
  1544. # match particular values. The requirements can be listed under
  1545. # `attribute_requirements` as shown below. All of the listed attributes must
  1546. # match for the login to be permitted.
  1547. #
  1548. #attribute_requirements:
  1549. # - attribute: userGroup
  1550. # value: "staff"
  1551. # - attribute: department
  1552. # value: "sales"
  1553. # If the metadata XML contains multiple IdP entities then the `idp_entityid`
  1554. # option must be set to the entity to redirect users to.
  1555. #
  1556. # Most deployments only have a single IdP entity and so should omit this
  1557. # option.
  1558. #
  1559. #idp_entityid: 'https://our_idp/entityid'
  1560. # List of OpenID Connect (OIDC) / OAuth 2.0 identity providers, for registration
  1561. # and login.
  1562. #
  1563. # Options for each entry include:
  1564. #
  1565. # idp_id: a unique identifier for this identity provider. Used internally
  1566. # by Synapse; should be a single word such as 'github'.
  1567. #
  1568. # Note that, if this is changed, users authenticating via that provider
  1569. # will no longer be recognised as the same user!
  1570. #
  1571. # (Use "oidc" here if you are migrating from an old "oidc_config"
  1572. # configuration.)
  1573. #
  1574. # idp_name: A user-facing name for this identity provider, which is used to
  1575. # offer the user a choice of login mechanisms.
  1576. #
  1577. # idp_icon: An optional icon for this identity provider, which is presented
  1578. # by clients and Synapse's own IdP picker page. If given, must be an
  1579. # MXC URI of the format mxc://<server-name>/<media-id>. (An easy way to
  1580. # obtain such an MXC URI is to upload an image to an (unencrypted) room
  1581. # and then copy the "url" from the source of the event.)
  1582. #
  1583. # idp_brand: An optional brand for this identity provider, allowing clients
  1584. # to style the login flow according to the identity provider in question.
  1585. # See the spec for possible options here.
  1586. #
  1587. # discover: set to 'false' to disable the use of the OIDC discovery mechanism
  1588. # to discover endpoints. Defaults to true.
  1589. #
  1590. # issuer: Required. The OIDC issuer. Used to validate tokens and (if discovery
  1591. # is enabled) to discover the provider's endpoints.
  1592. #
  1593. # client_id: Required. oauth2 client id to use.
  1594. #
  1595. # client_secret: oauth2 client secret to use. May be omitted if
  1596. # client_secret_jwt_key is given, or if client_auth_method is 'none'.
  1597. #
  1598. # client_secret_jwt_key: Alternative to client_secret: details of a key used
  1599. # to create a JSON Web Token to be used as an OAuth2 client secret. If
  1600. # given, must be a dictionary with the following properties:
  1601. #
  1602. # key: a pem-encoded signing key. Must be a suitable key for the
  1603. # algorithm specified. Required unless 'key_file' is given.
  1604. #
  1605. # key_file: the path to file containing a pem-encoded signing key file.
  1606. # Required unless 'key' is given.
  1607. #
  1608. # jwt_header: a dictionary giving properties to include in the JWT
  1609. # header. Must include the key 'alg', giving the algorithm used to
  1610. # sign the JWT, such as "ES256", using the JWA identifiers in
  1611. # RFC7518.
  1612. #
  1613. # jwt_payload: an optional dictionary giving properties to include in
  1614. # the JWT payload. Normally this should include an 'iss' key.
  1615. #
  1616. # client_auth_method: auth method to use when exchanging the token. Valid
  1617. # values are 'client_secret_basic' (default), 'client_secret_post' and
  1618. # 'none'.
  1619. #
  1620. # scopes: list of scopes to request. This should normally include the "openid"
  1621. # scope. Defaults to ["openid"].
  1622. #
  1623. # authorization_endpoint: the oauth2 authorization endpoint. Required if
  1624. # provider discovery is disabled.
  1625. #
  1626. # token_endpoint: the oauth2 token endpoint. Required if provider discovery is
  1627. # disabled.
  1628. #
  1629. # userinfo_endpoint: the OIDC userinfo endpoint. Required if discovery is
  1630. # disabled and the 'openid' scope is not requested.
  1631. #
  1632. # jwks_uri: URI where to fetch the JWKS. Required if discovery is disabled and
  1633. # the 'openid' scope is used.
  1634. #
  1635. # skip_verification: set to 'true' to skip metadata verification. Use this if
  1636. # you are connecting to a provider that is not OpenID Connect compliant.
  1637. # Defaults to false. Avoid this in production.
  1638. #
  1639. # user_profile_method: Whether to fetch the user profile from the userinfo
  1640. # endpoint. Valid values are: 'auto' or 'userinfo_endpoint'.
  1641. #
  1642. # Defaults to 'auto', which fetches the userinfo endpoint if 'openid' is
  1643. # included in 'scopes'. Set to 'userinfo_endpoint' to always fetch the
  1644. # userinfo endpoint.
  1645. #
  1646. # allow_existing_users: set to 'true' to allow a user logging in via OIDC to
  1647. # match a pre-existing account instead of failing. This could be used if
  1648. # switching from password logins to OIDC. Defaults to false.
  1649. #
  1650. # user_mapping_provider: Configuration for how attributes returned from a OIDC
  1651. # provider are mapped onto a matrix user. This setting has the following
  1652. # sub-properties:
  1653. #
  1654. # module: The class name of a custom mapping module. Default is
  1655. # 'synapse.handlers.oidc.JinjaOidcMappingProvider'.
  1656. # See https://matrix-org.github.io/synapse/latest/sso_mapping_providers.html#openid-mapping-providers
  1657. # for information on implementing a custom mapping provider.
  1658. #
  1659. # config: Configuration for the mapping provider module. This section will
  1660. # be passed as a Python dictionary to the user mapping provider
  1661. # module's `parse_config` method.
  1662. #
  1663. # For the default provider, the following settings are available:
  1664. #
  1665. # subject_claim: name of the claim containing a unique identifier
  1666. # for the user. Defaults to 'sub', which OpenID Connect
  1667. # compliant providers should provide.
  1668. #
  1669. # localpart_template: Jinja2 template for the localpart of the MXID.
  1670. # If this is not set, the user will be prompted to choose their
  1671. # own username (see 'sso_auth_account_details.html' in the 'sso'
  1672. # section of this file).
  1673. #
  1674. # display_name_template: Jinja2 template for the display name to set
  1675. # on first login. If unset, no displayname will be set.
  1676. #
  1677. # email_template: Jinja2 template for the email address of the user.
  1678. # If unset, no email address will be added to the account.
  1679. #
  1680. # extra_attributes: a map of Jinja2 templates for extra attributes
  1681. # to send back to the client during login.
  1682. # Note that these are non-standard and clients will ignore them
  1683. # without modifications.
  1684. #
  1685. # When rendering, the Jinja2 templates are given a 'user' variable,
  1686. # which is set to the claims returned by the UserInfo Endpoint and/or
  1687. # in the ID Token.
  1688. #
  1689. # It is possible to configure Synapse to only allow logins if certain attributes
  1690. # match particular values in the OIDC userinfo. The requirements can be listed under
  1691. # `attribute_requirements` as shown below. All of the listed attributes must
  1692. # match for the login to be permitted. Additional attributes can be added to
  1693. # userinfo by expanding the `scopes` section of the OIDC config to retrieve
  1694. # additional information from the OIDC provider.
  1695. #
  1696. # If the OIDC claim is a list, then the attribute must match any value in the list.
  1697. # Otherwise, it must exactly match the value of the claim. Using the example
  1698. # below, the `family_name` claim MUST be "Stephensson", but the `groups`
  1699. # claim MUST contain "admin".
  1700. #
  1701. # attribute_requirements:
  1702. # - attribute: family_name
  1703. # value: "Stephensson"
  1704. # - attribute: groups
  1705. # value: "admin"
  1706. #
  1707. # See https://matrix-org.github.io/synapse/latest/openid.html
  1708. # for information on how to configure these options.
  1709. #
  1710. # For backwards compatibility, it is also possible to configure a single OIDC
  1711. # provider via an 'oidc_config' setting. This is now deprecated and admins are
  1712. # advised to migrate to the 'oidc_providers' format. (When doing that migration,
  1713. # use 'oidc' for the idp_id to ensure that existing users continue to be
  1714. # recognised.)
  1715. #
  1716. oidc_providers:
  1717. # Generic example
  1718. #
  1719. #- idp_id: my_idp
  1720. # idp_name: "My OpenID provider"
  1721. # idp_icon: "mxc://example.com/mediaid"
  1722. # discover: false
  1723. # issuer: "https://accounts.example.com/"
  1724. # client_id: "provided-by-your-issuer"
  1725. # client_secret: "provided-by-your-issuer"
  1726. # client_auth_method: client_secret_post
  1727. # scopes: ["openid", "profile"]
  1728. # authorization_endpoint: "https://accounts.example.com/oauth2/auth"
  1729. # token_endpoint: "https://accounts.example.com/oauth2/token"
  1730. # userinfo_endpoint: "https://accounts.example.com/userinfo"
  1731. # jwks_uri: "https://accounts.example.com/.well-known/jwks.json"
  1732. # skip_verification: true
  1733. # user_mapping_provider:
  1734. # config:
  1735. # subject_claim: "id"
  1736. # localpart_template: "{{ user.login }}"
  1737. # display_name_template: "{{ user.name }}"
  1738. # email_template: "{{ user.email }}"
  1739. # attribute_requirements:
  1740. # - attribute: userGroup
  1741. # value: "synapseUsers"
  1742. # Enable Central Authentication Service (CAS) for registration and login.
  1743. #
  1744. cas_config:
  1745. # Uncomment the following to enable authorization against a CAS server.
  1746. # Defaults to false.
  1747. #
  1748. #enabled: true
  1749. # The URL of the CAS authorization endpoint.
  1750. #
  1751. #server_url: "https://cas-server.com"
  1752. # The attribute of the CAS response to use as the display name.
  1753. #
  1754. # If unset, no displayname will be set.
  1755. #
  1756. #displayname_attribute: name
  1757. # It is possible to configure Synapse to only allow logins if CAS attributes
  1758. # match particular values. All of the keys in the mapping below must exist
  1759. # and the values must match the given value. Alternately if the given value
  1760. # is None then any value is allowed (the attribute just must exist).
  1761. # All of the listed attributes must match for the login to be permitted.
  1762. #
  1763. #required_attributes:
  1764. # userGroup: "staff"
  1765. # department: None
  1766. # Additional settings to use with single-sign on systems such as OpenID Connect,
  1767. # SAML2 and CAS.
  1768. #
  1769. # Server admins can configure custom templates for pages related to SSO. See
  1770. # https://matrix-org.github.io/synapse/latest/templates.html for more information.
  1771. #
  1772. sso:
  1773. # A list of client URLs which are whitelisted so that the user does not
  1774. # have to confirm giving access to their account to the URL. Any client
  1775. # whose URL starts with an entry in the following list will not be subject
  1776. # to an additional confirmation step after the SSO login is completed.
  1777. #
  1778. # WARNING: An entry such as "https://my.client" is insecure, because it
  1779. # will also match "https://my.client.evil.site", exposing your users to
  1780. # phishing attacks from evil.site. To avoid this, include a slash after the
  1781. # hostname: "https://my.client/".
  1782. #
  1783. # The login fallback page (used by clients that don't natively support the
  1784. # required login flows) is whitelisted in addition to any URLs in this list.
  1785. #
  1786. # By default, this list contains only the login fallback page.
  1787. #
  1788. #client_whitelist:
  1789. # - https://riot.im/develop
  1790. # - https://my.custom.client/
  1791. # Uncomment to keep a user's profile fields in sync with information from
  1792. # the identity provider. Currently only syncing the displayname is
  1793. # supported. Fields are checked on every SSO login, and are updated
  1794. # if necessary.
  1795. #
  1796. # Note that enabling this option will override user profile information,
  1797. # regardless of whether users have opted-out of syncing that
  1798. # information when first signing in. Defaults to false.
  1799. #
  1800. #update_profile_information: true
  1801. # JSON web token integration. The following settings can be used to make
  1802. # Synapse JSON web tokens for authentication, instead of its internal
  1803. # password database.
  1804. #
  1805. # Each JSON Web Token needs to contain a "sub" (subject) claim, which is
  1806. # used as the localpart of the mxid.
  1807. #
  1808. # Additionally, the expiration time ("exp"), not before time ("nbf"),
  1809. # and issued at ("iat") claims are validated if present.
  1810. #
  1811. # Note that this is a non-standard login type and client support is
  1812. # expected to be non-existent.
  1813. #
  1814. # See https://matrix-org.github.io/synapse/latest/jwt.html.
  1815. #
  1816. #jwt_config:
  1817. # Uncomment the following to enable authorization using JSON web
  1818. # tokens. Defaults to false.
  1819. #
  1820. #enabled: true
  1821. # This is either the private shared secret or the public key used to
  1822. # decode the contents of the JSON web token.
  1823. #
  1824. # Required if 'enabled' is true.
  1825. #
  1826. #secret: "provided-by-your-issuer"
  1827. # The algorithm used to sign the JSON web token.
  1828. #
  1829. # Supported algorithms are listed at
  1830. # https://pyjwt.readthedocs.io/en/latest/algorithms.html
  1831. #
  1832. # Required if 'enabled' is true.
  1833. #
  1834. #algorithm: "provided-by-your-issuer"
  1835. # Name of the claim containing a unique identifier for the user.
  1836. #
  1837. # Optional, defaults to `sub`.
  1838. #
  1839. #subject_claim: "sub"
  1840. # The issuer to validate the "iss" claim against.
  1841. #
  1842. # Optional, if provided the "iss" claim will be required and
  1843. # validated for all JSON web tokens.
  1844. #
  1845. #issuer: "provided-by-your-issuer"
  1846. # A list of audiences to validate the "aud" claim against.
  1847. #
  1848. # Optional, if provided the "aud" claim will be required and
  1849. # validated for all JSON web tokens.
  1850. #
  1851. # Note that if the "aud" claim is included in a JSON web token then
  1852. # validation will fail without configuring audiences.
  1853. #
  1854. #audiences:
  1855. # - "provided-by-your-issuer"
  1856. password_config:
  1857. # Uncomment to disable password login
  1858. #
  1859. #enabled: false
  1860. # Uncomment to disable authentication against the local password
  1861. # database. This is ignored if `enabled` is false, and is only useful
  1862. # if you have other password_providers.
  1863. #
  1864. #localdb_enabled: false
  1865. # Uncomment and change to a secret random string for extra security.
  1866. # DO NOT CHANGE THIS AFTER INITIAL SETUP!
  1867. #
  1868. #pepper: "EVEN_MORE_SECRET"
  1869. # Define and enforce a password policy. Each parameter is optional.
  1870. # This is an implementation of MSC2000.
  1871. #
  1872. policy:
  1873. # Whether to enforce the password policy.
  1874. # Defaults to 'false'.
  1875. #
  1876. #enabled: true
  1877. # Minimum accepted length for a password.
  1878. # Defaults to 0.
  1879. #
  1880. #minimum_length: 15
  1881. # Whether a password must contain at least one digit.
  1882. # Defaults to 'false'.
  1883. #
  1884. #require_digit: true
  1885. # Whether a password must contain at least one symbol.
  1886. # A symbol is any character that's not a number or a letter.
  1887. # Defaults to 'false'.
  1888. #
  1889. #require_symbol: true
  1890. # Whether a password must contain at least one lowercase letter.
  1891. # Defaults to 'false'.
  1892. #
  1893. #require_lowercase: true
  1894. # Whether a password must contain at least one uppercase letter.
  1895. # Defaults to 'false'.
  1896. #
  1897. #require_uppercase: true
  1898. ui_auth:
  1899. # The amount of time to allow a user-interactive authentication session
  1900. # to be active.
  1901. #
  1902. # This defaults to 0, meaning the user is queried for their credentials
  1903. # before every action, but this can be overridden to allow a single
  1904. # validation to be re-used. This weakens the protections afforded by
  1905. # the user-interactive authentication process, by allowing for multiple
  1906. # (and potentially different) operations to use the same validation session.
  1907. #
  1908. # This is ignored for potentially "dangerous" operations (including
  1909. # deactivating an account, modifying an account password, and
  1910. # adding a 3PID).
  1911. #
  1912. # Uncomment below to allow for credential validation to last for 15
  1913. # seconds.
  1914. #
  1915. #session_timeout: "15s"
  1916. # Configuration for sending emails from Synapse.
  1917. #
  1918. # Server admins can configure custom templates for email content. See
  1919. # https://matrix-org.github.io/synapse/latest/templates.html for more information.
  1920. #
  1921. email:
  1922. # The hostname of the outgoing SMTP server to use. Defaults to 'localhost'.
  1923. #
  1924. #smtp_host: mail.server
  1925. # The port on the mail server for outgoing SMTP. Defaults to 25.
  1926. #
  1927. #smtp_port: 587
  1928. # Username/password for authentication to the SMTP server. By default, no
  1929. # authentication is attempted.
  1930. #
  1931. #smtp_user: "exampleusername"
  1932. #smtp_pass: "examplepassword"
  1933. # Uncomment the following to require TLS transport security for SMTP.
  1934. # By default, Synapse will connect over plain text, and will then switch to
  1935. # TLS via STARTTLS *if the SMTP server supports it*. If this option is set,
  1936. # Synapse will refuse to connect unless the server supports STARTTLS.
  1937. #
  1938. #require_transport_security: true
  1939. # Uncomment the following to disable TLS for SMTP.
  1940. #
  1941. # By default, if the server supports TLS, it will be used, and the server
  1942. # must present a certificate that is valid for 'smtp_host'. If this option
  1943. # is set to false, TLS will not be used.
  1944. #
  1945. #enable_tls: false
  1946. # notif_from defines the "From" address to use when sending emails.
  1947. # It must be set if email sending is enabled.
  1948. #
  1949. # The placeholder '%(app)s' will be replaced by the application name,
  1950. # which is normally 'app_name' (below), but may be overridden by the
  1951. # Matrix client application.
  1952. #
  1953. # Note that the placeholder must be written '%(app)s', including the
  1954. # trailing 's'.
  1955. #
  1956. #notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>"
  1957. # app_name defines the default value for '%(app)s' in notif_from and email
  1958. # subjects. It defaults to 'Matrix'.
  1959. #
  1960. #app_name: my_branded_matrix_server
  1961. # Uncomment the following to enable sending emails for messages that the user
  1962. # has missed. Disabled by default.
  1963. #
  1964. #enable_notifs: true
  1965. # Uncomment the following to disable automatic subscription to email
  1966. # notifications for new users. Enabled by default.
  1967. #
  1968. #notif_for_new_users: false
  1969. # Custom URL for client links within the email notifications. By default
  1970. # links will be based on "https://matrix.to".
  1971. #
  1972. # (This setting used to be called riot_base_url; the old name is still
  1973. # supported for backwards-compatibility but is now deprecated.)
  1974. #
  1975. #client_base_url: "http://localhost/riot"
  1976. # Configure the time that a validation email will expire after sending.
  1977. # Defaults to 1h.
  1978. #
  1979. #validation_token_lifetime: 15m
  1980. # The web client location to direct users to during an invite. This is passed
  1981. # to the identity server as the org.matrix.web_client_location key. Defaults
  1982. # to unset, giving no guidance to the identity server.
  1983. #
  1984. #invite_client_location: https://app.element.io
  1985. # Subjects to use when sending emails from Synapse.
  1986. #
  1987. # The placeholder '%(app)s' will be replaced with the value of the 'app_name'
  1988. # setting above, or by a value dictated by the Matrix client application.
  1989. #
  1990. # If a subject isn't overridden in this configuration file, the value used as
  1991. # its example will be used.
  1992. #
  1993. #subjects:
  1994. # Subjects for notification emails.
  1995. #
  1996. # On top of the '%(app)s' placeholder, these can use the following
  1997. # placeholders:
  1998. #
  1999. # * '%(person)s', which will be replaced by the display name of the user(s)
  2000. # that sent the message(s), e.g. "Alice and Bob".
  2001. # * '%(room)s', which will be replaced by the name of the room the
  2002. # message(s) have been sent to, e.g. "My super room".
  2003. #
  2004. # See the example provided for each setting to see which placeholder can be
  2005. # used and how to use them.
  2006. #
  2007. # Subject to use to notify about one message from one or more user(s) in a
  2008. # room which has a name.
  2009. #message_from_person_in_room: "[%(app)s] You have a message on %(app)s from %(person)s in the %(room)s room..."
  2010. #
  2011. # Subject to use to notify about one message from one or more user(s) in a
  2012. # room which doesn't have a name.
  2013. #message_from_person: "[%(app)s] You have a message on %(app)s from %(person)s..."
  2014. #
  2015. # Subject to use to notify about multiple messages from one or more users in
  2016. # a room which doesn't have a name.
  2017. #messages_from_person: "[%(app)s] You have messages on %(app)s from %(person)s..."
  2018. #
  2019. # Subject to use to notify about multiple messages in a room which has a
  2020. # name.
  2021. #messages_in_room: "[%(app)s] You have messages on %(app)s in the %(room)s room..."
  2022. #
  2023. # Subject to use to notify about multiple messages in multiple rooms.
  2024. #messages_in_room_and_others: "[%(app)s] You have messages on %(app)s in the %(room)s room and others..."
  2025. #
  2026. # Subject to use to notify about multiple messages from multiple persons in
  2027. # multiple rooms. This is similar to the setting above except it's used when
  2028. # the room in which the notification was triggered has no name.
  2029. #messages_from_person_and_others: "[%(app)s] You have messages on %(app)s from %(person)s and others..."
  2030. #
  2031. # Subject to use to notify about an invite to a room which has a name.
  2032. #invite_from_person_to_room: "[%(app)s] %(person)s has invited you to join the %(room)s room on %(app)s..."
  2033. #
  2034. # Subject to use to notify about an invite to a room which doesn't have a
  2035. # name.
  2036. #invite_from_person: "[%(app)s] %(person)s has invited you to chat on %(app)s..."
  2037. # Subject for emails related to account administration.
  2038. #
  2039. # On top of the '%(app)s' placeholder, these one can use the
  2040. # '%(server_name)s' placeholder, which will be replaced by the value of the
  2041. # 'server_name' setting in your Synapse configuration.
  2042. #
  2043. # Subject to use when sending a password reset email.
  2044. #password_reset: "[%(server_name)s] Password reset"
  2045. #
  2046. # Subject to use when sending a verification email to assert an address's
  2047. # ownership.
  2048. #email_validation: "[%(server_name)s] Validate your email"
  2049. ## Push ##
  2050. push:
  2051. # Clients requesting push notifications can either have the body of
  2052. # the message sent in the notification poke along with other details
  2053. # like the sender, or just the event ID and room ID (`event_id_only`).
  2054. # If clients choose the former, this option controls whether the
  2055. # notification request includes the content of the event (other details
  2056. # like the sender are still included). For `event_id_only` push, it
  2057. # has no effect.
  2058. #
  2059. # For modern android devices the notification content will still appear
  2060. # because it is loaded by the app. iPhone, however will send a
  2061. # notification saying only that a message arrived and who it came from.
  2062. #
  2063. # The default value is "true" to include message details. Uncomment to only
  2064. # include the event ID and room ID in push notification payloads.
  2065. #
  2066. #include_content: false
  2067. # When a push notification is received, an unread count is also sent.
  2068. # This number can either be calculated as the number of unread messages
  2069. # for the user, or the number of *rooms* the user has unread messages in.
  2070. #
  2071. # The default value is "true", meaning push clients will see the number of
  2072. # rooms with unread messages in them. Uncomment to instead send the number
  2073. # of unread messages.
  2074. #
  2075. #group_unread_count_by_room: false
  2076. ## Rooms ##
  2077. # Controls whether locally-created rooms should be end-to-end encrypted by
  2078. # default.
  2079. #
  2080. # Possible options are "all", "invite", and "off". They are defined as:
  2081. #
  2082. # * "all": any locally-created room
  2083. # * "invite": any room created with the "private_chat" or "trusted_private_chat"
  2084. # room creation presets
  2085. # * "off": this option will take no effect
  2086. #
  2087. # The default value is "off".
  2088. #
  2089. # Note that this option will only affect rooms created after it is set. It
  2090. # will also not affect rooms created by other servers.
  2091. #
  2092. #encryption_enabled_by_default_for_room_type: invite
  2093. # Uncomment to allow non-server-admin users to create groups on this server
  2094. #
  2095. #enable_group_creation: true
  2096. # If enabled, non server admins can only create groups with local parts
  2097. # starting with this prefix
  2098. #
  2099. #group_creation_prefix: "unofficial_"
  2100. # User Directory configuration
  2101. #
  2102. user_directory:
  2103. # Defines whether users can search the user directory. If false then
  2104. # empty responses are returned to all queries. Defaults to true.
  2105. #
  2106. # Uncomment to disable the user directory.
  2107. #
  2108. #enabled: false
  2109. # Defines whether to search all users visible to your HS when searching
  2110. # the user directory. If false, search results will only contain users
  2111. # visible in public rooms and users sharing a room with the requester.
  2112. # Defaults to false.
  2113. #
  2114. # NB. If you set this to true, and the last time the user_directory search
  2115. # indexes were (re)built was before Synapse 1.44, you'll have to
  2116. # rebuild the indexes in order to search through all known users.
  2117. # These indexes are built the first time Synapse starts; admins can
  2118. # manually trigger a rebuild via API following the instructions at
  2119. # https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/background_updates.html#run
  2120. #
  2121. # Uncomment to return search results containing all known users, even if that
  2122. # user does not share a room with the requester.
  2123. #
  2124. #search_all_users: true
  2125. # Defines whether to prefer local users in search query results.
  2126. # If True, local users are more likely to appear above remote users
  2127. # when searching the user directory. Defaults to false.
  2128. #
  2129. # Uncomment to prefer local over remote users in user directory search
  2130. # results.
  2131. #
  2132. #prefer_local_users: true
  2133. # User Consent configuration
  2134. #
  2135. # for detailed instructions, see
  2136. # https://matrix-org.github.io/synapse/latest/consent_tracking.html
  2137. #
  2138. # Parts of this section are required if enabling the 'consent' resource under
  2139. # 'listeners', in particular 'template_dir' and 'version'.
  2140. #
  2141. # 'template_dir' gives the location of the templates for the HTML forms.
  2142. # This directory should contain one subdirectory per language (eg, 'en', 'fr'),
  2143. # and each language directory should contain the policy document (named as
  2144. # '<version>.html') and a success page (success.html).
  2145. #
  2146. # 'version' specifies the 'current' version of the policy document. It defines
  2147. # the version to be served by the consent resource if there is no 'v'
  2148. # parameter.
  2149. #
  2150. # 'server_notice_content', if enabled, will send a user a "Server Notice"
  2151. # asking them to consent to the privacy policy. The 'server_notices' section
  2152. # must also be configured for this to work. Notices will *not* be sent to
  2153. # guest users unless 'send_server_notice_to_guests' is set to true.
  2154. #
  2155. # 'block_events_error', if set, will block any attempts to send events
  2156. # until the user consents to the privacy policy. The value of the setting is
  2157. # used as the text of the error.
  2158. #
  2159. # 'require_at_registration', if enabled, will add a step to the registration
  2160. # process, similar to how captcha works. Users will be required to accept the
  2161. # policy before their account is created.
  2162. #
  2163. # 'policy_name' is the display name of the policy users will see when registering
  2164. # for an account. Has no effect unless `require_at_registration` is enabled.
  2165. # Defaults to "Privacy Policy".
  2166. #
  2167. #user_consent:
  2168. # template_dir: res/templates/privacy
  2169. # version: 1.0
  2170. # server_notice_content:
  2171. # msgtype: m.text
  2172. # body: >-
  2173. # To continue using this homeserver you must review and agree to the
  2174. # terms and conditions at %(consent_uri)s
  2175. # send_server_notice_to_guests: true
  2176. # block_events_error: >-
  2177. # To continue using this homeserver you must review and agree to the
  2178. # terms and conditions at %(consent_uri)s
  2179. # require_at_registration: false
  2180. # policy_name: Privacy Policy
  2181. #
  2182. # Settings for local room and user statistics collection. See
  2183. # https://matrix-org.github.io/synapse/latest/room_and_user_statistics.html.
  2184. #
  2185. stats:
  2186. # Uncomment the following to disable room and user statistics. Note that doing
  2187. # so may cause certain features (such as the room directory) not to work
  2188. # correctly.
  2189. #
  2190. #enabled: false
  2191. # Server Notices room configuration
  2192. #
  2193. # Uncomment this section to enable a room which can be used to send notices
  2194. # from the server to users. It is a special room which cannot be left; notices
  2195. # come from a special "notices" user id.
  2196. #
  2197. # If you uncomment this section, you *must* define the system_mxid_localpart
  2198. # setting, which defines the id of the user which will be used to send the
  2199. # notices.
  2200. #
  2201. # It's also possible to override the room name, the display name of the
  2202. # "notices" user, and the avatar for the user.
  2203. #
  2204. #server_notices:
  2205. # system_mxid_localpart: notices
  2206. # system_mxid_display_name: "Server Notices"
  2207. # system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
  2208. # room_name: "Server Notices"
  2209. # Uncomment to disable searching the public room list. When disabled
  2210. # blocks searching local and remote room lists for local and remote
  2211. # users by always returning an empty list for all queries.
  2212. #
  2213. #enable_room_list_search: false
  2214. # The `alias_creation` option controls who's allowed to create aliases
  2215. # on this server.
  2216. #
  2217. # The format of this option is a list of rules that contain globs that
  2218. # match against user_id, room_id and the new alias (fully qualified with
  2219. # server name). The action in the first rule that matches is taken,
  2220. # which can currently either be "allow" or "deny".
  2221. #
  2222. # Missing user_id/room_id/alias fields default to "*".
  2223. #
  2224. # If no rules match the request is denied. An empty list means no one
  2225. # can create aliases.
  2226. #
  2227. # Options for the rules include:
  2228. #
  2229. # user_id: Matches against the creator of the alias
  2230. # alias: Matches against the alias being created
  2231. # room_id: Matches against the room ID the alias is being pointed at
  2232. # action: Whether to "allow" or "deny" the request if the rule matches
  2233. #
  2234. # The default is:
  2235. #
  2236. #alias_creation_rules:
  2237. # - user_id: "*"
  2238. # alias: "*"
  2239. # room_id: "*"
  2240. # action: allow
  2241. # The `room_list_publication_rules` option controls who can publish and
  2242. # which rooms can be published in the public room list.
  2243. #
  2244. # The format of this option is the same as that for
  2245. # `alias_creation_rules`.
  2246. #
  2247. # If the room has one or more aliases associated with it, only one of
  2248. # the aliases needs to match the alias rule. If there are no aliases
  2249. # then only rules with `alias: *` match.
  2250. #
  2251. # If no rules match the request is denied. An empty list means no one
  2252. # can publish rooms.
  2253. #
  2254. # Options for the rules include:
  2255. #
  2256. # user_id: Matches against the creator of the alias
  2257. # room_id: Matches against the room ID being published
  2258. # alias: Matches against any current local or canonical aliases
  2259. # associated with the room
  2260. # action: Whether to "allow" or "deny" the request if the rule matches
  2261. #
  2262. # The default is:
  2263. #
  2264. #room_list_publication_rules:
  2265. # - user_id: "*"
  2266. # alias: "*"
  2267. # room_id: "*"
  2268. # action: allow
  2269. ## Opentracing ##
  2270. # These settings enable opentracing, which implements distributed tracing.
  2271. # This allows you to observe the causal chains of events across servers
  2272. # including requests, key lookups etc., across any server running
  2273. # synapse or any other other services which supports opentracing
  2274. # (specifically those implemented with Jaeger).
  2275. #
  2276. opentracing:
  2277. # tracing is disabled by default. Uncomment the following line to enable it.
  2278. #
  2279. #enabled: true
  2280. # The list of homeservers we wish to send and receive span contexts and span baggage.
  2281. # See https://matrix-org.github.io/synapse/latest/opentracing.html.
  2282. #
  2283. # This is a list of regexes which are matched against the server_name of the
  2284. # homeserver.
  2285. #
  2286. # By default, it is empty, so no servers are matched.
  2287. #
  2288. #homeserver_whitelist:
  2289. # - ".*"
  2290. # A list of the matrix IDs of users whose requests will always be traced,
  2291. # even if the tracing system would otherwise drop the traces due to
  2292. # probabilistic sampling.
  2293. #
  2294. # By default, the list is empty.
  2295. #
  2296. #force_tracing_for_users:
  2297. # - "@user1:server_name"
  2298. # - "@user2:server_name"
  2299. # Jaeger can be configured to sample traces at different rates.
  2300. # All configuration options provided by Jaeger can be set here.
  2301. # Jaeger's configuration is mostly related to trace sampling which
  2302. # is documented here:
  2303. # https://www.jaegertracing.io/docs/latest/sampling/.
  2304. #
  2305. #jaeger_config:
  2306. # sampler:
  2307. # type: const
  2308. # param: 1
  2309. # logging:
  2310. # false
  2311. ## Workers ##
  2312. # Disables sending of outbound federation transactions on the main process.
  2313. # Uncomment if using a federation sender worker.
  2314. #
  2315. #send_federation: false
  2316. # It is possible to run multiple federation sender workers, in which case the
  2317. # work is balanced across them.
  2318. #
  2319. # This configuration must be shared between all federation sender workers, and if
  2320. # changed all federation sender workers must be stopped at the same time and then
  2321. # started, to ensure that all instances are running with the same config (otherwise
  2322. # events may be dropped).
  2323. #
  2324. #federation_sender_instances:
  2325. # - federation_sender1
  2326. # When using workers this should be a map from `worker_name` to the
  2327. # HTTP replication listener of the worker, if configured.
  2328. #
  2329. #instance_map:
  2330. # worker1:
  2331. # host: localhost
  2332. # port: 8034
  2333. # Experimental: When using workers you can define which workers should
  2334. # handle event persistence and typing notifications. Any worker
  2335. # specified here must also be in the `instance_map`.
  2336. #
  2337. #stream_writers:
  2338. # events: worker1
  2339. # typing: worker1
  2340. # The worker that is used to run background tasks (e.g. cleaning up expired
  2341. # data). If not provided this defaults to the main process.
  2342. #
  2343. #run_background_tasks_on: worker1
  2344. # A shared secret used by the replication APIs to authenticate HTTP requests
  2345. # from workers.
  2346. #
  2347. # By default this is unused and traffic is not authenticated.
  2348. #
  2349. #worker_replication_secret: ""
  2350. # Configuration for Redis when using workers. This *must* be enabled when
  2351. # using workers (unless using old style direct TCP configuration).
  2352. #
  2353. redis:
  2354. # Uncomment the below to enable Redis support.
  2355. #
  2356. #enabled: true
  2357. # Optional host and port to use to connect to redis. Defaults to
  2358. # localhost and 6379
  2359. #
  2360. #host: localhost
  2361. #port: 6379
  2362. # Optional password if configured on the Redis instance
  2363. #
  2364. #password: <secret_password>