From a5bc249dd686d1fe2cbfb88f1cd92b2ff54310eb Mon Sep 17 00:00:00 2001 From: wmhtet Date: Mon, 2 Sep 2024 13:46:48 +0630 Subject: [PATCH] Update configuring-playbook-bot-maubot.md added info to avoid using Element Access Token because it will prevent the bot from functioning properly in the Encrypted room. Also added maubot simple service management on how to stop and start the maubot service --- docs/configuring-playbook-bot-maubot.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/configuring-playbook-bot-maubot.md b/docs/configuring-playbook-bot-maubot.md index d2b7dbc27..6bb05a07c 100644 --- a/docs/configuring-playbook-bot-maubot.md +++ b/docs/configuring-playbook-bot-maubot.md @@ -48,8 +48,16 @@ You should start in the following order 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) +### Server service management +If you need to do stop and start manually of the Maubot service, you can use systemd command `systemctl` or `just`. + +- **systemctl** : You will need to ssh insto the server and you can then issue `systemctl restart matrix-bot-maubot` as root. + +- **just** : You can run the command from where the ansible playbook is run(probably from your laptop). `just stop-group bot-maubot` and `just start-group bot-maubot`. + + ## Obtaining an access token This can be done via `mbc login` then `mbc auth` (see the [maubot documentation](https://docs.mau.fi/maubot/usage/cli/auth.html)). To run these commands, you'll first need to `exec` into the maubot container with `docker exec -it matrix-bot-maubot sh`. -Alternatively, you can follow our generic [obtain an access token](obtaining-access-tokens.md) documentation. +Alternatively, you can follow our generic [obtain an access token](obtaining-access-tokens.md) documentation. Be aware that you can only use `Obtain an access token via curl` and not `Obtain an access token via Element`. By getting the access token via Element will give your bot issue with Encrypted room. Read [more](https://docs.mau.fi/maubot/usage/basic.html#creating-clients).