c73680712b
Reference: https://ansible-lint.readthedocs.io/en/latest/default_rules/#var-naming We don't really fix these, but just suppress them, because they're like that intentionally. We try to name variables in a way that is consistent with the configuration key they control. If the upstream component uses camelCase, we also need to include camelCase in the variable name.
113 lines
5.8 KiB
YAML
113 lines
5.8 KiB
YAML
---
|
|
# matrix-appservice-discord is a Matrix <-> Discord bridge
|
|
# Project source code URL: https://github.com/Half-Shot/matrix-appservice-discord
|
|
|
|
matrix_appservice_discord_enabled: true
|
|
|
|
matrix_appservice_discord_version: v1.0.0
|
|
matrix_appservice_discord_docker_image: "{{ matrix_container_global_registry_prefix }}halfshot/matrix-appservice-discord:{{ matrix_appservice_discord_version }}"
|
|
matrix_appservice_discord_docker_image_force_pull: "{{ matrix_appservice_discord_docker_image.endswith(':latest') }}"
|
|
|
|
matrix_appservice_discord_base_path: "{{ matrix_base_data_path }}/appservice-discord"
|
|
matrix_appservice_discord_config_path: "{{ matrix_base_data_path }}/appservice-discord/config"
|
|
matrix_appservice_discord_data_path: "{{ matrix_base_data_path }}/appservice-discord/data"
|
|
|
|
# Get your own keys at https://discordapp.com/developers/applications/me/create
|
|
matrix_appservice_discord_client_id: ''
|
|
matrix_appservice_discord_bot_token: ''
|
|
|
|
matrix_appservice_discord_appservice_token: ''
|
|
matrix_appservice_discord_homeserver_token: ''
|
|
|
|
matrix_appservice_discord_homeserver_domain: "{{ matrix_domain }}"
|
|
|
|
# Controls whether the matrix-appservice-discord container exposes its HTTP port (tcp/9005 in the container).
|
|
#
|
|
# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9005"), or empty string to not expose.
|
|
matrix_appservice_discord_container_http_host_bind_port: ''
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_appservice_discord_container_extra_arguments: []
|
|
|
|
# List of systemd services that matrix-appservice-discord.service depends on.
|
|
matrix_appservice_discord_systemd_required_services_list: ['docker.service']
|
|
|
|
# List of systemd services that matrix-appservice-discord.service wants
|
|
matrix_appservice_discord_systemd_wanted_services_list: []
|
|
|
|
matrix_appservice_discord_appservice_url: 'http://matrix-appservice-discord:9005'
|
|
|
|
matrix_appservice_discord_bridge_domain: "{{ matrix_domain }}"
|
|
# As of right now, the homeserver URL must be a public URL. See below.
|
|
matrix_appservice_discord_bridge_homeserverUrl: "{{ matrix_homeserver_url }}" # noqa var-naming
|
|
matrix_appservice_discord_bridge_disablePresence: false # noqa var-naming
|
|
matrix_appservice_discord_bridge_enableSelfServiceBridging: false # noqa var-naming
|
|
matrix_appservice_discord_bridge_disablePortalBridging: false # noqa var-naming
|
|
|
|
# Database-related configuration fields.
|
|
#
|
|
# To use SQLite, stick to these defaults.
|
|
#
|
|
# To use Postgres:
|
|
# - change the engine (`matrix_appservice_discord_database_engine: 'postgres'`)
|
|
# - adjust your database credentials via the `matrix_appservice_discord_database_*` variables
|
|
matrix_appservice_discord_database_engine: 'sqlite'
|
|
|
|
matrix_appservice_discord_sqlite_database_path_local: "{{ matrix_appservice_discord_data_path }}/discord.db"
|
|
matrix_appservice_discord_sqlite_database_path_in_container: "/data/discord.db"
|
|
|
|
matrix_appservice_discord_database_username: 'matrix_appservice_discord'
|
|
matrix_appservice_discord_database_password: 'some-password'
|
|
matrix_appservice_discord_database_hostname: 'matrix-postgres'
|
|
matrix_appservice_discord_database_port: 5432
|
|
matrix_appservice_discord_database_name: 'matrix_appservice_discord'
|
|
|
|
# These 2 variables are what actually ends up in the bridge configuration.
|
|
# It's best if you don't change them directly, but rather redefine the sub-variables that constitute them.
|
|
matrix_appservice_discord_database_filename: "{{ matrix_appservice_discord_sqlite_database_path_in_container }}"
|
|
matrix_appservice_discord_database_connString: 'postgresql://{{ matrix_appservice_discord_database_username }}:{{ matrix_appservice_discord_database_password }}@{{ matrix_appservice_discord_database_hostname }}:{{ matrix_appservice_discord_database_port }}/{{ matrix_appservice_discord_database_name }}' # noqa var-naming
|
|
|
|
|
|
# Tells whether the bot should make use of "Privileged Gateway Intents".
|
|
#
|
|
# Enabling this means that you need to enable it for the bot (Discord application) as well,
|
|
# by triggering all Intent checkboxes on a page like this: `https://discord.com/developers/applications/694448564151123988/bot`
|
|
#
|
|
# Learn more: https://gist.github.com/advaith1/e69bcc1cdd6d0087322734451f15aa2f
|
|
matrix_appservice_discord_auth_usePrivilegedIntents: false # noqa var-naming
|
|
|
|
matrix_appservice_discord_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
|
|
|
|
matrix_appservice_discord_configuration_extension_yaml: |
|
|
# Your custom YAML configuration goes here.
|
|
# This configuration extends the default starting configuration (`matrix_appservice_discord_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_appservice_discord_configuration_yaml`.
|
|
|
|
matrix_appservice_discord_configuration_extension: "{{ matrix_appservice_discord_configuration_extension_yaml | from_yaml if matrix_appservice_discord_configuration_extension_yaml | from_yaml is mapping else {} }}"
|
|
|
|
matrix_appservice_discord_configuration: "{{ matrix_appservice_discord_configuration_yaml | from_yaml | combine(matrix_appservice_discord_configuration_extension, recursive=True) }}"
|
|
|
|
matrix_appservice_discord_registration_yaml: |
|
|
#jinja2: lstrip_blocks: "True"
|
|
id: appservice-discord
|
|
as_token: "{{ matrix_appservice_discord_appservice_token }}"
|
|
hs_token: "{{ matrix_appservice_discord_homeserver_token }}"
|
|
namespaces:
|
|
users:
|
|
- exclusive: true
|
|
regex: '@_discord_.*:{{ matrix_appservice_discord_homeserver_domain | regex_escape }}'
|
|
aliases:
|
|
- exclusive: true
|
|
regex: '#_discord_.*:{{ matrix_appservice_discord_homeserver_domain | regex_escape }}'
|
|
url: {{ matrix_appservice_discord_appservice_url }}
|
|
sender_localpart: _discord_bot
|
|
rate_limited: false
|
|
protocols:
|
|
- discord
|
|
|
|
matrix_appservice_discord_registration: "{{ matrix_appservice_discord_registration_yaml | from_yaml }}"
|