Skip to content

README.md

Latest commit

 

History

History
61 lines (43 loc) · 1.62 KB

README.md

File metadata and controls

61 lines (43 loc) · 1.62 KB
Raw

Plugin for Maubot to run meetings on Matrix.

Setup

Install the plugin into Maubot as normal, and associate it to a Matrix account

Commands

  • !startmeeting - Starts a meeting
  • !endmeeting - Ends a meeting
  • !meetingname - Set the meetingname (defaults to the room name)
  • !topic - Set the topic (defaults to "")

During the meeting the bot will log all text messages (not reactions) to the internal plugin DB. It will also look for things starting "^" and perform an action if found. This includes things like

  • ^info
  • ^action
  • ^link

And so on - the full list of tags (and the reaction emoji) is in the config file. Multiline messages should be stored correctly.

When "!endmeeting" is called, the bot will pass the control to the backend plugin (currently either ansible or fedora). This will determine what is done with the logs:

More backends are possible.

Permissions

The bot checks permissions for who can start/end a meeting. The default is PL 50 (moderator), which is configurable.

Config

The backend_data dict is used to store necessary config for a given backend. Here is an example for the ansible backend (which posts to Discourse:

backend: ansible
backend_data:
    ansible:
        discourse_user: meetingbot
        discourse_key: redacted
        discourse_url: https://forum.ansible.com
        category_id: 15

Optional dependencies

Maubot has no way to force extra dependencies, so we list them here:

  • Ansible backend: none
  • Fedora backend:
    • slugify