A Matrix Maubot bot that lets you observe the online/offline status of your services.
- Create a file, named base-config.yaml
- Enter your accountID and the roomID of your chat with the bot
- Everybody listed in the base-config file is allowed to authorize users to also use the bot
- Notice. you need to grant yourself access to the bot, even when you are in the base-config
allowed: [["@user:matrix.server.de"], ["RoomID:server02.de"]] - Build the Plugin with
mbc Build - Upload the plugin to your Maubot instance
- user management
- request all kinds of services
- add and remove services without recompiling the plugin
- add and remove authorized users/rooms without recompiling the plugin
- shared service list between authorized users in groups or allow the whole group
- private list of services in privat chat
- Authorize an account to use the bot
!admin authorize <user>e.x!admin authorrize @exampleuser.matrix.example.com - Authorize all members of a group to use the bot
!admin authorize <room_id>e.x!admin authorrize !randomchars:matrix.example.com - Deauthorize an account
!admin deauthorize <user>e.x!admin deauthorrize @exampleuser.matrix.example.com - Search for a specific authorized user
!admin get <user>e.x!admin get @exampleuser.matrix.example.com - List the authoried users
!admin list <user>e.x!admin list @exampleuser.matrix.example.com
- Add a web service
!status addweb <url> <port>e.x!status addweb example.com 80 - Add a non web service
!status addnoweb <url> <port>e.x!status addnoweb example.com 22 - Remove a service
!status rem <url> <port>e.x!status rem example.com 25 - List the services you currently observe
status list - Request the status of your services
!status ping
The Bot differentiates service lists by the room_id of a chat. This means a user who adds services in a private chat with the bot will have a list only he can access. If the same user is part of a group, the bot also is a member of, the authorized user can add services to a list that do not interact with his list from the private chat. The key is that different authorized members who are part of a group can have a shared list, but also every user is able to have his/her own private list in the direct chat with the bot.
Example: authorized users: A, B Chats: private_A, private_B, group_ABC possible lists: A, B, AB
IMPORTANT: User C will be able to read messages in group_ABC that are addressed to the bot! Also, the bots responses are visible to all group members.
I can't guarantee that the current authorization mechanism through matrix ID's is secure!