Clear up maubot role (#1960)

* Make interface hidden behind proxy by default

* Remove expose option and replace with http_bind_port

Reasoning: This is a similar binary trigger but allows to bin not on all interfaces

* Clarify maubot admin purpose

* Remove unnecessary edif

* Extend docs to prevent common misconceptions

* Make http_bind_port singular, do not allow multiple values

* Make optional again
This commit is contained in:
Julian-Samuel Gebühr
2022-07-20 11:23:32 +02:00
committed by GitHub
parent a1bfad1e9b
commit b20cfc5015
3 changed files with 13 additions and 6 deletions

View File

@ -18,7 +18,8 @@ matrix_bot_maubot_admins:
- yourusername: securepassword
```
You can add multiple admins.
You can add multiple admins. The admin accounts are not connected to any matrix ID and are only used to access the
maubot administration interface.
## Installing
@ -32,6 +33,13 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
## Usage
You can visit `matrix.<your-domain>/_matrix/maubot/` to manage your available plugins, clients and instances.
You should start in the following order
1. **Create one or more clients:** A client is a matrix account which the bot will use to message.
2. **Upload some Plugins:** Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source.
3. **Create an instance:** An instance is the actual bot. You have to specify a client which the bot instance will use
and the plugin (how the bot will behave)
To add a client you first need to create an account and obtain a valid access token.
## Registering the bot user