Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for Draupnir, D4A, and Mjolnir #3966

Closed
wants to merge 38 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
bf451a6
Update docs for Draupnir, D4A, and Mjolnir: adopt the common section …
Dec 28, 2024
e66d217
Update docs/configuring-playbook-bot-draupnir.md: misc changes
Jan 19, 2025
cea73e0
Update docs for Draupnir and Mjolnir: small edits
Jan 19, 2025
317732a
Update docs/configuring-playbook-appservice-draupnir-for-all.md: remo…
Jan 19, 2025
91304d1
Update docs for Draupnir and Mjolnir: invite the Draupnir bot after i…
Jan 19, 2025
e91ecbd
Update docs for Draupnir, D4A, and Mjolnir: emphasize the importance …
Jan 19, 2025
e74e3eb
Update docs for Draupnir and Mjolnir: move the note about API access …
Jan 19, 2025
3bd5ae8
Update docs for Draupnir and Mjolnir: create subsections for the inst…
Jan 19, 2025
163a276
Update docs for Draupnir and Mjolnir: move the instruction to obtain …
Jan 19, 2025
2cecf38
Update docs for Draupnir and Mjolnir: instructions to replace the IDs
Jan 19, 2025
cb5d5de
Update roles/custom/matrix-bot-draupnir/defaults/main.yml: fix capita…
Jan 19, 2025
de5b241
Update docs for Draupnir and Mjolnir: the instructions for running th…
Jan 19, 2025
025fbcc
Update docs/configuring-playbook-bot-draupnir.md: move the configurat…
Jan 19, 2025
f3385ab
Update docs/configuring-playbook-bot-draupnir.md: common instructions…
Jan 19, 2025
5e2586a
Update docs/configuring-playbook-bot-draupnir.md: fix the condition f…
Jan 19, 2025
f0e7bb1
Update docs/configuring-playbook-bot-draupnir.md: create the subsecti…
Jan 19, 2025
034b5e3
Update docs for Draupnir and Mjolnir: tidy up the descriptions in the…
Jan 19, 2025
c4ae4f6
Update docs/configuring-playbook-bot-draupnir.md: add "recommended" l…
Jan 19, 2025
e6262b7
Update docs for Draupnir and Mjolnir: add the "optional" label to E2E…
Jan 19, 2025
6ca9d5e
Update docs for Draupnir and Mjolnir: add the instruction to run the …
Jan 19, 2025
cf63fef
Update docs for Draupnir and Mjolnir: tidy up the description about c…
Jan 19, 2025
4830eca
Update docs/configuring-playbook-bot-draupnir.md: add the section for…
Jan 19, 2025
bc59f45
Update docs for Draupnir and Mjolnir: iterate
Jan 19, 2025
a685478
Update docs/configuring-playbook-bot-draupnir.md: replace a sentence
Jan 19, 2025
b6a282c
Update docs/configuring-playbook-bot-draupnir.md: create the bot user…
Jan 19, 2025
47e8792
Update docs/configuring-playbook-bot-draupnir.md: tidy up the procedu…
Jan 19, 2025
ef7c3dd
Update docs for Draupnir and Mjolnir: move the section for dischargin…
Jan 19, 2025
fded474
Update docs/configuring-playbook-bot-draupnir.md: add an instruction …
Jan 19, 2025
2c92caf
Update docs for Draupnir and Mjolnir: move the sections for E2EE supp…
Jan 19, 2025
caaac89
Update docs/configuring-playbook-bot-draupnir.md: add a reminder to r…
Jan 19, 2025
7f46bb4
Update docs/configuring-playbook-bot-draupnir.md: add an anchor link …
Jan 19, 2025
7aaa373
Update docs/configuring-playbook-bot-draupnir.md: add an anchor link …
Jan 19, 2025
7e6d1d6
Remove the guide
Jan 19, 2025
525e46e
Remove yet another redirect
Jan 19, 2025
f7c01cc
Apply the review
Jan 19, 2025
4c17f9c
Apply suggestions from code review
luixxiul Jan 20, 2025
7cd525b
Merge remote-tracking branch 'upstream/master' into fix
Jan 20, 2025
6e7b4b1
Fix the typo
Jan 20, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/configuring-playbook-appservice-draupnir-for-all.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +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.**

### Set an alias to the management room
luixxiul marked this conversation as resolved.
Show resolved Hide resolved

Next, set an alias to the management 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

Expand All @@ -46,19 +42,23 @@ matrix_appservice_draupnir_for_all_master_control_room_alias: "MANAGEMENT_ROOM_A

### Extending the configuration

You can configure additional options by adding the `matrix_appservice_draupnir_for_all_extension_yaml` variable.
There are some additional things you may wish to configure about the component.

Take a look at:

- `roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_draupnir_for_all_configuration_extension_yaml` variable

For example, to change Draupnir's `protectAllJoinedRooms` option to `true`, add the following configuration to your `vars.yml` file:

```yaml
matrix_appservice_draupnir_for_all_extension_yaml: |
matrix_appservice_draupnir_for_all_configuration_extension_yaml: |
luixxiul marked this conversation as resolved.
Show resolved Hide resolved
# Your custom YAML configuration goes here.
# This configuration extends the default starting configuration (`matrix_appservice_draupnir_for_all_yaml`).
# This configuration extends the default starting configuration (`matrix_appservice_draupnir_for_all_configuration_yaml`).
luixxiul marked this conversation as resolved.
Show resolved Hide resolved
#
# You can override individual variables from the default configuration, or introduce new ones.
#
# If you need something more special, you can take full control by
# completely redefining `matrix_appservice_draupnir_for_all_yaml`.
# completely redefining `matrix_appservice_draupnir_for_all_configuration_yaml`.
protectAllJoinedRooms: true
```

Expand Down
Loading
Loading