90a142439a
* Add matrix-registration-bot This adds an install and uninstall task plus helpers. The bot is disabled by default. This commit does not include documentation, yet. In short, the bot can be enabled by adding matrix_bot_matrix_registration_bot_enabled: true matrix_bot_matrix_registration_bot_matrix_user_password: "verysecret" matrix_bot_matrix_registration_bot_matrix_admin_token: "supersecret" to the host_vars * Change bot username to bot.matrix-registration-bot following convention * Address smaller remarks, fix local docker build * Switch to an env file * Add environment variables extension for additional config * Add documentation for the matrix-registration-bot * Add screenshot on how to obtain admin access token * Use bot as admin to only have one access token (bot and admin api) * Use cleaner setting of matrix_synapse_registration_requires_token * Use config file for cleaner more secure usage * Delete unneeded env * Rename vars to make usage clear * Fix typos/wording and add notice about logging out * Convert configuration to use |to_json * Reorder role includes Nothing should be after `matrix-common-after`. `matrix-bot-matrix-registration-bot` can probably be anywhere, but it makes sense to put it next to the other `matrix-bot-*` roles. * Minor group_vars/matrix_servers touchups Co-authored-by: Slavi Pantaleev <slavi@devture.com>
50 lines
3 KiB
YAML
50 lines
3 KiB
YAML
---
|
|
# matrix-registration-bot creates and manages registration tokens for a matrix server
|
|
# See: https://github.com/moan0s/matrix-registration-bot
|
|
|
|
matrix_bot_matrix_registration_bot_enabled: true
|
|
matrix_bot_matrix_registration_bot_container_image_self_build: false
|
|
matrix_bot_matrix_registration_bot_docker_repo: "https://github.com/moan0s/matrix-registration-bot.git"
|
|
matrix_bot_matrix_registration_bot_docker_src_files_path: "{{ matrix_bot_matrix_registration_bot_base_path }}/docker-src"
|
|
|
|
matrix_bot_matrix_registration_bot_version: latest
|
|
matrix_bot_matrix_registration_bot_docker_image: "{{ matrix_container_global_registry_prefix }}moanos/matrix-registration-bot:{{ matrix_bot_matrix_registration_bot_version }}"
|
|
matrix_bot_matrix_registration_bot_docker_image_force_pull: "{{ matrix_bot_matrix_registration_bot_docker_image.endswith(':latest') }}"
|
|
|
|
matrix_bot_matrix_registration_bot_base_path: "{{ matrix_base_data_path }}/matrix-registration-bot"
|
|
matrix_bot_matrix_registration_bot_config_path: "{{ matrix_bot_matrix_registration_bot_base_path }}/config"
|
|
matrix_bot_matrix_registration_bot_data_path: "{{ matrix_bot_matrix_registration_bot_base_path }}/data"
|
|
|
|
matrix_bot_matrix_registration_bot_bot_server: "https://{{ matrix_server_fqn_matrix }}"
|
|
matrix_bot_matrix_registration_bot_api_base_url: "https://{{ matrix_server_fqn_matrix }}"
|
|
|
|
# The access token that the bot uses to communicate in Matrix chats
|
|
# This does not necessarily need to be a privileged (admin) access token.
|
|
matrix_bot_matrix_registration_bot_bot_access_token: ''
|
|
|
|
# The access token that the bot uses to call the Matrix API for creating registration tokens.
|
|
# This needs to be a privileged (admin) access token.
|
|
# By default, we assume `matrix_bot_matrix_registration_bot_bot_access_token` is such a privileged token and we use it as is.
|
|
# If necessary, you can define your own other access token here, which might even be for a different Matrix user.
|
|
matrix_bot_matrix_registration_bot_api_token: "{{ matrix_bot_matrix_registration_bot_bot_access_token }}"
|
|
|
|
matrix_bot_matrix_registration_bot_logging_level: info
|
|
matrix_bot_matrix_registration_environment_variables_extension: ''
|
|
|
|
# A list of extra arguments to pass to the container
|
|
matrix_bot_matrix_registration_bot_container_extra_arguments: []
|
|
|
|
# List of systemd services that matrix-bot-matrix-registration-bot.service depends on
|
|
matrix_bot_matrix_registration_bot_systemd_required_services_list: ['docker.service']
|
|
|
|
# List of systemd services that matrix-bot-matrix-registration-bot.service wants
|
|
matrix_bot_matrix_registration_bot_systemd_wanted_services_list: []
|
|
|
|
# The bot's username. This user needs to be created manually beforehand.
|
|
# Also see `matrix_bot_matrix_registration_bot_user_password`.
|
|
matrix_bot_matrix_registration_bot_matrix_user_id_localpart: "bot.matrix-registration-bot"
|
|
|
|
matrix_bot_matrix_registration_bot_matrix_user_id: '@{{ matrix_bot_matrix_registration_bot_matrix_user_id_localpart }}:{{ matrix_domain }}'
|
|
|
|
matrix_bot_matrix_registration_bot_matrix_homeserver_url: "{{ matrix_homeserver_container_url }}"
|