7ae70c27e6
The OAuth credentials method seems to be the only viable way to configure the mx-puppet-bridge now. Legacy tokens can no longer be created, and the other methods (xoxs and xoxc tokens) come with warnings about them being against Slack's terms of service.
117 lines
6.0 KiB
YAML
117 lines
6.0 KiB
YAML
# Mx Puppet Slack is a Matrix <-> Slack bridge
|
|
# See: https://github.com/Sorunome/mx-puppet-slack
|
|
|
|
matrix_mx_puppet_slack_enabled: true
|
|
|
|
matrix_mx_puppet_slack_oauth_client_id: ''
|
|
matrix_mx_puppet_slack_oauth_client_secret: ''
|
|
|
|
matrix_mx_puppet_slack_container_image_self_build: false
|
|
matrix_mx_puppet_slack_container_image_self_build_repo: "https://github.com/Sorunome/mx-puppet-slack.git"
|
|
|
|
# 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: ''
|
|
|
|
matrix_mx_puppet_slack_version: latest
|
|
matrix_mx_puppet_slack_docker_image: "{{ matrix_mx_puppet_slack_docker_image_name_prefix }}sorunome/mx-puppet-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 matrix_container_global_registry_prefix }}"
|
|
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"
|
|
|
|
matrix_mx_puppet_slack_homeserver_address: "{{ matrix_homeserver_container_url }}"
|
|
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: ''
|
|
|
|
# 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: ''
|
|
|
|
# Database configuration, role uses 'sqlite' per default but playbook sets up postgres by default
|
|
matrix_mx_puppet_slack_database_engine: sqlite
|
|
|
|
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"
|
|
|
|
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
|
|
matrix_mx_puppet_slack_database_name: matrix_mx_puppet_slack
|
|
|
|
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'
|
|
|
|
# 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.
|
|
matrix_mx_puppet_slack_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
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 }}
|
|
de.sorunome.msc2409.push_ephemeral: true
|
|
|
|
matrix_mx_puppet_slack_registration: "{{ matrix_mx_puppet_slack_registration_yaml|from_yaml }}"
|