2022-02-05 20:32:54 +00:00
---
2020-04-12 14:17:30 +00:00
# Mx Puppet Slack is a Matrix <-> Slack bridge
2022-03-17 20:16:17 +00:00
# See: https://gitlab.com/beeper/mx-puppet-monorepo (originally based on https://github.com/Sorunome/mx-puppet-slack)
2020-04-12 14:17:30 +00:00
matrix_mx_puppet_slack_enabled : true
2022-01-28 01:00:27 +00:00
matrix_mx_puppet_slack_oauth_client_id : ''
matrix_mx_puppet_slack_oauth_client_secret : ''
2020-04-12 14:17:30 +00:00
matrix_mx_puppet_slack_container_image_self_build : false
2022-03-17 20:16:17 +00:00
matrix_mx_puppet_slack_container_image_self_build_repo : "https://gitlab.com/beeper/mx-puppet-monorepo.git"
matrix_mx_puppet_slack_container_image_self_build_version : "{{ 'main' if matrix_mx_puppet_slack_version == 'latest' else matrix_mx_puppet_slack_version }}"
matrix_mx_puppet_slack_container_image_self_build_dockerfile_path : "docker/Dockerfile-slack"
2020-04-12 14:17:30 +00:00
2020-05-22 08:12:06 +00: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 : ''
2021-02-20 17:08:28 +00:00
matrix_mx_puppet_slack_version : latest
2022-03-17 20:16:17 +00:00
matrix_mx_puppet_slack_docker_image : "{{ matrix_mx_puppet_slack_docker_image_name_prefix }}beeper/mx-puppet-monorepo/slack:{{ matrix_mx_puppet_slack_version }}"
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 14:17:30 +00: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"
2021-01-25 11:55:08 +00:00
matrix_mx_puppet_slack_homeserver_address : "{{ matrix_homeserver_container_url }}"
2020-04-12 14:17:30 +00: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 }}'
matrix_mx_puppet_slack_redirect_path : '/slack/oauth'
matrix_mx_puppet_slack_redirect_uri : 'https://{{ matrix_server_fqn_matrix }}{{ matrix_mx_puppet_slack_redirect_path }}'
# "@user:server.com" to allow specific user
# "@.*:yourserver.com" to allow users on a specific homeserver
# "@.*" to allow anyone
matrix_mx_puppet_slack_provisioning_whitelist :
- "@.*:{{ matrix_domain|regex_escape }}"
# Leave empty to disable blacklist
# "@user:server.com" disallow a specific user
# "@.*:yourserver.com" disallow users on a specific homeserver
matrix_mx_puppet_slack_provisioning_blacklist : [ ]
# 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.
matrix_mx_puppet_slack_systemd_required_services_list : [ 'docker.service' ]
# 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 09:10:13 +00: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 : ''
2020-12-14 11:38:51 +00: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 14:39:21 +00: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 11:38:51 +00:00
matrix_mx_puppet_slack_database_username : matrix_mx_puppet_slack
matrix_mx_puppet_slack_database_password : ~
matrix_mx_puppet_slack_database_hostname : 'matrix-postgres'
matrix_mx_puppet_slack_database_port : 5432
2020-12-22 15:10:02 +00:00
matrix_mx_puppet_slack_database_name : matrix_mx_puppet_slack
2020-12-22 14:39:21 +00:00
2020-12-22 15:10:02 +00: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=disable'
2020-12-14 11:38:51 +00:00
2020-04-12 14:17:30 +00: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 06:33:28 +00:00
matrix_mx_puppet_slack_configuration_yaml : "{{ lookup('template', 'templates/config.yaml.j2') }}"
2020-04-12 14:17:30 +00: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`.
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 {} }}"
# 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`.
matrix_mx_puppet_slack_configuration : "{{ matrix_mx_puppet_slack_configuration_yaml|from_yaml|combine(matrix_mx_puppet_slack_configuration_extension, recursive=True) }}"
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
regex : '@_slackpuppet_.*:{{ matrix_mx_puppet_slack_homeserver_domain|regex_escape }}'
rooms : [ ]
aliases :
- exclusive : true
regex : '#_slackpuppet_.*:{{ matrix_mx_puppet_slack_homeserver_domain|regex_escape }}'
protocols : [ ]
rate_limited : false
sender_localpart : _slackpuppet_bot
url : {{ matrix_mx_puppet_slack_appservice_address }}
2021-03-25 17:49:43 +00:00
de.sorunome.msc2409.push_ephemeral : true
2020-04-12 14:17:30 +00:00
matrix_mx_puppet_slack_registration : "{{ matrix_mx_puppet_slack_registration_yaml|from_yaml }}"