ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-04-23 17:14:05 +00:00
Code Issues Projects Releases Wiki Activity

Update docs for Draupnir and Mjolnir: invite the Draupnir bot after installation

Browse Source 
Now that the bot user for Draupnir is created automatically and you no longer need to register it manually since its 2.0.0 version, it does not seem to be sensible to synchronize descriptions about inviting bots between documents for Draupnir and Mjolnir and instruct to invite the bot which does not exist just yet. Inviting the bot user after actually creating it will also spare the possible error message about the nonexistent user.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2025-01-19 12:26:28 +09:00
parent 317732a3bb
commit 91304d1eee
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/configuring-playbook-bot-draupnir.md
View File

@ -16,9 +16,9 @@ Using your own account, create a new invite only room that you will use to manag
It is possible to make the management room encrypted (E2EE). If doing so, then you need to enable the native E2EE support (see [below](#native-e2ee-support)).
Once you have created the room you need to copy the room ID so you can tell the bot to use that room. In Element Web you can do this by going to the room's settings, clicking Advanced, and then copying the internal room ID. The room ID will look something like `!qporfwt:example.com`.
Once you have created the room you need to copy the room ID so you can specify it on your `inventory/host_vars/matrix.example.com/vars.yml` file. In Element Web you can check the room ID by going to the room's settings, clicking "Advanced", and then copying the internal room ID. The room ID will look something like `!qporfwt:example.com`.
Finally invite the `@bot.draupnir:example.com` account that the playbook will create for you to the management room. Please note that clients can issue a warning that you are attempting to invite a user that does not have a profile and might not exist. This warning is expected as your inviting the bot before its user account exists.
After running the installation command, you'll need to invite the bot to the management room. See the [Usage](#usage) section for details about it.
## End-to-End Encryption support
@ -34,7 +34,7 @@ To enable the native E2EE support, you need to obtain an access token for Draupn
Note that native E2EE requires a clean access token that has not touched E2EE so curl is recommended as a method to obtain it. **The access token obtained via Element Web does not work with it**. Refer to the documentation on [how to obtain an access token via curl](obtaining-access-tokens.md#obtain-an-access-token-via-curl).
To enable the native E2EE support, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
To enable the native E2EE support, add the following configuration to your `vars.yml` file:
```yaml
# Enables the native E2EE support
@ -165,6 +165,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
## Usage
To use Draupnir, you need to invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier.
You can refer to the upstream [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) for additional ways to use and configure Draupnir and for a more detailed usage guide.
Below is a **non-exhaustive quick-start guide** for the impatient.

2
docs/configuring-playbook-bot-mjolnir.md
View File

@ -56,7 +56,7 @@ Using your own account, create a new invite only room that you will use to manag
It is possible to make the management room encrypted (E2EE). If doing so, then you MUST enable and use Pantalaimon (see [below](#configuration-with-e2ee-support)).
Once you have created the room you need to copy the room ID so you can tell the bot to use that room. In Element Web you can do this by going to the room's settings, clicking Advanced, and then copying the internal room ID. The room ID will look something like `!qporfwt:example.com`.
Once you have created the room you need to copy the room ID so you can specify it on your `vars.yml` file. In Element Web you can check the room ID by going to the room's settings, clicking "Advanced", and then copying the internal room ID. The room ID will look something like `!qporfwt:example.com`.
Finally invite the `@bot.mjolnir:example.com` account you created earlier into the room.