Matrix Docker Ansible eploy
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
 
 

225 líneas
14 KiB

  1. # SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev
  2. # SPDX-FileCopyrightText: 2023 Nikita Chernyi
  3. # SPDX-FileCopyrightText: 2024 MDAD project contributors
  4. #
  5. # SPDX-License-Identifier: AGPL-3.0-or-later
  6. ---
  7. # matrix-appservice-kakaotalk is a Matrix <-> Kakaotalk bridge
  8. # Project source code URL: https://src.miscworks.net/fair/matrix-appservice-kakaotalk/
  9. matrix_appservice_kakaotalk_enabled: true
  10. # No images are published for neither of the container images (appservice or node), so we're self-building everything.
  11. matrix_appservice_kakaotalk_container_image_self_build: true
  12. # matrix_appservice_kakaotalk_container_image_self_build_repo: "https://src.miscworks.net/fair/matrix-appservice-kakaotalk.git"
  13. #
  14. # hnarjis' fork is used instead of upstream (fair's), because upstream is currently broken.
  15. # The following error happens when chatting up the bot without this fix:
  16. # [2022-07-25 09:04:53,784] [ERROR@mau.as] Exception in Matrix event handler
  17. # Traceback (most recent call last):
  18. # File "/usr/lib/python3.9/site-packages/mautrix/appservice/as_handler.py", line 239, in try_handle
  19. # await handler_func(event)
  20. # File "/usr/lib/python3.9/site-packages/mautrix/bridge/matrix.py", line 820, in int_handle_event
  21. # await self.int_handle_invite(evt)
  22. # File "/usr/lib/python3.9/site-packages/mautrix/bridge/matrix.py", line 441, in int_handle_invite
  23. # inviter = await self.bridge.get_user(evt.sender)
  24. # File "/usr/lib/python3.9/site-packages/matrix_appservice_kakaotalk/__main__.py", line 112, in get_user
  25. # return await User.get_by_mxid(user_id, create=create)
  26. # File "/usr/lib/python3.9/site-packages/mautrix/util/async_getter_lock.py", line 60, in wrapper
  27. # return await fn(cls, *args, **kwargs)
  28. # File "/usr/lib/python3.9/site-packages/matrix_appservice_kakaotalk/user.py", line 227, in get_by_mxid
  29. # user = cls(mxid)
  30. # TypeError: __init__() missing 2 required positional arguments: 'force_login' and 'was_connected'
  31. matrix_appservice_kakaotalk_container_image_self_build_repo: "https://src.miscworks.net/hnarjis/matrix-appservice-kakaotalk.git"
  32. matrix_appservice_kakaotalk_container_image_self_build_repo_version: "{{ 'master' if matrix_appservice_kakaotalk_version == 'latest' else matrix_appservice_kakaotalk_version }}"
  33. matrix_appservice_kakaotalk_node_version: "{{ matrix_appservice_kakaotalk_version }}"
  34. matrix_appservice_kakaotalk_node_docker_image: "{{ matrix_appservice_kakaotalk_node_docker_image_registry_prefix }}fair/matrix-appservice-kakaotalk-node:{{ matrix_appservice_kakaotalk_node_version }}"
  35. matrix_appservice_kakaotalk_node_docker_image_registry_prefix: "{{ 'localhost/' if matrix_appservice_kakaotalk_container_image_self_build else matrix_appservice_kakaotalk_node_docker_image_registry_prefix_upstream }}"
  36. matrix_appservice_kakaotalk_node_docker_image_registry_prefix_upstream: "{{ matrix_appservice_kakaotalk_node_docker_image_registry_prefix_upstream_default }}"
  37. matrix_appservice_kakaotalk_node_docker_image_registry_prefix_upstream_default: ""
  38. matrix_appservice_kakaotalk_node_docker_image_force_pull: "{{ matrix_appservice_kakaotalk_node_docker_image.endswith(':latest') }}"
  39. matrix_appservice_kakaotalk_version: 86c038fd2ffee5e0aebf65136f085cce7e38b54e
  40. matrix_appservice_kakaotalk_docker_image: "{{ matrix_appservice_kakaotalk_docker_image_registry_prefix }}fair/matrix-appservice-kakaotalk:{{ matrix_appservice_kakaotalk_version }}"
  41. matrix_appservice_kakaotalk_docker_image_registry_prefix: "{{ 'localhost/' if matrix_appservice_kakaotalk_container_image_self_build else matrix_appservice_kakaotalk_docker_image_registry_prefix_upstream }}"
  42. matrix_appservice_kakaotalk_docker_image_registry_prefix_upstream: "{{ matrix_appservice_kakaotalk_docker_image_registry_prefix_upstream_default }}"
  43. matrix_appservice_kakaotalk_docker_image_registry_prefix_upstream_default: ""
  44. matrix_appservice_kakaotalk_docker_image_force_pull: "{{ matrix_appservice_kakaotalk_docker_image.endswith(':latest') }}"
  45. matrix_appservice_kakaotalk_base_path: "{{ matrix_base_data_path }}/appservice-kakaotalk"
  46. matrix_appservice_kakaotalk_config_path: "{{ matrix_appservice_kakaotalk_base_path }}/config"
  47. matrix_appservice_kakaotalk_data_path: "{{ matrix_appservice_kakaotalk_base_path }}/data"
  48. matrix_appservice_kakaotalk_docker_src_files_path: "{{ matrix_appservice_kakaotalk_base_path }}/docker-src"
  49. matrix_appservice_kakaotalk_command_prefix: "!kt"
  50. matrix_appservice_kakaotalk_homeserver_address: ""
  51. matrix_appservice_kakaotalk_homeserver_domain: '{{ matrix_domain }}'
  52. matrix_appservice_kakaotalk_appservice_address: 'http://matrix-appservice-kakaotalk:11115'
  53. # A list of extra arguments to pass to the appservice-kakaotalk container
  54. matrix_appservice_kakaotalk_container_extra_arguments: []
  55. # List of systemd services that matrix-appservice-kakaotalk.service depends on.
  56. matrix_appservice_kakaotalk_systemd_required_services_list: "{{ matrix_appservice_kakaotalk_systemd_required_services_list_default + matrix_appservice_kakaotalk_systemd_required_services_list_auto + matrix_appservice_kakaotalk_systemd_required_services_list_custom }}"
  57. matrix_appservice_kakaotalk_systemd_required_services_list_default: |-
  58. {{
  59. ([devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [])
  60. +
  61. ['matrix-appservice-kakaotalk-node.service']
  62. }}
  63. matrix_appservice_kakaotalk_systemd_required_services_list_auto: []
  64. matrix_appservice_kakaotalk_systemd_required_services_list_custom: []
  65. # List of systemd services that matrix-appservice-kakaotalk.service wants
  66. matrix_appservice_kakaotalk_systemd_wanted_services_list: []
  67. matrix_appservice_kakaotalk_container_network: ""
  68. matrix_appservice_kakaotalk_container_additional_networks: "{{ matrix_appservice_kakaotalk_container_additional_networks_auto + matrix_appservice_kakaotalk_container_additional_networks_custom }}"
  69. matrix_appservice_kakaotalk_container_additional_networks_auto: []
  70. matrix_appservice_kakaotalk_container_additional_networks_custom: []
  71. # A list of extra arguments to pass to the appservice-kakaotalk-node container
  72. matrix_appservice_kakaotalk_node_container_extra_arguments: []
  73. # List of systemd services that matrix-appservice-kakaotalk-node.service depends on.
  74. matrix_appservice_kakaotalk_node_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
  75. # List of systemd services that matrix-appservice-kakaotalk-node.service wants
  76. matrix_appservice_kakaotalk_node_systemd_wanted_services_list: []
  77. matrix_appservice_kakaotalk_appservice_token: ''
  78. matrix_appservice_kakaotalk_homeserver_token: ''
  79. # Whether or not created rooms should have federation enabled.
  80. # If false, created portal rooms will never be federated.
  81. matrix_appservice_kakaotalk_federate_rooms: true
  82. # Database-related configuration fields.
  83. #
  84. # To use SQLite:
  85. # - change the engine (`matrix_appservice_kakaotalk_database_engine: 'sqlite'`)
  86. # To use Postgres:
  87. # - adjust your database credentials via the `matrix_appservice_kakaotalk_database_*` variables
  88. matrix_appservice_kakaotalk_database_engine: 'postgres'
  89. matrix_appservice_kakaotalk_sqlite_database_path_local: "{{ matrix_appservice_kakaotalk_data_path }}/appservice-kakaotalk.db"
  90. matrix_appservice_kakaotalk_sqlite_database_path_in_container: "/data/appservice-kakaotalk.db"
  91. matrix_appservice_kakaotalk_database_username: 'matrix_appservice_kakaotalk'
  92. matrix_appservice_kakaotalk_database_password: 'some-password'
  93. matrix_appservice_kakaotalk_database_hostname: ''
  94. matrix_appservice_kakaotalk_database_port: 5432
  95. matrix_appservice_kakaotalk_database_name: 'matrix_appservice_kakaotalk'
  96. matrix_appservice_kakaotalk_database_connection_string: 'postgres://{{ matrix_appservice_kakaotalk_database_username }}:{{ matrix_appservice_kakaotalk_database_password }}@{{ matrix_appservice_kakaotalk_database_hostname }}:{{ matrix_appservice_kakaotalk_database_port }}/{{ matrix_appservice_kakaotalk_database_name }}'
  97. matrix_appservice_kakaotalk_appservice_database: "{{
  98. {
  99. 'sqlite': ('sqlite:///' + matrix_appservice_kakaotalk_sqlite_database_path_in_container),
  100. 'postgres': matrix_appservice_kakaotalk_database_connection_string,
  101. }[matrix_appservice_kakaotalk_database_engine]
  102. }}"
  103. # Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
  104. # Also see: matrix_appservice_kakaotalk_bridge_login_shared_secret_map
  105. matrix_appservice_kakaotalk_login_shared_secret: ''
  106. matrix_appservice_kakaotalk_bridge_login_shared_secret_map: "{{ {matrix_appservice_kakaotalk_homeserver_domain: matrix_appservice_kakaotalk_login_shared_secret} if matrix_appservice_kakaotalk_login_shared_secret else {} }}"
  107. matrix_appservice_kakaotalk_bridge_relay_enabled: "{{ matrix_bridges_relay_enabled }}"
  108. matrix_appservice_kakaotalk_bridge_permissions: |
  109. {{
  110. {matrix_appservice_kakaotalk_homeserver_domain: 'user'}
  111. | combine({matrix_admin: 'admin'} if matrix_admin else {})
  112. }}
  113. matrix_appservice_kakaotalk_appservice_bot_username: kakaotalkbot
  114. matrix_appservice_kakaotalk_user_prefix: 'kakaotalk_'
  115. # End-to-bridge encryption configuration
  116. matrix_appservice_kakaotalk_bridge_encryption_allow: "{{ matrix_bridges_encryption_enabled }}"
  117. matrix_appservice_kakaotalk_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}"
  118. # Specifies the default log level for all bridge loggers.
  119. matrix_appservice_kakaotalk_logging_level: WARNING
  120. # Default configuration template which covers the generic use case.
  121. # You can customize it by controlling the various variables inside it.
  122. #
  123. # For a more advanced customization, you can extend the default (see `matrix_appservice_kakaotalk_configuration_extension_yaml`)
  124. # or completely replace this variable with your own template.
  125. matrix_appservice_kakaotalk_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
  126. matrix_appservice_kakaotalk_configuration_extension_yaml: |
  127. # Your custom YAML configuration goes here.
  128. # This configuration extends the default starting configuration (`matrix_appservice_kakaotalk_configuration_yaml`).
  129. #
  130. # You can override individual variables from the default configuration, or introduce new ones.
  131. #
  132. # If you need something more special, you can take full control by
  133. # completely redefining `matrix_appservice_kakaotalk_configuration_yaml`.
  134. matrix_appservice_kakaotalk_configuration_extension: "{{ matrix_appservice_kakaotalk_configuration_extension_yaml | from_yaml if matrix_appservice_kakaotalk_configuration_extension_yaml | from_yaml is mapping else {} }}"
  135. # Holds the final configuration (a combination of the default and its extension).
  136. # You most likely don't need to touch this variable. Instead, see `matrix_appservice_kakaotalk_configuration_yaml`.
  137. matrix_appservice_kakaotalk_configuration: "{{ matrix_appservice_kakaotalk_configuration_yaml | from_yaml | combine(matrix_appservice_kakaotalk_configuration_extension, recursive=True) }}"
  138. # Default configuration template which covers the generic use case.
  139. # You can customize it by controlling the various variables inside it.
  140. #
  141. # For a more advanced customization, you can extend the default (see `matrix_appservice_kakaotalk_node_configuration_extension_yaml`)
  142. # or completely replace this variable with your own template.
  143. #
  144. # The side-effect of this lookup is that Ansible would even parse the JSON for us, returning a dict.
  145. # This is unlike what it does when looking up YAML template files (no automatic parsing there).
  146. matrix_appservice_kakaotalk_node_configuration_default: "{{ lookup('template', 'templates/node-config.json.j2') }}"
  147. # Your custom JSON configuration for appservice-kakaotalk-node should go to `matrix_appservice_kakaotalk_node_configuration_extension_json`.
  148. # This configuration extends the default starting configuration (`matrix_appservice_kakaotalk_node_configuration_default`).
  149. #
  150. # You can override individual variables from the default configuration, or introduce new ones.
  151. #
  152. # If you need something more special, you can take full control by
  153. # completely redefining `matrix_appservice_kakaotalk_node_configuration_default`.
  154. #
  155. # Example configuration extension follows:
  156. #
  157. # matrix_appservice_kakaotalk_node_configuration_extension_json: |
  158. # {
  159. # "register_timeout": 5000
  160. # }
  161. matrix_appservice_kakaotalk_node_configuration_extension_json: '{}'
  162. matrix_appservice_kakaotalk_node_configuration_extension: "{{ matrix_appservice_kakaotalk_node_configuration_extension_json | from_json if matrix_appservice_kakaotalk_node_configuration_extension_json | from_json is mapping else {} }}"
  163. # Holds the final appservice-kakaotalk-node configuration (a combination of the default and its extension).
  164. # You most likely don't need to touch this variable. Instead, see `matrix_appservice_kakaotalk_node_configuration_default`.
  165. matrix_appservice_kakaotalk_node_configuration: "{{ matrix_appservice_kakaotalk_node_configuration_default | combine(matrix_appservice_kakaotalk_node_configuration_extension, recursive=True) }}"
  166. matrix_appservice_kakaotalk_registration_yaml: |
  167. id: appservice-kakaotalk
  168. as_token: {{ matrix_appservice_kakaotalk_appservice_token | to_json }}
  169. hs_token: {{ matrix_appservice_kakaotalk_homeserver_token | to_json }}
  170. namespaces:
  171. users:
  172. - exclusive: true
  173. regex: '^@{{ matrix_appservice_kakaotalk_user_prefix | regex_escape }}.*:{{ matrix_appservice_kakaotalk_homeserver_domain | regex_escape }}$'
  174. - exclusive: true
  175. regex: '^@{{ matrix_appservice_kakaotalk_appservice_bot_username | regex_escape }}:{{ matrix_appservice_kakaotalk_homeserver_domain | regex_escape }}$'
  176. url: {{ matrix_appservice_kakaotalk_appservice_address | to_json }}
  177. sender_localpart: _appservice_kakaotalk
  178. rate_limited: false
  179. matrix_appservice_kakaotalk_registration: "{{ matrix_appservice_kakaotalk_registration_yaml | from_yaml }}"