Setting up Maubot: Difference between revisions
Initial |
→Maubot Access Token with SSO: added variables for easier use and added password option for the bot account |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
== Maubot in the Community == | |||
Using the following Plugins: | |||
* https://github.com/gitayam/matrix-to-discourse | |||
* https://github.com/ggogel/SocialMediaDownloadMaubot | |||
* https://github.com/maubot/reminder | |||
* https://github.com/maubot/reactbot | |||
Some of these plugins have been modified from the source to fit the community's needs. | |||
== Maubot Documentation == | == 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''' | |||
* [https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/configuring-playbook-bot-maubot.md Maubot Configuration Documentation on GitHub] | |||
* [https://docs.mau.fi/maubot/usage/basic.html Official Maubot Project Documentation] | |||
'''Plugins Available''' | |||
* Find available plugins [https://plugins.mau.bot here]. | |||
'''Admin Dashboard''' | |||
* The Maubot admin dashboard can be accessed at: [https://matrix.irregularchat.com/_matrix/maubot/ matrix.irregularchat.com/_matrix/maubot/]. | |||
== Maubot Access Token with SSO == | |||
< | To obtain a Maubot access token using SSO, follow these steps: | ||
Reference: [https://docs.mau.fi/maubot/usage/cli/auth.html Maubot Authentication Documentation] | |||
<pre> | |||
#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 | ||
</pre> | |||
<pre> | |||
HOMESERVER_URL="https://matrix.irregularchat.com" | |||
USERNAME="maubotuser" | |||
#You must login before authenticating. This is logging in to the maubot portal | |||
mbc login -u "$USERNAME" -s "$HOMESERVER_URL" -a homeserver -p passwordHERE | |||
</pre> | |||
<pre> | |||
# now while authenticated, login to the user account | |||
# If you have an SSO for the user | |||
DOMAIN="https://matrix.irregularchat.com" | |||
HOMESERVER_URL="https://matrix.irregularchat.com" | |||
USERNAME="bot.user" | |||
mbc login -u $USERNAME -s $HOMESERVER_URL -a $DOMAIN -p "passwordHERE" | |||
</pre> | |||
<pre> | |||
# now while authenticated, login to the user account | |||
# If you have an SSO for the user | |||
DOMAIN="https://matrix.irregularchat.com" | |||
HOMESERVER_URL="https://matrix.irregularchat.com" | |||
USERNAME="bot.user" | |||
mbc auth -s "$HOMESERVER_URL" -h "$DOMAIN" -o --update-client -u "$USERNAME" | |||
</pre> | |||
The output should look like this: | |||
<code>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</code> | |||
1. Open a browser and replace <code>http://matrix-nginx-proxy:12080</code> with <code>https://matrix.irregularchat.com</code>. | |||
2. Log in using Single Sign-On (SSO). | |||
== Packaging the Plugin == | |||
To package a plugin for Maubot, use the following command: | |||
<pre> | |||
# Inside the cloned git directory | |||
zip -9r plugin-name.mbp * | |||
</pre> | |||
[[Category:Matrix]] | |||
[[Category:Maubot]] | |||
[[Category:Bot Management]] | |||
[[Category:Server Guides]] | |||
[[Category:Guides]] | |||
Latest revision as of 13:49, 23 January 2025
Maubot in the Community
Using the following Plugins:
- https://github.com/gitayam/matrix-to-discourse
- https://github.com/ggogel/SocialMediaDownloadMaubot
- https://github.com/maubot/reminder
- https://github.com/maubot/reactbot
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
- The Maubot admin dashboard can be accessed at: matrix.irregularchat.com/_matrix/maubot/.
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
HOMESERVER_URL="https://matrix.irregularchat.com" USERNAME="maubotuser" #You must login before authenticating. This is logging in to the maubot portal mbc login -u "$USERNAME" -s "$HOMESERVER_URL" -a homeserver -p passwordHERE
# now while authenticated, login to the user account # If you have an SSO for the user DOMAIN="https://matrix.irregularchat.com" HOMESERVER_URL="https://matrix.irregularchat.com" USERNAME="bot.user" mbc login -u $USERNAME -s $HOMESERVER_URL -a $DOMAIN -p "passwordHERE"
# now while authenticated, login to the user account # If you have an SSO for the user DOMAIN="https://matrix.irregularchat.com" HOMESERVER_URL="https://matrix.irregularchat.com" USERNAME="bot.user" mbc auth -s "$HOMESERVER_URL" -h "$DOMAIN" -o --update-client -u "$USERNAME"
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 *