2022-02-05 21:32:54 +01:00
|
|
|
---
|
2020-04-12 16:17:30 +02:00
|
|
|
# Mx Puppet Slack is a Matrix <-> Slack bridge
|
2022-07-16 22:59:21 +02:00
|
|
|
# Project source code URL: https://gitlab.com/mx-puppet/slack/mx-puppet-slack
|
2020-04-12 16:17:30 +02:00
|
|
|
|
|
|
|
matrix_mx_puppet_slack_enabled: true
|
|
|
|
|
2024-01-08 16:34:38 +01:00
|
|
|
matrix_mx_puppet_slack_scheme: https
|
|
|
|
matrix_mx_puppet_slack_hostname: ''
|
|
|
|
matrix_mx_puppet_slack_path_prefix: /slack/oauth
|
|
|
|
|
2022-01-28 02:00:27 +01:00
|
|
|
matrix_mx_puppet_slack_oauth_client_id: ''
|
|
|
|
matrix_mx_puppet_slack_oauth_client_secret: ''
|
|
|
|
|
2020-04-12 16:17:30 +02:00
|
|
|
matrix_mx_puppet_slack_container_image_self_build: false
|
2022-05-14 21:07:57 +02:00
|
|
|
matrix_mx_puppet_slack_container_image_self_build_repo: "https://gitlab.com/mx-puppet/slack/mx-puppet-slack.git"
|
2022-03-17 21:16:17 +01:00
|
|
|
matrix_mx_puppet_slack_container_image_self_build_version: "{{ 'main' if matrix_mx_puppet_slack_version == 'latest' else matrix_mx_puppet_slack_version }}"
|
2022-05-14 21:07:57 +02:00
|
|
|
matrix_mx_puppet_slack_container_image_self_build_dockerfile_path: "Dockerfile"
|
2020-04-12 16:17:30 +02:00
|
|
|
|
2020-05-22 10:12:06 +02:00
|
|
|
# Controls whether the mx-puppet-slack container exposes its HTTP port (tcp/8432 in the container).
|
|
|
|
#
|
|
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8432"), or empty string to not expose.
|
|
|
|
matrix_mx_puppet_slack_container_http_host_bind_port: ''
|
|
|
|
|
2023-10-06 14:14:03 +02:00
|
|
|
# renovate: datasource=docker depName=registry.gitlab.com/mx-puppet/slack/mx-puppet-slack
|
2022-05-16 20:40:31 +02:00
|
|
|
matrix_mx_puppet_slack_version: v0.1.2
|
2022-05-14 21:07:57 +02:00
|
|
|
matrix_mx_puppet_slack_docker_image: "{{ matrix_mx_puppet_slack_docker_image_name_prefix }}mx-puppet/slack/mx-puppet-slack:{{ matrix_mx_puppet_slack_version }}"
|
2022-03-17 21:16:17 +01:00
|
|
|
matrix_mx_puppet_slack_docker_image_name_prefix: "{{ 'localhost/' if matrix_mx_puppet_slack_container_image_self_build else 'registry.gitlab.com/' }}"
|
2020-04-12 16:17:30 +02:00
|
|
|
matrix_mx_puppet_slack_docker_image_force_pull: "{{ matrix_mx_puppet_slack_docker_image.endswith(':latest') }}"
|
|
|
|
|
|
|
|
matrix_mx_puppet_slack_base_path: "{{ matrix_base_data_path }}/mx-puppet-slack"
|
|
|
|
matrix_mx_puppet_slack_config_path: "{{ matrix_mx_puppet_slack_base_path }}/config"
|
|
|
|
matrix_mx_puppet_slack_data_path: "{{ matrix_mx_puppet_slack_base_path }}/data"
|
|
|
|
matrix_mx_puppet_slack_docker_src_files_path: "{{ matrix_mx_puppet_slack_base_path }}/docker-src"
|
|
|
|
|
|
|
|
matrix_mx_puppet_slack_appservice_port: "8432"
|
|
|
|
|
2024-01-07 16:04:23 +01:00
|
|
|
matrix_mx_puppet_slack_homeserver_address: ""
|
2020-04-12 16:17:30 +02:00
|
|
|
matrix_mx_puppet_slack_homeserver_domain: '{{ matrix_domain }}'
|
|
|
|
matrix_mx_puppet_slack_appservice_address: 'http://matrix-mx-puppet-slack:{{ matrix_mx_puppet_slack_appservice_port }}'
|
|
|
|
|
2024-01-08 16:34:38 +01:00
|
|
|
matrix_mx_puppet_slack_oauth_enabled: true
|
|
|
|
matrix_mx_puppet_slack_oauth_redirect_path: "{{ matrix_mx_puppet_slack_path_prefix }}"
|
|
|
|
matrix_mx_puppet_slack_oauth_redirect_uri: '{{ matrix_mx_puppet_slack_scheme }}://{{ matrix_mx_puppet_slack_hostname }}{{ matrix_mx_puppet_slack_oauth_redirect_path }}'
|
2020-04-12 16:17:30 +02:00
|
|
|
|
2024-10-19 07:01:08 +02:00
|
|
|
# "@user:example.com" to allow a specific user
|
2024-10-17 19:32:31 +02:00
|
|
|
# "@.*:example.com" to allow users on a specific homeserver
|
2020-04-12 16:17:30 +02:00
|
|
|
# "@.*" to allow anyone
|
|
|
|
matrix_mx_puppet_slack_provisioning_whitelist:
|
2022-07-18 11:28:39 +02:00
|
|
|
- "@.*:{{ matrix_domain | regex_escape }}"
|
2020-04-12 16:17:30 +02:00
|
|
|
|
|
|
|
# Leave empty to disable blacklist
|
2024-10-19 07:01:08 +02:00
|
|
|
# "@user:example.com" to disallow a specific user
|
|
|
|
# "@.*:example.com" to disallow users on a specific homeserver
|
2020-04-12 16:17:30 +02:00
|
|
|
matrix_mx_puppet_slack_provisioning_blacklist: []
|
|
|
|
|
2024-01-08 16:34:38 +01:00
|
|
|
matrix_mx_puppet_slack_container_network: ""
|
|
|
|
|
|
|
|
matrix_mx_puppet_slack_container_additional_networks: "{{ matrix_mx_puppet_slack_container_additional_networks_auto + matrix_mx_puppet_slack_container_additional_networks_custom }}"
|
|
|
|
matrix_mx_puppet_slack_container_additional_networks_auto: []
|
|
|
|
matrix_mx_puppet_slack_container_additional_networks_custom: []
|
|
|
|
|
|
|
|
# matrix_mx_puppet_slack_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_mx_puppet_slack_container_labels_additional_labels`.
|
|
|
|
matrix_mx_puppet_slack_container_labels_traefik_enabled: true
|
|
|
|
matrix_mx_puppet_slack_container_labels_traefik_docker_network: "{{ matrix_mx_puppet_slack_container_network }}"
|
|
|
|
matrix_mx_puppet_slack_container_labels_traefik_entrypoints: web-secure
|
|
|
|
matrix_mx_puppet_slack_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
|
|
|
|
|
|
|
# Controls whether labels will be added that expose mx-puppet-slack's public endpoint
|
|
|
|
matrix_mx_puppet_slack_container_labels_public_endpoint_enabled: true
|
|
|
|
matrix_mx_puppet_slack_container_labels_public_endpoint_hostname: "{{ matrix_mx_puppet_slack_hostname }}"
|
|
|
|
matrix_mx_puppet_slack_container_labels_public_endpoint_path_prefix: "{{ matrix_mx_puppet_slack_path_prefix }}"
|
|
|
|
matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_mx_puppet_slack_container_labels_public_endpoint_hostname }}`) && PathPrefix(`{{ matrix_mx_puppet_slack_container_labels_public_endpoint_path_prefix }}`)"
|
|
|
|
matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_priority: 0
|
|
|
|
matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_mx_puppet_slack_container_labels_traefik_entrypoints }}"
|
|
|
|
matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_tls: "{{ matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_entrypoints != 'web' }}"
|
|
|
|
matrix_mx_puppet_slack_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_mx_puppet_slack_container_labels_traefik_tls_certResolver }}" # noqa var-naming
|
|
|
|
|
|
|
|
# matrix_mx_puppet_slack_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_mx_puppet_slack_container_labels_additional_labels: |
|
|
|
|
# my.label=1
|
|
|
|
# another.label="here"
|
|
|
|
matrix_mx_puppet_slack_container_labels_additional_labels: ''
|
|
|
|
|
2020-04-12 16:17:30 +02:00
|
|
|
# A list of extra arguments to pass to the container
|
|
|
|
matrix_mx_puppet_slack_container_extra_arguments: []
|
|
|
|
|
|
|
|
# List of systemd services that matrix-puppet-slack.service depends on.
|
2024-01-08 16:34:38 +01:00
|
|
|
matrix_mx_puppet_slack_systemd_required_services_list: "{{ matrix_mx_puppet_slack_systemd_required_services_list_default + matrix_mx_puppet_slack_systemd_required_services_list_auto + matrix_mx_puppet_slack_systemd_required_services_list_custom }}"
|
2024-06-04 12:14:34 +02:00
|
|
|
matrix_mx_puppet_slack_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}"
|
2024-01-08 16:34:38 +01:00
|
|
|
matrix_mx_puppet_slack_systemd_required_services_list_auto: []
|
|
|
|
matrix_mx_puppet_slack_systemd_required_services_list_custom: []
|
2020-04-12 16:17:30 +02:00
|
|
|
|
|
|
|
# List of systemd services that matrix-puppet-slack.service wants
|
|
|
|
matrix_mx_puppet_slack_systemd_wanted_services_list: []
|
|
|
|
|
|
|
|
matrix_mx_puppet_slack_appservice_token: ''
|
|
|
|
matrix_mx_puppet_slack_homeserver_token: ''
|
|
|
|
|
2020-06-11 11:10:13 +02:00
|
|
|
# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
|
|
|
|
matrix_mx_puppet_slack_login_shared_secret: ''
|
|
|
|
|
2024-01-08 16:34:38 +01:00
|
|
|
matrix_mx_puppet_slack_presence_enabled: true
|
|
|
|
matrix_mx_puppet_slack_presence_interval: 5000
|
|
|
|
|
2020-12-14 12:38:51 +01:00
|
|
|
# Database configuration, role uses 'sqlite' per default but playbook sets up postgres by default
|
|
|
|
matrix_mx_puppet_slack_database_engine: sqlite
|
2020-12-22 15:39:21 +01:00
|
|
|
|
|
|
|
matrix_mx_puppet_slack_sqlite_database_path_local: "{{ matrix_mx_puppet_slack_data_path }}/database.db"
|
|
|
|
matrix_mx_puppet_slack_sqlite_database_path_in_container: "/data/database.db"
|
|
|
|
|
2020-12-14 12:38:51 +01:00
|
|
|
matrix_mx_puppet_slack_database_username: matrix_mx_puppet_slack
|
|
|
|
matrix_mx_puppet_slack_database_password: ~
|
2022-11-27 07:23:43 +01:00
|
|
|
matrix_mx_puppet_slack_database_hostname: ''
|
2020-12-14 12:38:51 +01:00
|
|
|
matrix_mx_puppet_slack_database_port: 5432
|
2020-12-22 16:10:02 +01:00
|
|
|
matrix_mx_puppet_slack_database_name: matrix_mx_puppet_slack
|
2023-08-22 18:38:11 +02:00
|
|
|
matrix_mx_puppet_slack_database_sslmode: disable
|
2020-12-22 15:39:21 +01:00
|
|
|
|
2023-08-22 18:38:11 +02:00
|
|
|
matrix_mx_puppet_slack_database_connection_string: 'postgresql://{{ matrix_mx_puppet_slack_database_username }}:{{ matrix_mx_puppet_slack_database_password }}@{{ matrix_mx_puppet_slack_database_hostname }}:{{ matrix_mx_puppet_slack_database_port }}/{{ matrix_mx_puppet_slack_database_name }}?sslmode={{ matrix_mx_puppet_slack_database_sslmode }}'
|
2020-12-14 12:38:51 +01:00
|
|
|
|
2020-04-12 16:17:30 +02:00
|
|
|
# Default configuration template which covers the generic use case.
|
|
|
|
# You can customize it by controlling the various variables inside it.
|
|
|
|
#
|
|
|
|
# For a more advanced customization, you can extend the default (see `matrix_mx_puppet_slack_configuration_extension_yaml`)
|
|
|
|
# or completely replace this variable with your own template.
|
2020-06-03 08:33:28 +02:00
|
|
|
matrix_mx_puppet_slack_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
2020-04-12 16:17:30 +02:00
|
|
|
|
|
|
|
matrix_mx_puppet_slack_configuration_extension_yaml: |
|
|
|
|
# Your custom YAML configuration goes here.
|
|
|
|
# This configuration extends the default starting configuration (`matrix_mx_puppet_slack_configuration_yaml`).
|
|
|
|
#
|
|
|
|
# You can override individual variables from the default configuration, or introduce new ones.
|
|
|
|
#
|
|
|
|
# If you need something more special, you can take full control by
|
|
|
|
# completely redefining `matrix_mx_puppet_slack_configuration_yaml`.
|
|
|
|
|
2022-07-18 10:22:05 +02:00
|
|
|
matrix_mx_puppet_slack_configuration_extension: "{{ matrix_mx_puppet_slack_configuration_extension_yaml | from_yaml if matrix_mx_puppet_slack_configuration_extension_yaml | from_yaml is mapping else {} }}"
|
2020-04-12 16:17:30 +02:00
|
|
|
|
|
|
|
# Holds the final configuration (a combination of the default and its extension).
|
|
|
|
# You most likely don't need to touch this variable. Instead, see `matrix_mx_puppet_slack_configuration_yaml`.
|
2022-07-18 11:28:39 +02:00
|
|
|
matrix_mx_puppet_slack_configuration: "{{ matrix_mx_puppet_slack_configuration_yaml | from_yaml | combine(matrix_mx_puppet_slack_configuration_extension, recursive=True) }}"
|
2020-04-12 16:17:30 +02:00
|
|
|
|
|
|
|
matrix_mx_puppet_slack_registration_yaml: |
|
|
|
|
as_token: "{{ matrix_mx_puppet_slack_appservice_token }}"
|
|
|
|
hs_token: "{{ matrix_mx_puppet_slack_homeserver_token }}"
|
|
|
|
id: slack-puppet
|
|
|
|
namespaces:
|
|
|
|
users:
|
|
|
|
- exclusive: true
|
2022-07-18 11:28:39 +02:00
|
|
|
regex: '@_slackpuppet_.*:{{ matrix_mx_puppet_slack_homeserver_domain | regex_escape }}'
|
2020-04-12 16:17:30 +02:00
|
|
|
rooms: []
|
|
|
|
aliases:
|
|
|
|
- exclusive: true
|
2022-07-18 11:28:39 +02:00
|
|
|
regex: '#_slackpuppet_.*:{{ matrix_mx_puppet_slack_homeserver_domain | regex_escape }}'
|
2020-04-12 16:17:30 +02:00
|
|
|
protocols: []
|
|
|
|
rate_limited: false
|
|
|
|
sender_localpart: _slackpuppet_bot
|
|
|
|
url: {{ matrix_mx_puppet_slack_appservice_address }}
|
2021-03-25 18:49:43 +01:00
|
|
|
de.sorunome.msc2409.push_ephemeral: true
|
2020-04-12 16:17:30 +02:00
|
|
|
|
2022-07-18 10:22:05 +02:00
|
|
|
matrix_mx_puppet_slack_registration: "{{ matrix_mx_puppet_slack_registration_yaml | from_yaml }}"
|