14f7eed932
* Adjust to new mrb docker versioning * Stabilze authentication * fix lint * Move & document mrb password usage * Add clean cache role * Document clean cache * Fix lint * Update CHANGELOG.md * Automate access tokens * Improve changelog * Make use of mrb's function to fetch API tokens * Adjust changelog * Use ansible.builtin.file to clear directory * Fix typo --------- Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2.8 KiB
Setting up matrix-registration-bot (optional)
The playbook can install and configure matrix-registration-bot for you.
The bot allows you to easily create and manage registration tokens aka. invitation codes.
It can be used for an invitation-based server,
where you invite someone by sending them a registration token (loook like this: rbalQ0zkaDSRQCOp). They can register as normal but have to provide a valid registration token in a final step of the registration.
See the project's documentation to learn what it does and why it might be useful to you.
Configuration
To enable the bot, add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:
For matrix_bot_matrix_registration_bot_api_tokenyou need an access token with the permission to access the admin api. Access to the API is needed for all restricted actions of the bot (list, create etc..). Refer to the documentation on how to obtain an access token.
matrix_bot_matrix_registration_bot_enabled: true
#By default, the playbook will set use the bot with a username like
## this: `@bot.matrix-registration-bot:DOMAIN`.
# To use a different username, uncomment & adjust the variable.
# matrix_bot_matrix_registration_bot_matrix_user_id_localpart: bot.matrix-registration-bot
# Generate a strong password here. Consider generating it with `pwgen -s 64 1`
matrix_bot_matrix_registration_bot_password: PASSWORD_FOR_THE_BOT
# Enables registration
matrix_synapse_enable_registration: true
# Restrict registration to users with a token
matrix_synapse_registration_requires_token: true
The bot account will be automatically created.
Installing
After configuring the playbook, run the installation command again:
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
Usage
To use the bot, message @bot.matrix-registration-bot:DOMAIN (where DOMAIN is your base domain, not the matrix. domain).
In this room send help and the bot will reply with all options.
You can also refer to the upstream Usage documentation. If you have any questions, or if you need help setting it up, read the troublshooting guide or join #matrix-registration-bot:hyteck.de.
To clean the cache (session&encryption data) after you changed the bot's username, changed the login methon form access_token to password etc.. you can use
just run-tags bot-matrix-registration-bot-clean-cache