finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

matrix-bot-buscarron: feedback

Browse Source
This commit is contained in:
Aine 2022-04-25 09:40:49 +03:00
parent b720b15de6
commit c92af9fe89
No known key found for this signature in database
GPG Key ID: 34969C908CCA2804
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/configuring-playbook-bot-buscarron.md
View File

@ -7,7 +7,7 @@ It's a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) matri
## Registering the bot user ## Registering the bot user
By default, the playbook will set up the bot with a username like this: `@buscarron:DOMAIN`. By default, the playbook will set up the bot with a username like this: `@bot.buscarron:DOMAIN`.
(to use a different username, adjust the `matrix_bot_buscarron_login` variable). (to use a different username, adjust the `matrix_bot_buscarron_login` variable).
@ -32,11 +32,11 @@ matrix_bot_buscarron_password: PASSWORD_FOR_THE_BOT
# Adjust accepted forms # Adjust accepted forms
matrix_bot_buscarron_forms: matrix_bot_buscarron_forms:
- name: contact # (mandatory) Your form name, will be used as endpoint, eg: buscarron.DOMAIN/contact - name: contact # (mandatory) Your form name, will be used as endpoint, eg: buscarron.DOMAIN/contact
room: "!yourRoomID:DOMAIN" # (mandatory) Room ID where form submission will be posted room: "!yourRoomID:DOMAIN" # (mandatory) Room ID where form submission will be posted
redirect: https://DOMAIN # (mandatory) To what page user will be redirected after the form submission redirect: https://DOMAIN # (mandatory) To what page user will be redirected after the form submission
ratelimit: 1r/m # (optional) rate limit of the form, format: <max requests>r/<interval:s,m>, eg: 1r/s or 54r/m ratelimit: 1r/m # (optional) rate limit of the form, format: <max requests>r/<interval:s,m>, eg: 1r/s or 54r/m
extensions: [] # (optional) list of form extensions (not used yet) extensions: [] # (optional) list of form extensions (not used yet)
matrix_bot_buscarron_spam_hosts: [] # (optional) list of email domains/hosts that should be rejected automatically matrix_bot_buscarron_spam_hosts: [] # (optional) list of email domains/hosts that should be rejected automatically
matrix_bot_buscarron_spam_emails: [] # (optional) list of email addresses that should be rejected automatically matrix_bot_buscarron_spam_emails: [] # (optional) list of email addresses that should be rejected automatically
@ -64,7 +64,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
## Usage ## Usage
To use the bot, invite the `@buscarron:DOMAIN` to the room you specified in a config, after that any point your form to the form url, example for the `contact` form: To use the bot, invite the `@bot.buscarron:DOMAIN` to the room you specified in a config, after that any point your form to the form url, example for the `contact` form:
```html ```html
<form method="POST" action="https://buscarron.DOMAIN/contact"> <form method="POST" action="https://buscarron.DOMAIN/contact">

2
roles/matrix-bot-buscarron/defaults/main.yml
View File

@ -65,7 +65,7 @@ matrix_bot_buscarron_database_dialect: "{{
# The bot's username. This user needs to be created manually beforehand. # The bot's username. This user needs to be created manually beforehand.
# Also see `matrix_bot_buscarron_password`. # Also see `matrix_bot_buscarron_password`.
matrix_bot_buscarron_login: "buscarron" matrix_bot_buscarron_login: "bot.buscarron"
# The password that the bot uses to authenticate. # The password that the bot uses to authenticate.
matrix_bot_buscarron_password: '' matrix_bot_buscarron_password: ''