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

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