2022-06-23 21:57:52 +02:00
|
|
|
---
|
|
|
|
|
2022-07-20 09:07:03 +02:00
|
|
|
# maubot is a plugin-based Matrix bot system.
|
|
|
|
# Project source code URL: https://mau.dev/maubot/maubot
|
|
|
|
|
2022-06-23 21:57:52 +02:00
|
|
|
matrix_bot_maubot_enabled: true
|
2024-01-07 09:16:42 +01:00
|
|
|
|
|
|
|
matrix_bot_maubot_scheme: https
|
|
|
|
matrix_bot_maubot_hostname: ''
|
|
|
|
matrix_bot_maubot_path_prefix: /_matrix/maubot
|
|
|
|
|
2022-06-23 21:57:52 +02:00
|
|
|
matrix_bot_maubot_container_image_self_build: false
|
|
|
|
matrix_bot_maubot_docker_repo: "https://mau.dev/maubot/maubot.git"
|
|
|
|
matrix_bot_maubot_docker_src_files_path: "{{ matrix_bot_maubot_base_path }}/docker-src"
|
2022-07-20 08:55:10 +02:00
|
|
|
matrix_bot_maubot_docker_repo_version: "{{ 'master' if matrix_bot_maubot_version == 'latest' else matrix_bot_maubot_version }}"
|
|
|
|
|
2023-10-06 14:14:03 +02:00
|
|
|
# renovate: datasource=docker depName=dock.mau.dev/maubot/maubot
|
2023-10-01 09:42:37 +02:00
|
|
|
matrix_bot_maubot_version: v0.4.2
|
2023-01-14 14:26:58 +01:00
|
|
|
matrix_bot_maubot_docker_image: "{{ matrix_bot_maubot_docker_image_name_prefix }}maubot/maubot:{{ matrix_bot_maubot_version }}"
|
|
|
|
matrix_bot_maubot_docker_image_name_prefix: "{{ 'localhost/' if matrix_bot_maubot_container_image_self_build else 'dock.mau.dev/' }}"
|
2022-06-23 21:57:52 +02:00
|
|
|
matrix_bot_maubot_docker_image_force_pull: "{{ matrix_bot_maubot_docker_image.endswith(':latest') }}"
|
|
|
|
|
|
|
|
matrix_bot_maubot_base_path: "{{ matrix_base_data_path }}/maubot"
|
|
|
|
matrix_bot_maubot_data_path: "{{ matrix_bot_maubot_base_path }}/data"
|
2022-06-24 11:50:52 +02:00
|
|
|
matrix_bot_maubot_config_path: "{{ matrix_bot_maubot_base_path }}/config"
|
2022-06-23 21:57:52 +02:00
|
|
|
|
2024-01-07 09:16:42 +01:00
|
|
|
matrix_bot_maubot_bot_server_public_url: "{{ matrix_bot_maubot_scheme }}://{{ matrix_bot_maubot_hostname }}"
|
|
|
|
matrix_bot_maubot_bot_server_base_path: "{{ matrix_bot_maubot_path_prefix }}/v1"
|
|
|
|
matrix_bot_maubot_bot_server_ui_base_path: "{{ matrix_bot_maubot_path_prefix }}"
|
|
|
|
matrix_bot_maubot_bot_server_plugin_base_path: "{{ matrix_bot_maubot_path_prefix }}/plugin/"
|
|
|
|
matrix_bot_maubot_bot_server_appservice_base_path: "{{ matrix_bot_maubot_bot_server_base_path }}"
|
|
|
|
|
2022-07-20 11:23:32 +02:00
|
|
|
matrix_bot_maubot_proxy_management_interface: true
|
2022-06-23 21:57:52 +02:00
|
|
|
|
2022-07-09 11:55:49 +02:00
|
|
|
matrix_bot_maubot_database_engine: sqlite
|
|
|
|
matrix_bot_maubot_sqlite_database_path_local: "{{ matrix_bot_maubot_data_path }}/maubot.db"
|
|
|
|
matrix_bot_maubot_sqlite_database_path_in_container: "/data/maubot.db"
|
|
|
|
|
|
|
|
matrix_bot_maubot_database_username: matrix_bot_maubot
|
|
|
|
matrix_bot_maubot_database_password: ~
|
2022-11-27 07:23:43 +01:00
|
|
|
matrix_bot_maubot_database_hostname: ''
|
2022-07-09 11:55:49 +02:00
|
|
|
matrix_bot_maubot_database_port: 5432
|
|
|
|
matrix_bot_maubot_database_name: matrix_bot_maubot
|
2023-08-22 18:38:11 +02:00
|
|
|
matrix_bot_maubot_database_sslmode: disable
|
2022-07-10 09:51:27 +02:00
|
|
|
|
2023-08-22 18:38:11 +02:00
|
|
|
matrix_bot_maubot_database_connection_string: postgres://{{ matrix_bot_maubot_database_username }}:{{ matrix_bot_maubot_database_password }}@{{ matrix_bot_maubot_database_hostname }}:{{ matrix_bot_maubot_database_port }}/{{ matrix_bot_maubot_database_name }}?sslmode={{ matrix_bot_maubot_database_sslmode }}
|
2022-07-10 09:51:27 +02:00
|
|
|
|
|
|
|
matrix_bot_maubot_database_uri: "{{
|
|
|
|
{
|
|
|
|
'sqlite': ('sqlite:///' + matrix_bot_maubot_sqlite_database_path_in_container),
|
|
|
|
'postgres': matrix_bot_maubot_database_connection_string,
|
|
|
|
}[matrix_bot_maubot_database_engine]
|
|
|
|
}}"
|
2022-07-09 11:55:49 +02:00
|
|
|
|
2022-07-10 13:33:29 +02:00
|
|
|
# Defines the port number where the management interface is
|
2024-01-07 09:16:42 +01:00
|
|
|
# To actually expose the management interface outside of the container, use `matrix_bot_maubot_container_management_interface_http_bind_port`
|
|
|
|
matrix_bot_maubot_server_port: 29316
|
|
|
|
|
|
|
|
matrix_bot_maubot_unshared_secret: 'generate'
|
|
|
|
|
2024-01-13 17:04:21 +01:00
|
|
|
matrix_bot_maubot_homeserver_name: "{{ matrix_domain }}"
|
|
|
|
matrix_bot_maubot_homeserver_url: ""
|
|
|
|
matrix_bot_maubot_homeserver_secret: ""
|
|
|
|
|
2024-01-13 17:00:19 +01:00
|
|
|
matrix_bot_maubot_admins: []
|
|
|
|
|
2024-01-07 09:16:42 +01:00
|
|
|
# Specifies the default log level for all bot loggers.
|
|
|
|
matrix_bot_maubot_logging_level: WARNING
|
2022-07-10 13:33:29 +02:00
|
|
|
|
|
|
|
# Controls whether the maubot container exposes its HTTP management interface port (tcp/29316 in the container).
|
|
|
|
#
|
|
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:29316"), or empty string to not expose.
|
2024-01-07 09:16:42 +01:00
|
|
|
# If you'll be setting this at all, it should be defined in terms of `matrix_bot_maubot_server_port`.
|
2022-07-10 13:33:29 +02:00
|
|
|
# Example:
|
2024-01-07 09:16:42 +01:00
|
|
|
# matrix_bot_maubot_container_management_interface_http_bind_port: "127.0.0.1:{{ matrix_bot_maubot_server_port }}"
|
|
|
|
matrix_bot_maubot_container_management_interface_http_bind_port: ''
|
2022-07-10 13:33:29 +02:00
|
|
|
|
2024-01-07 09:16:42 +01:00
|
|
|
matrix_bot_maubot_container_network: ""
|
2022-07-10 13:33:29 +02:00
|
|
|
|
2024-01-07 09:16:42 +01:00
|
|
|
matrix_bot_maubot_container_additional_networks: "{{ matrix_bot_maubot_container_additional_networks_auto + matrix_bot_maubot_container_additional_networks_custom }}"
|
|
|
|
matrix_bot_maubot_container_additional_networks_auto: []
|
|
|
|
matrix_bot_maubot_container_additional_networks_custom: []
|
2022-06-23 21:57:52 +02:00
|
|
|
|
2024-01-07 09:16:42 +01:00
|
|
|
# matrix_bot_maubot_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container.
|
|
|
|
# See `../templates/labels.j2` for details.
|
|
|
|
#
|
|
|
|
# To inject your own other container labels, see `matrix_bot_maubot_container_labels_additional_labels`.
|
|
|
|
matrix_bot_maubot_container_labels_traefik_enabled: true
|
|
|
|
matrix_bot_maubot_container_labels_traefik_docker_network: "{{ matrix_bot_maubot_container_network }}"
|
|
|
|
matrix_bot_maubot_container_labels_traefik_entrypoints: web-secure
|
|
|
|
matrix_bot_maubot_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
|
|
|
|
|
|
|
# Controls whether labels will be added that expose maubot's management endpoints
|
|
|
|
matrix_bot_maubot_container_labels_management_enabled: true
|
|
|
|
matrix_bot_maubot_container_labels_management_hostname: "{{ matrix_bot_maubot_hostname }}"
|
|
|
|
matrix_bot_maubot_container_labels_management_prefix: "{{ matrix_bot_maubot_path_prefix }}"
|
|
|
|
matrix_bot_maubot_container_labels_management_traefik_rule: "Host(`{{ matrix_bot_maubot_container_labels_management_hostname }}`) && PathPrefix(`{{ matrix_bot_maubot_path_prefix }}`)"
|
|
|
|
matrix_bot_maubot_container_labels_management_traefik_priority: 0
|
|
|
|
matrix_bot_maubot_container_labels_management_traefik_entrypoints: "{{ matrix_bot_maubot_container_labels_traefik_entrypoints }}"
|
|
|
|
matrix_bot_maubot_container_labels_management_traefik_tls: "{{ matrix_bot_maubot_container_labels_management_traefik_entrypoints != 'web' }}"
|
|
|
|
matrix_bot_maubot_container_labels_management_traefik_tls_certResolver: "{{ matrix_bot_maubot_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
|
|
|
|
|
|
# matrix_bot_maubot_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file.
|
|
|
|
# See `../templates/labels.j2` for details.
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
# matrix_bot_maubot_container_labels_additional_labels: |
|
|
|
|
# my.label=1
|
|
|
|
# another.label="here"
|
|
|
|
matrix_bot_maubot_container_labels_additional_labels: ''
|
2022-07-20 12:03:50 +02:00
|
|
|
|
2022-06-23 21:57:52 +02:00
|
|
|
# A list of extra arguments to pass to the container
|
|
|
|
matrix_bot_maubot_container_extra_arguments: []
|
|
|
|
|
2022-06-24 13:15:34 +02:00
|
|
|
# List of systemd services that matrix-bot-maubot.service depends on
|
2024-01-07 09:16:42 +01:00
|
|
|
matrix_bot_maubot_systemd_required_services_list: "{{ matrix_bot_maubot_systemd_required_services_list_default + matrix_bot_maubot_systemd_required_services_list_auto + matrix_bot_maubot_systemd_required_services_list_custom }}"
|
|
|
|
matrix_bot_maubot_systemd_required_services_list_default: ['docker.service']
|
|
|
|
matrix_bot_maubot_systemd_required_services_list_auto: []
|
|
|
|
matrix_bot_maubot_systemd_required_services_list_custom: []
|
2022-06-23 21:57:52 +02:00
|
|
|
|
2022-06-24 13:15:34 +02:00
|
|
|
# List of systemd services that matrix-bot-maubot.service wants
|
2022-06-23 21:57:52 +02:00
|
|
|
matrix_bot_maubot_systemd_wanted_services_list: []
|