Matrix Docker Ansible eploy
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
 
 

628 строки
31 KiB

  1. matrix_synapse_docker_image: "matrixdotorg/synapse:v0.34.1.1-py3"
  2. matrix_synapse_base_path: "{{ matrix_base_data_path }}/synapse"
  3. matrix_synapse_config_dir_path: "{{ matrix_synapse_base_path }}/config"
  4. matrix_synapse_run_path: "{{ matrix_synapse_base_path }}/run"
  5. matrix_synapse_storage_path: "{{ matrix_synapse_base_path }}/storage"
  6. matrix_synapse_media_store_path: "{{ matrix_synapse_storage_path }}/media-store"
  7. matrix_synapse_ext_path: "{{ matrix_synapse_base_path }}/ext"
  8. # Controls whether the Synapse container exposes the Client/Server API port (tcp/8008).
  9. matrix_synapse_container_expose_client_server_api_port: false
  10. # Controls whether the Appservice IRC container exposes the Client/Server API port (tcp/9999).
  11. matrix_appservice_irc_container_expose_client_server_api_port: false
  12. # Controls whether the matrix-synapse container exposes the metrics port (tcp/9100).
  13. matrix_synapse_container_expose_metrics_port: false
  14. # List of systemd services that matrix-synapse.service depends on
  15. matrix_synapse_systemd_required_services_list: ['docker.service']
  16. # List of systemd services that matrix-synapse.service wants
  17. matrix_synapse_systemd_wanted_services_list: []
  18. matrix_synapse_in_container_python_packages_path: "/usr/local/lib/python3.6/site-packages"
  19. # Specifies which template files to use when configuring Synapse.
  20. # If you'd like to have your own different configuration, feel free to copy and paste
  21. # the original files into your inventory (e.g. in `inventory/host_vars/<host>/`)
  22. # and then change the specific host's `vars.yaml` file like this:
  23. # matrix_synapse_template_synapse_homeserver: "{{ playbook_dir }}/inventory/host_vars/<host>/homeserver.yaml.j2"
  24. matrix_synapse_template_synapse_homeserver: "{{ role_path }}/templates/synapse/homeserver.yaml.j2"
  25. matrix_synapse_template_synapse_log: "{{ role_path }}/templates/synapse/synapse.log.config.j2"
  26. matrix_synapse_macaroon_secret_key: ""
  27. matrix_synapse_registration_shared_secret: "{{ matrix_synapse_macaroon_secret_key }}"
  28. matrix_synapse_form_secret: "{{ matrix_synapse_macaroon_secret_key }}"
  29. # The list of identity servers to use for Synapse.
  30. # We assume this role runs standalone without a local Identity server, so we point Synapse to public ones.
  31. # This most likely gets overwritten later, so that a local Identity server is used.
  32. matrix_synapse_trusted_third_party_id_servers: "{{ matrix_synapse_id_servers_public }}"
  33. matrix_synapse_max_upload_size_mb: 10
  34. matrix_synapse_max_log_file_size_mb: 100
  35. matrix_synapse_max_log_files_count: 10
  36. # The tmpfs at /tmp needs to be large enough to handle multiple concurrent file uploads.
  37. matrix_synapse_tmp_directory_size_mb: "{{ matrix_synapse_max_upload_size_mb * 50 }}"
  38. # Log levels
  39. # Possible options are defined here https://docs.python.org/3/library/logging.html#logging-levels
  40. # warning: setting log level to DEBUG will make synapse log sensitive information such
  41. # as access tokens
  42. matrix_synapse_log_level: "INFO"
  43. matrix_synapse_storage_sql_log_level: "INFO"
  44. matrix_synapse_root_log_level: "INFO"
  45. # Rate limits
  46. matrix_synapse_rc_messages_per_second: 0.2
  47. matrix_synapse_rc_message_burst_count: 10.0
  48. # Enable this to allow Synapse to report utilization statistics about your server to matrix.org
  49. # (things like number of users, number of messages sent, uptime, load, etc.)
  50. matrix_synapse_report_stats: false
  51. # Controls whether the Matrix server will track presence status (online, offline, unavailable) for users.
  52. # If users participate in large rooms with many other servers,
  53. # disabling this will decrease server load significantly.
  54. matrix_synapse_use_presence: true
  55. # Controls whether people with access to the homeserver can register by themselves.
  56. matrix_synapse_enable_registration: false
  57. # Users who register on this homeserver will automatically be joined to these rooms.
  58. # Rooms are to be specified using addresses (e.g. `#address:example.com`)
  59. matrix_synapse_auto_join_rooms: []
  60. # Controls whether auto-join rooms (`matrix_synapse_auto_join_rooms`) are to be created
  61. # automatically if they don't already exist.
  62. matrix_synapse_autocreate_auto_join_rooms: true
  63. # Controls password-peppering for Matrix Synapse. Not to be changed after initial setup.
  64. matrix_synapse_password_config_pepper: ""
  65. # Controls the number of events that Matrix Synapse caches in memory.
  66. matrix_synapse_event_cache_size: "100K"
  67. # Controls cache sizes for Matrix Synapse via the SYNAPSE_CACHE_FACTOR environment variable.
  68. # Raise this to increase cache sizes or lower it to potentially lower memory use.
  69. # To learn more, see:
  70. # - https://github.com/matrix-org/synapse#help-synapse-eats-all-my-ram
  71. # - https://github.com/matrix-org/synapse/issues/3939
  72. matrix_synapse_cache_factor: 0.5
  73. # Controls whether Matrix Synapse will federate at all.
  74. # Disable this to completely isolate your server from the rest of the Matrix network.
  75. matrix_synapse_federation_enabled: true
  76. # A list of domain names that are allowed to federate with the given Matrix Synapse server.
  77. # An empty list value (`[]`) will also effectively stop federation, but if that's the desired
  78. # result, it's better to accomplish it by changing `matrix_synapse_federation_enabled`.
  79. matrix_synapse_federation_domain_whitelist: ~
  80. # A list of additional "volumes" to mount in the container.
  81. # This list gets populated dynamically based on Synapse extensions that have been enabled.
  82. # Contains definition objects like this: `{"src": "/outside", "dst": "/inside", "options": "rw|ro|slave|.."}
  83. matrix_synapse_container_additional_volumes: []
  84. # A list of additional loggers to register in synapse.log.config.
  85. # This list gets populated dynamically based on Synapse extensions that have been enabled.
  86. # Contains definition objects like this: `{"name": "..", "level": "DEBUG"}
  87. matrix_synapse_additional_loggers: []
  88. # A list of service config files
  89. # This list gets populated dynamically based on Synapse extensions that have been enabled.
  90. # Contains fs paths
  91. matrix_synapse_app_service_config_files: []
  92. # This is set dynamically during execution depending on whether
  93. # any password providers have been enabled or not.
  94. matrix_synapse_password_providers_enabled: false
  95. # Enable exposure of metrics to Prometheus
  96. # See https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.rst
  97. matrix_synapse_metrics_enabled: false
  98. matrix_synapse_metrics_port: 9100
  99. # Postgres database information
  100. matrix_synapse_database_host: ""
  101. matrix_synapse_database_user: ""
  102. matrix_synapse_database_password: ""
  103. matrix_synapse_database_database: ""
  104. matrix_synapse_turn_uris: []
  105. matrix_synapse_turn_shared_secret: ""
  106. matrix_synapse_email_enabled: false
  107. matrix_synapse_email_smtp_host: ""
  108. matrix_synapse_email_smtp_port: 587
  109. matrix_synapse_email_smtp_require_transport_security: false
  110. matrix_synapse_email_notif_from: "Matrix <matrix@{{ hostname_identity }}>"
  111. matrix_synapse_email_riot_base_url: "https://{{ hostname_riot }}"
  112. # Enable this to activate the REST auth password provider module.
  113. # See: https://github.com/kamax-io/matrix-synapse-rest-auth
  114. matrix_synapse_ext_password_provider_rest_auth_enabled: false
  115. matrix_synapse_ext_password_provider_rest_auth_download_url: "https://raw.githubusercontent.com/kamax-io/matrix-synapse-rest-auth/v0.1.1/rest_auth_provider.py"
  116. matrix_synapse_ext_password_provider_rest_auth_endpoint: ""
  117. matrix_synapse_ext_password_provider_rest_auth_registration_enforce_lowercase: false
  118. matrix_synapse_ext_password_provider_rest_auth_registration_profile_name_autofill: true
  119. matrix_synapse_ext_password_provider_rest_auth_login_profile_name_autofill: false
  120. # Enable this to activate the Shared Secret Auth password provider module.
  121. # See: https://github.com/devture/matrix-synapse-shared-secret-auth
  122. matrix_synapse_ext_password_provider_shared_secret_auth_enabled: false
  123. matrix_synapse_ext_password_provider_shared_secret_auth_download_url: "https://raw.githubusercontent.com/devture/matrix-synapse-shared-secret-auth/1.0.1/shared_secret_authenticator.py"
  124. matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret: ""
  125. # Enable this to activate LDAP password provider
  126. matrix_synapse_ext_password_provider_ldap_enabled: false
  127. matrix_synapse_ext_password_provider_ldap_uri: "ldap://ldap.mydomain.tld:389"
  128. matrix_synapse_ext_password_provider_ldap_start_tls: true
  129. matrix_synapse_ext_password_provider_ldap_base: ""
  130. matrix_synapse_ext_password_provider_ldap_attributes_uid: "uid"
  131. matrix_synapse_ext_password_provider_ldap_attributes_mail: "mail"
  132. matrix_synapse_ext_password_provider_ldap_attributes_name: "cn"
  133. matrix_synapse_ext_password_provider_ldap_bind_dn: ""
  134. matrix_synapse_ext_password_provider_ldap_bind_password: ""
  135. matrix_synapse_ext_password_provider_ldap_filter: ""
  136. matrix_s3_media_store_enabled: false
  137. matrix_s3_goofys_docker_image: "ewoutp/goofys:latest"
  138. matrix_s3_media_store_bucket_name: "your-bucket-name"
  139. matrix_s3_media_store_aws_access_key: "your-aws-access-key"
  140. matrix_s3_media_store_aws_secret_key: "your-aws-secret-key"
  141. matrix_s3_media_store_region: "eu-central-1"
  142. # Matrix mautrix is a Matrix <-> Telegram bridge
  143. # Enable telegram bridge
  144. matrix_mautrix_telegram_enabled: false
  145. matrix_mautrix_telegram_docker_image: "tulir/mautrix-telegram:v0.4.0"
  146. matrix_mautrix_telegram_base_path: "{{ matrix_base_data_path }}/mautrix-telegram"
  147. # Get your own API keys at https://my.telegram.org/apps
  148. matrix_mautrix_telegram_api_id: YOUR_TELEGRAM_APP_ID
  149. matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH
  150. # Mautrix telegram public endpoint to log in to telegram
  151. # Use an uuid so it's not easily discoverable
  152. matrix_mautrix_telegram_public_endpoint: "/{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'telegram') | to_uuid }}"
  153. # Matrix mautrix is a Matrix <-> Whatsapp bridge
  154. # Enable whatsapp bridge
  155. matrix_mautrix_whatsapp_enabled: false
  156. matrix_mautrix_whatsapp_docker_image: "tulir/mautrix-whatsapp:latest"
  157. matrix_mautrix_whatsapp_base_path: "{{ matrix_base_data_path }}/mautrix-whatsapp"
  158. # Matrix Appservice IRC is a Matrix <-> IRC bridge
  159. # Enable IRC bridge
  160. matrix_appservice_irc_enabled: false
  161. matrix_appservice_irc_docker_image: "tedomum/matrix-appservice-irc:latest"
  162. matrix_appservice_irc_base_path: "{{ matrix_base_data_path }}/appservice-irc"
  163. matrix_appservice_irc_configuration_yaml: |
  164. homeserver:
  165. url: "https://{{ hostname_matrix }}"
  166. domain: "{{ hostname_identity }}"
  167. enablePresence: true
  168. matrix_appservice_irc_configuration_extension_yaml: |
  169. # Your custom YAML configuration for Appservice IRC servers goes here.
  170. # This configuration extends the default starting configuration (`matrix_appservice_irc_configuration_yaml`).
  171. #
  172. # You can override individual variables from the default configuration, or introduce new ones.
  173. #
  174. # If you need something more special, you can take full control by
  175. # completely redefining `matrix_appservice_irc_configuration_yaml`.
  176. #
  177. # Example configuration extension follows:
  178. #
  179. # ircService:
  180. # databaseUri: "nedb:///data" # does not typically need modification
  181. # passwordEncryptionKeyPath: "/data/passkey.pem" # does not typically need modification
  182. # matrixHandler:
  183. # eventCacheSize: 4096
  184. # servers:
  185. # # The address of the server to connect to.
  186. # irc.example.com:
  187. # # A human-readable short name. This is used to label IRC status rooms
  188. # # where matrix users control their connections.
  189. # # E.g. 'ExampleNet IRC Bridge status'.
  190. # # It is also used in the Third Party Lookup API as the instance `desc`
  191. # # property, where each server is an instance.
  192. # name: "ExampleNet"
  193. #
  194. # additionalAddresses: [ "irc2.example.com" ]
  195. # #
  196. # # [DEPRECATED] Use `name`, above, instead.
  197. # # A human-readable description string
  198. # # description: "Example.com IRC network"
  199. #
  200. # # An ID for uniquely identifying this server amongst other servers being bridged.
  201. # # networkId: "example"
  202. #
  203. # # URL to an icon used as the network icon whenever this network appear in
  204. # # a network list. (Like in the riot room directory, for instance.)
  205. # # icon: https://example.com/images/hash.png
  206. #
  207. # # The port to connect to. Optional.
  208. # port: 6697
  209. # # Whether to use SSL or not. Default: false.
  210. # ssl: true
  211. # # Whether or not IRC server is using a self-signed cert or not providing CA Chain
  212. # sslselfsign: false
  213. # # Should the connection attempt to identify via SASL (if a server or user password is given)
  214. # # If false, this will use PASS instead. If SASL fails, we do not fallback to PASS.
  215. # sasl: false
  216. # # Whether to allow expired certs when connecting to the IRC server.
  217. # # Usually this should be off. Default: false.
  218. # allowExpiredCerts: false
  219. # # A specific CA to trust instead of the default CAs. Optional.
  220. # #ca: |
  221. # # -----BEGIN CERTIFICATE-----
  222. # # ...
  223. # # -----END CERTIFICATE-----
  224. #
  225. # #
  226. # # The connection password to send for all clients as a PASS (or SASL, if enabled above) command. Optional.
  227. # # password: 'pa$$w0rd'
  228. # #
  229. # # Whether or not to send connection/error notices to real Matrix users. Default: true.
  230. # sendConnectionMessages: true
  231. #
  232. # quitDebounce:
  233. # # Whether parts due to net-splits are debounced for delayMs, to allow
  234. # # time for the netsplit to resolve itself. A netsplit is detected as being
  235. # # a QUIT rate higher than quitsPerSecond. Default: false.
  236. # enabled: false
  237. # # The maximum number of quits per second acceptable above which a netsplit is
  238. # # considered ongoing. Default: 5.
  239. # quitsPerSecond: 5
  240. # # The time window in which to wait before bridging a QUIT to Matrix that occurred during
  241. # # a netsplit. Debouncing is jittered randomly between delayMinMs and delayMaxMs so that the HS
  242. # # is not sent many requests to leave rooms all at once if a netsplit occurs and many
  243. # # people to not rejoin.
  244. # # If the user with the same IRC nick as the one who sent the quit rejoins a channel
  245. # # they are considered back online and the quit is not bridged, so long as the rejoin
  246. # # occurs before the randomly-jittered timeout is not reached.
  247. # # Default: 3600000, = 1h
  248. # delayMinMs: 3600000 # 1h
  249. # # Default: 7200000, = 2h
  250. # delayMaxMs: 7200000 # 2h
  251. #
  252. # # A map for conversion of IRC user modes to Matrix power levels. This enables bridging
  253. # # of IRC ops to Matrix power levels only, it does not enable the reverse. If a user has
  254. # # been given multiple modes, the one that maps to the highest power level will be used.
  255. # modePowerMap:
  256. # o: 50
  257. #
  258. # botConfig:
  259. # # Enable the presence of the bot in IRC channels. The bot serves as the entity
  260. # # which maps from IRC -> Matrix. You can disable the bot entirely which
  261. # # means IRC -> Matrix chat will be shared by active "M-Nick" connections
  262. # # in the room. If there are no users in the room (or if there are users
  263. # # but their connections are not on IRC) then nothing will be bridged to
  264. # # Matrix. If you're concerned about the bot being treated as a "logger"
  265. # # entity, then you may want to disable the bot. If you want IRC->Matrix
  266. # # but don't want to have TCP connections to IRC unless a Matrix user speaks
  267. # # (because your client connection limit is low), then you may want to keep
  268. # # the bot enabled. Default: true.
  269. # # NB: If the bot is disabled, you SHOULD have matrix-to-IRC syncing turned
  270. # # on, else there will be no users and no bot in a channel (meaning no
  271. # # messages to Matrix!) until a Matrix user speaks which makes a client
  272. # # join the target IRC channel.
  273. # # NBB: The bridge bot IRC client will still join the target IRC network so
  274. # # it can service bridge-specific queries from the IRC-side e.g. so
  275. # # real IRC clients have a way to change their Matrix display name.
  276. # # See https://github.com/matrix-org/matrix-appservice-irc/issues/55
  277. # enabled: true
  278. # # The nickname to give the AS bot.
  279. # nick: "MatrixBot"
  280. # # The password to give to NickServ or IRC Server for this nick. Optional.
  281. # # password: "helloworld"
  282. # #
  283. # # Join channels even if there are no Matrix users on the other side of
  284. # # the bridge. Set to false to prevent the bot from joining channels which have no
  285. # # real matrix users in them, even if there is a mapping for the channel.
  286. # # Default: true
  287. # joinChannelsIfNoUsers: true
  288. #
  289. # # Configuration for PMs / private 1:1 communications between users.
  290. # privateMessages:
  291. # # Enable the ability for PMs to be sent to/from IRC/Matrix.
  292. # # Default: true.
  293. # enabled: true
  294. # # Prevent Matrix users from sending PMs to the following IRC nicks.
  295. # # Optional. Default: [].
  296. # # exclude: ["Alice", "Bob"] # NOT YET IMPLEMENTED
  297. #
  298. # # Should created Matrix PM rooms be federated? If false, only users on the
  299. # # HS attached to this AS will be able to interact with this room.
  300. # # Optional. Default: true.
  301. # federate: true
  302. #
  303. # # Configuration for mappings not explicitly listed in the 'mappings'
  304. # # section.
  305. # dynamicChannels:
  306. # # Enable the ability for Matrix users to join *any* channel on this IRC
  307. # # network.
  308. # # Default: false.
  309. # enabled: true
  310. # # Should the AS create a room alias for the new Matrix room? The form of
  311. # # the alias can be modified via 'aliasTemplate'. Default: true.
  312. # createAlias: true
  313. # # Should the AS publish the new Matrix room to the public room list so
  314. # # anyone can see it? Default: true.
  315. # published: true
  316. # # What should the join_rule be for the new Matrix room? If 'public',
  317. # # anyone can join the room. If 'invite', only users with an invite can
  318. # # join the room. Note that if an IRC channel has +k or +i set on it,
  319. # # join_rules will be set to 'invite' until these modes are removed.
  320. # # Default: "public".
  321. # joinRule: public
  322. # # This will set the m.room.related_groups state event in newly created rooms
  323. # # with the given groupId. This means flares will show up on IRC users in those rooms.
  324. # # This should be set to the same thing as namespaces.users.group_id in irc_registration.
  325. # # This does not alter existing rooms.
  326. # # Leaving this option empty will not set the event.
  327. # groupId: +myircnetwork:localhost
  328. # # Should created Matrix rooms be federated? If false, only users on the
  329. # # HS attached to this AS will be able to interact with this room.
  330. # # Default: true.
  331. # federate: true
  332. # # The room alias template to apply when creating new aliases. This only
  333. # # applies if createAlias is 'true'. The following variables are exposed:
  334. # # $SERVER => The IRC server address (e.g. "irc.example.com")
  335. # # $CHANNEL => The IRC channel (e.g. "#python")
  336. # # This MUST have $CHANNEL somewhere in it.
  337. # # Default: '#irc_$SERVER_$CHANNEL'
  338. # aliasTemplate: "#irc_$CHANNEL"
  339. # # A list of user IDs which the AS bot will send invites to in response
  340. # # to a !join. Only applies if joinRule is 'invite'. Default: []
  341. # # whitelist:
  342. # # - "@foo:example.com"
  343. # # - "@bar:example.com"
  344. # #
  345. # # Prevent the given list of channels from being mapped under any
  346. # # circumstances.
  347. # # exclude: ["#foo", "#bar"]
  348. #
  349. # # Configuration for controlling how Matrix and IRC membership lists are
  350. # # synced.
  351. # membershipLists:
  352. # # Enable the syncing of membership lists between IRC and Matrix. This
  353. # # can have a significant effect on performance on startup as the lists are
  354. # # synced. This must be enabled for anything else in this section to take
  355. # # effect. Default: false.
  356. # enabled: false
  357. #
  358. # # Syncing membership lists at startup can result in hundreds of members to
  359. # # process all at once. This timer drip feeds membership entries at the
  360. # # specified rate. Default: 10000. (10s)
  361. # floodDelayMs: 10000
  362. #
  363. # global:
  364. # ircToMatrix:
  365. # # Get a snapshot of all real IRC users on a channel (via NAMES) and
  366. # # join their virtual matrix clients to the room.
  367. # initial: false
  368. # # Make virtual matrix clients join and leave rooms as their real IRC
  369. # # counterparts join/part channels. Default: false.
  370. # incremental: false
  371. #
  372. # matrixToIrc:
  373. # # Get a snapshot of all real Matrix users in the room and join all of
  374. # # them to the mapped IRC channel on startup. Default: false.
  375. # initial: false
  376. # # Make virtual IRC clients join and leave channels as their real Matrix
  377. # # counterparts join/leave rooms. Make sure your 'maxClients' value is
  378. # # high enough! Default: false.
  379. # incremental: false
  380. #
  381. # # Apply specific rules to Matrix rooms. Only matrix-to-IRC takes effect.
  382. # rooms:
  383. # - room: "!fuasirouddJoxtwfge:localhost"
  384. # matrixToIrc:
  385. # initial: false
  386. # incremental: false
  387. #
  388. # # Apply specific rules to IRC channels. Only IRC-to-matrix takes effect.
  389. # channels:
  390. # - channel: "#foo"
  391. # ircToMatrix:
  392. # initial: false
  393. # incremental: false
  394. #
  395. # mappings:
  396. # # 1:many mappings from IRC channels to room IDs on this IRC server.
  397. # # The matrix room must already exist. Your matrix client should expose
  398. # # the room ID in a "settings" page for the room.
  399. # "#thepub": ["!kieouiJuedJoxtVdaG:localhost"]
  400. #
  401. # # Configuration for virtual matrix users. The following variables are
  402. # # exposed:
  403. # # $NICK => The IRC nick
  404. # # $SERVER => The IRC server address (e.g. "irc.example.com")
  405. # matrixClients:
  406. # # The user ID template to use when creating virtual matrix users. This
  407. # # MUST have $NICK somewhere in it.
  408. # # Optional. Default: "@$SERVER_$NICK".
  409. # # Example: "@irc.example.com_Alice:example.com"
  410. # userTemplate: "@irc_$NICK"
  411. # # The display name to use for created matrix clients. This should have
  412. # # $NICK somewhere in it if it is specified. Can also use $SERVER to
  413. # # insert the IRC domain.
  414. # # Optional. Default: "$NICK (IRC)". Example: "Alice (IRC)"
  415. # displayName: "$NICK (IRC)"
  416. # # Number of tries a client can attempt to join a room before the request
  417. # # is discarded. You can also use -1 to never retry or 0 to never give up.
  418. # # Optional. Default: -1
  419. # joinAttempts: -1
  420. #
  421. # # Configuration for virtual IRC users. The following variables are exposed:
  422. # # $LOCALPART => The user ID localpart ("alice" in @alice:localhost)
  423. # # $USERID => The user ID
  424. # # $DISPLAY => The display name of this user, with excluded characters
  425. # # (e.g. space) removed. If the user has no display name, this
  426. # # falls back to $LOCALPART.
  427. # ircClients:
  428. # # The template to apply to every IRC client nick. This MUST have either
  429. # # $DISPLAY or $USERID or $LOCALPART somewhere in it.
  430. # # Optional. Default: "M-$DISPLAY". Example: "M-Alice".
  431. # nickTemplate: "$DISPLAY[m]"
  432. # # True to allow virtual IRC clients to change their nick on this server
  433. # # by issuing !nick <server> <nick> commands to the IRC AS bot.
  434. # # This is completely freeform: it will NOT follow the nickTemplate.
  435. # allowNickChanges: true
  436. # # The max number of IRC clients that will connect. If the limit is
  437. # # reached, the client that spoke the longest time ago will be
  438. # # disconnected and replaced.
  439. # # Optional. Default: 30.
  440. # maxClients: 30
  441. # # IPv6 configuration.
  442. # ipv6:
  443. # # Optional. Set to true to force IPv6 for outgoing connections.
  444. # only: false
  445. # # Optional. The IPv6 prefix to use for generating unique addresses for each
  446. # # connected user. If not specified, all users will connect from the same
  447. # # (default) address. This may require additional OS-specific work to allow
  448. # # for the node process to bind to multiple different source addresses
  449. # # e.g IP_FREEBIND on Linux, which requires an LD_PRELOAD with the library
  450. # # https://github.com/matrix-org/freebindfree as Node does not expose setsockopt.
  451. # # prefix: "2001:0db8:85a3::" # modify appropriately
  452. # #
  453. # # The maximum amount of time in seconds that the client can exist
  454. # # without sending another message before being disconnected. Use 0 to
  455. # # not apply an idle timeout. This value is ignored if this IRC server is
  456. # # mirroring matrix membership lists to IRC. Default: 172800 (48 hours)
  457. # idleTimeout: 10800
  458. # # The number of millseconds to wait between consecutive reconnections if a
  459. # # client gets disconnected. Setting to 0 will cause the scheduling to be
  460. # # disabled, i.e. it will be scheduled immediately (with jitter.
  461. # # Otherwise, the scheduling interval will be used such that one client
  462. # # reconnect for this server will be handled every reconnectIntervalMs ms using
  463. # # a FIFO queue.
  464. # # Default: 5000 (5 seconds)
  465. # reconnectIntervalMs: 5000
  466. # # The number of concurrent reconnects if a user has been disconnected unexpectedly
  467. # # (e.g. a netsplit). You should set this to a reasonably high number so that
  468. # # bridges are not waiting an eternity to reconnect all its clients if
  469. # # we see a massive number of disconnect. This is unrelated to the reconnectIntervalMs
  470. # # setting above which is for connecting on restart of the bridge. Set to 0 to
  471. # # immediately try to reconnect all users.
  472. # # Default: 50
  473. # concurrentReconnectLimit: 50
  474. # # The number of lines to allow being sent by the IRC client that has received
  475. # # a large block of text to send from matrix. If the number of lines that would
  476. # # be sent is > lineLimit, the text will instead be uploaded to matrix and the
  477. # # resulting URI is treated as a file. As such, a link will be sent to the IRC
  478. # # side instead of potentially spamming IRC and getting the IRC client kicked.
  479. # # Default: 3.
  480. # lineLimit: 3
  481. # # A list of user modes to set on every IRC client. For example, "RiG" would set
  482. # # +R, +i and +G on every IRC connection when they have successfully connected.
  483. # # User modes vary wildly depending on the IRC network you're connecting to,
  484. # # so check before setting this value. Some modes may not work as intended
  485. # # through the bridge e.g. caller ID as there is no way to /ACCEPT.
  486. # # Default: "" (no user modes)
  487. # # userModes: "R"
  488. #
  489. # # Configuration for an ident server. If you are running a public bridge it is
  490. # # advised you setup an ident server so IRC mods can ban specific matrix users
  491. # # rather than the application service itself.
  492. # ident:
  493. # # True to listen for Ident requests and respond with the
  494. # # matrix user's user_id (converted to ASCII, respecting RFC 1413).
  495. # # Default: false.
  496. # enabled: false
  497. # # The port to listen on for incoming ident requests.
  498. # # Ports below 1024 require root to listen on, and you may not want this to
  499. # # run as root. Instead, you can get something like an Apache to yank up
  500. # # incoming requests to 113 to a high numbered port. Set the port to listen
  501. # # on instead of 113 here.
  502. # # Default: 113.
  503. # port: 1113
  504. # # The address to listen on for incoming ident requests.
  505. # # Default: 0.0.0.0
  506. # address: "::"
  507. #
  508. # # Configuration for logging. Optional. Default: console debug level logging
  509. # # only.
  510. # logging:
  511. # # Level to log on console/logfile. One of error|warn|info|debug
  512. # level: "debug"
  513. # # The file location to log to. This is relative to the project directory.
  514. # logfile: "debug.log"
  515. # # The file location to log errors to. This is relative to the project
  516. # # directory.
  517. # errfile: "errors.log"
  518. # # Whether to log to the console or not.
  519. # toConsole: true
  520. # # The max number of files to keep. Files will be overwritten eventually due
  521. # # to rotations.
  522. # maxFiles: 5
  523. #
  524. # # Optional. Enable Prometheus metrics. If this is enabled, you MUST install `prom-client`:
  525. # # $ npm install prom-client@6.3.0
  526. # # Metrics will then be available via GET /metrics on the bridge listening port (-p).
  527. # metrics:
  528. # # Whether to actually enable the metric endpoint. Default: false
  529. # enabled: true
  530. # # When collecting remote user active times, which "buckets" should be used. Defaults are given below.
  531. # # The bucket name is formed of a duration and a period. (h=hours,d=days,w=weeks).
  532. # remoteUserAgeBuckets:
  533. # - "1h"
  534. # - "1d"
  535. # - "1w"
  536. #
  537. # # Configuration options for the debug HTTP API. To access this API, you must
  538. # # append ?access_token=$APPSERVICE_TOKEN (from the registration file) to the requests.
  539. # #
  540. # # The debug API exposes the following endpoints:
  541. # #
  542. # # GET /irc/$domain/user/$user_id => Return internal state for the IRC client for this user ID.
  543. # #
  544. # # POST /irc/$domain/user/$user_id => Issue a raw IRC command down this connection.
  545. # # Format: new line delimited commands as per IRC protocol.
  546. # #
  547. # debugApi:
  548. # # True to enable the HTTP API endpoint. Default: false.
  549. # enabled: false
  550. # # The port to host the HTTP API.
  551. # port: 11100
  552. #
  553. # # Configuration for the provisioning API.
  554. # #
  555. # # GET /_matrix/provision/link
  556. # # GET /_matrix/provision/unlink
  557. # # GET /_matrix/provision/listlinks
  558. # #
  559. # provisioning:
  560. # # True to enable the provisioning HTTP endpoint. Default: false.
  561. # enabled: false
  562. # # The number of seconds to wait before giving up on getting a response from
  563. # # an IRC channel operator. If the channel operator does not respond within the
  564. # # allotted time period, the provisioning request will fail.
  565. # # Default: 300 seconds (5 mins)
  566. # requestTimeoutSeconds: 300
  567. #
  568. # # WARNING: The bridge needs to send plaintext passwords to the IRC server, it cannot
  569. # # send a password hash. As a result, passwords (NOT hashes) are stored encrypted in
  570. # # the database.
  571. # #
  572. matrix_appservice_irc_configuration_extension: "{{ matrix_appservice_irc_configuration_extension_yaml|from_yaml if matrix_appservice_irc_configuration_extension_yaml|from_yaml else {} }}"
  573. matrix_appservice_irc_configuration: "{{ matrix_appservice_irc_configuration_yaml|from_yaml|combine(matrix_appservice_irc_configuration_extension, recursive=True) }}"