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, D4A, and Mjolnir: emphasize the importance of being careful when inviting a user to the management room

Browse Source 
- docs/configuring-playbook-bot-mjolnir.md: move the warning above where the access token is mentioned at first

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

2
docs/configuring-playbook-appservice-draupnir-for-all.md
View File

@ -28,7 +28,7 @@ The management room has to be given an alias, and your bot has to be invited to
This management room is used to control who has access to your D4A deployment. The room stores this data inside of the control room state so your bot must have sufficient powerlevel to send custom state events. This is default 50 or moderator as Element clients call this powerlevel.
As noted in the Draupnir install instructions the control room is sensitive. **Anyone in this room can control the bot so it is important that you only invite trusted users to this room.**
⚠️ **Warning**: anyone in this room can control the bot so it is important that you only invite trusted users to this room.
## Adjusting the playbook configuration

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

@ -12,7 +12,7 @@ If your migrating from Mjolnir skip to [this section](#migrating-from-mjolnir-on
### Create a management room
Using your own account, create a new invite only room that you will use to manage the bot. This is the room where you will see the status of the bot and where you will send commands to the bot, such as the command to ban a user from another room. Anyone in this room can control the bot so it is important that you only invite trusted users to this room.
Using your own account, create a new invite only room that you will use to manage the bot. This is the room where you will see the status of the bot and where you will send commands to the bot, such as the command to ban a user from another room.
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)).
@ -34,6 +34,8 @@ 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).
⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.
To enable the native E2EE support, add the following configuration to your `vars.yml` file:
```yaml
@ -96,9 +98,7 @@ curl --header "Authorization: Bearer <access_token>" -X POST https://matrix.exam
### Obtain an access token
Manual access to Synapse's Admin API requires an access token. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).
⚠️ **Warning**: Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.
Manual access to Synapse's Admin APIs requires an access token. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).
### Abuse Reports
@ -167,6 +167,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
To use Draupnir, you need to invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier.
⚠️ **Warning**: anyone in this room can control the bot so it is important that you only invite trusted users to this room.
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.

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

@ -52,7 +52,9 @@ You can obtain an access token for a homeserver admin account in the same way as
### Create a management room
Using your own account, create a new invite only room that you will use to manage the bot. This is the room where you will see the status of the bot and where you will send commands to the bot, such as the command to ban a user from another room. Anyone in this room can control the bot so it is important that you only invite trusted users to this room.
Using your own account, create a new invite only room that you will use to manage the bot. This is the room where you will see the status of the bot and where you will send commands to the bot, such as the command to ban a user from another room.
⚠️ **Warning**: anyone in this room can control the bot so it is important that you only invite trusted users to this room.
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)).