Setting up Maubot: Difference between revisions

From Irregularpedia
Jump to navigation Jump to search
Sac1 (talk | contribs)
formatting and added the plugins we are using
Sac1 (talk | contribs)
 
Line 30: Line 30:


<pre>
<pre>
## Launch an interactive shell in the Maubot container
#Launch an interactive shell in the Maubot container
sudo docker exec -it matrix-bot-maubot /bin/sh
sudo docker exec -it matrix-bot-maubot /bin/sh


== You must login before authenticating ==
#You must login before authenticating  
mbc login -u user -s "https://matrix.irregularchat.com" -a homeserver -p passwordHERE
mbc login -u user -s "https://matrix.irregularchat.com" -a homeserver -p passwordHERE



Latest revision as of 02:12, 11 October 2024

Maubot in the Community

Using the following Plugins:

Some of these plugins have been modified from the source to fit the community's needs.


Maubot Documentation

Maubot is used for moderation and management tasks within Matrix environments. Below are useful resources and steps for setting up and managing Maubot.

GitHub Repository and Project Documentation

Plugins Available

  • Find available plugins here.

Admin Dashboard

Maubot Access Token with SSO

To obtain a Maubot access token using SSO, follow these steps: Reference: Maubot Authentication Documentation

#Launch an interactive shell in the Maubot container
sudo docker exec -it matrix-bot-maubot /bin/sh

#You must login before authenticating 
mbc login -u user -s "https://matrix.irregularchat.com" -a homeserver -p passwordHERE

mbc auth -s https://matrix.irregularchat.com -h irregularchat.com -o --update-client -u bot.user

The output should look like this: Opening http://matrix-nginx-proxy:12080/_matrix/client/v3/login/sso/redirect?redirectUrl=https://matrix.irregularchat.com/_matrix/maubot/v1/client/auth_external_sso/complete/randomhere

1. Open a browser and replace http://matrix-nginx-proxy:12080 with https://matrix.irregularchat.com. 2. Log in using Single Sign-On (SSO).

Packaging the Plugin

To package a plugin for Maubot, use the following command:

# Inside the cloned git directory
zip -9r plugin-name.mbp *