Commit Graph

8985 Commits

Author SHA1 Message Date
Suguru Hirahara
7f46bb43b9
Update docs/configuring-playbook-bot-draupnir.md: add an anchor link to configuring-playbook-bot-mjolnir.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 00:00:10 +09:00
Suguru Hirahara
caaac89420
Update docs/configuring-playbook-bot-draupnir.md: add a reminder to remove the configurations for Pantalaimon
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 23:08:47 +09:00
Suguru Hirahara
2c92caf2da
Update docs for Draupnir and Mjolnir: move the sections for E2EE support to the "Adjusting the playbook configuration" section
Also:
- docs/configuring-playbook-bot-draupnir.md: adjust the sections
- docs/configuring-playbook-bot-mjolnir.md: add the common instruction to the document for Mjolnir

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 23:08:40 +09:00
Suguru Hirahara
fded474727
Update docs/configuring-playbook-bot-draupnir.md: add an instruction for sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 23:08:34 +09:00
Suguru Hirahara
ef7c3dd4aa
Update docs for Draupnir and Mjolnir: move the section for discharging the rate limits under the "Installing" section
Removing the rate limits is the last task before setting the component for use after the bot user is supposed to have been created successfully. Since running the playbook with the "start" tag would start Draupnir or Mjolnir as well, it should be done after running the playbook for installation initially.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 23:07:55 +09:00
Suguru Hirahara
47e87929f6
Update docs/configuring-playbook-bot-draupnir.md: tidy up the procedure for creating a bot user with E2EE enabled
Also: add the example of a curl command to obtain a fresh access token

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 23:05:44 +09:00
Suguru Hirahara
b6a282cd54
Update docs/configuring-playbook-bot-draupnir.md: create the bot user before trying to obtain the fresh token of it
The user obviously needs to be created before its access token can be obtained.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 23:05:13 +09:00
Suguru Hirahara
a685478610
Update docs/configuring-playbook-bot-draupnir.md: replace a sentence
Based on https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#protecting-encrypted-rooms

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 23:04:59 +09:00
Suguru Hirahara
bc59f4554b
Update docs for Draupnir and Mjolnir: iterate
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 23:04:04 +09:00
Suguru Hirahara
4830ecafa4
Update docs/configuring-playbook-bot-draupnir.md: add the section for instruction to disable Pantalaimon for Draupnir
The latest version of the document for v1.x.x is available at a4f9bdebcd.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:24:06 +09:00
Suguru Hirahara
cf63fef91b
Update docs for Draupnir and Mjolnir: tidy up the description about checking the room ID
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:23:56 +09:00
Suguru Hirahara
6ca9d5ebd9
Update docs for Draupnir and Mjolnir: add the instruction to run the playbook before the instruction to run the curl command
It is necessary to run the playbook to apply the configuration so that the curl command, which is described below, can be successfully executed.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:23:49 +09:00
Suguru Hirahara
e6262b74c5
Update docs for Draupnir and Mjolnir: add the "optional" label to E2EE support sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:23:36 +09:00
Suguru Hirahara
c4ae4f6d85
Update docs/configuring-playbook-bot-draupnir.md: add "recommended" label to the section
Unlike Mjolnir the step is no longer required though it is recommended.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:23:15 +09:00
Suguru Hirahara
034b5e3166
Update docs for Draupnir and Mjolnir: tidy up the descriptions in the sections for rate limiting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:23:07 +09:00
Suguru Hirahara
f0e7bb1e1d
Update docs/configuring-playbook-bot-draupnir.md: create the subsection for running the playbook
- Move the note about ensure-matrix-users-created from below
- Update the installation command: the "ensure-matrix-users-created" tag is no longer necessary as it is instructed to run above

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:22:57 +09:00
Suguru Hirahara
5e2586a27e
Update docs/configuring-playbook-bot-draupnir.md: fix the condition for commenting out matrix_bot_draupnir_login_native
Because enabling the native E2EE support requires the clean access token obtained with curl, which is supposed to be specified to "matrix_bot_draupnir_access_token", setting "matrix_bot_draupnir_enable_experimental_rust_crypto" to true means that "matrix_bot_draupnir_access_token" is also specified.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:22:26 +09:00
Suguru Hirahara
f3385ab9ff
Update docs/configuring-playbook-bot-draupnir.md: common instructions for commenting out
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:22:17 +09:00
Suguru Hirahara
025fbcc626
Update docs/configuring-playbook-bot-draupnir.md: move the configuration for the management room above
The setting is required, and it is not friendly to split the required settings with optional ones.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:22:05 +09:00
Suguru Hirahara
de5b241c4b
Update docs for Draupnir and Mjolnir: the instructions for running the curl command
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:21:38 +09:00
Suguru Hirahara
cb5d5de357
Update roles/custom/matrix-bot-draupnir/defaults/main.yml: fix capitalization and sentences
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:21:17 +09:00
Suguru Hirahara
2cecf38d49
Update docs for Draupnir and Mjolnir: instructions to replace the IDs
- Replace the placeholder for the clean access token

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:20:51 +09:00
Suguru Hirahara
163a2766cf
Update docs for Draupnir and Mjolnir: move the instruction to obtain an access token for the admin account above the one about running the curl command
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:20:23 +09:00
Suguru Hirahara
3bd5ae8ddd
Update docs for Draupnir and Mjolnir: create subsections for the instruction about making sure the account is free from rate limiting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:20:11 +09:00
Suguru Hirahara
e74e3eb4dc
Update docs for Draupnir and Mjolnir: move the note about API access above
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:20:05 +09:00
Suguru Hirahara
e91ecbd4ba
Update docs for Draupnir, D4A, and Mjolnir: emphasize the importance of being careful when inviting a user to the management room
- 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>
2025-01-19 17:19:55 +09:00
Suguru Hirahara
91304d1eee
Update docs for Draupnir and Mjolnir: invite the Draupnir bot after installation
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>
2025-01-19 17:19:48 +09:00
Suguru Hirahara
317732a3bb
Update docs/configuring-playbook-appservice-draupnir-for-all.md: remove the duplicated instruction to set an alias to the management room
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:19:33 +09:00
Suguru Hirahara
cea73e0190
Update docs for Draupnir and Mjolnir: small edits
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:19:24 +09:00
Suguru Hirahara
e66d217236
Update docs/configuring-playbook-bot-draupnir.md: misc changes
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:19:13 +09:00
Suguru Hirahara
bf451a62d3
Update docs for Draupnir, D4A, and Mjolnir: adopt the common section "extending the configuration"
- Fix the variable "matrix_appservice_draupnir_for_all_configuration_yaml"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-19 17:18:37 +09:00
Slavi Pantaleev
2ad9f37da7 Add more changelog notes about Synapse v1.122.0 requiring Postgres v13 2025-01-19 09:38:05 +02:00
Slavi Pantaleev
ad3de5737e Add note about Synapse v1.122.0 requiring Postgres v13+
Ref: cc5ac80e9e (commitcomment-151503687)
2025-01-19 09:34:22 +02:00
Catalan Lover
f15c0a46be
Draupnir 2.0.0 (#3941)
* Draupnir 2.0.0

The config getting changes all over the place is because of 2.0 having removed a lot of config options due to the code being removed.

* Update Draupnir Documentation to reflect state as of 2.0.0

* Apply Review Feedback

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>

* Change Room IDs found in code review to not conform to playbook standard.

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>

* Further Integrate Code Review Feedback

* Apply remaining suggestions from code review.

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>

* Apply Configuration Review Feedback

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>

* Add Self Registration and Native Login to Draupnir

* Rework Draupnir Documentation to Remove Pantalaimon

* Set bot.draupnir as default username for the bot in config

* Draupnir 2.0.1

* Integrate Review Feedback on Structure of Docs

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>

* Further Restructure Docs and tweak variables in response.

* Only auto-create draupnir user if a password has been set

The Draupnir role supports configuring it with either an access token or with a password.

When a password is not assigned (which means the access token mode is used), the user is to be created manually.

* Add ensure-matrix-users-created tag

Now that the Draupnir user may be auto-created in certain configurations (if a password is assigned), it's useful to have the tag there.

---------

Co-authored-by: Suguru Hirahara <luixxiul@users.noreply.github.com>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2025-01-18 21:25:30 +02:00
Slavi Pantaleev
3e06e4be63
Merge pull request #3962 from luixxiul/fix
Move config j2 files out of "config" subfolder for consistency
2025-01-18 17:46:25 +02:00
Suguru Hirahara
41d0fb8c86
Move config j2 files out of "config" subfolder for consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-18 22:08:04 +09:00
Slavi Pantaleev
c72868eefd
Merge pull request #3961 from luixxiul/fix
Update docs/configuring-playbook-jitsi.md: add instructions to create vars.yml files for each additional JVB (Jitsi VideoBridge)
2025-01-18 14:53:26 +02:00
Aine
3a9eb47517
borgmatic v1.9.6 2025-01-18 13:39:28 +02:00
Suguru Hirahara
575d98172a
Update docs/configuring-playbook-jitsi.md: add instructions to create vars.yml files for each additional JVB (Jitsi VideoBridge)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-18 17:58:51 +09:00
Suguru Hirahara
58ad120951
Update docs/configuring-playbook-bot-baibot.md (#3960)
* Update docs/configuring-playbook-bot-baibot.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-bot-baibot.md: add the common section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-18 10:25:56 +02:00
Suguru Hirahara
99f4af2007
Update files for Sygnal (#3958)
* Rename sygnal.yaml.j2 to config.yaml.j2

There does not seem to exist other yaml.j2 files, which would be named after the servive.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-sygnal.md: add the section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-18 09:15:04 +02:00
Suguru Hirahara
532d5e21b0
Update docs/configuring-playbook-appservice-double-puppet.md (#3956)
* Update docs/configuring-playbook-appservice-double-puppet.md: add the common section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-appservice-double-puppet.md: introduction and usage

The section linked from https://docs.mau.fi/bridges/general/double-puppeting.html#appservice-method-new has been removed.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-17 17:32:56 +02:00
Suguru Hirahara
107e9d205d
Edit YAML files: minor changes (#3955)
* Update roles/custom/matrix-coturn/defaults/main.yml: edit an instruction for creating a strong password

Follow-up to 6b87d1aa7d

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update examples/vars.yml: add a whitespace character for indenting

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-17 13:14:41 +02:00
Suguru Hirahara
d6fda786ca
Update docs/configuring-playbook-etherpad.md (#3954)
* Update docs/configuring-playbook-etherpad.md: add the common section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-etherpad.md: add the option to configure the default pad text

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-etherpad.md: remove the detail about setting the unmaintained Dimension default to the Etherpad instance

We have recommended users to avoid installing Dimension since it was deprecated, so it is no longer sensible to discuss how it could be integrated with Etherpad.

This commit also removes the known issue section as it describes the issue which can be experienced on Dimension only.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-etherpad.md: minor changes

- Update the internal anchor link (follow-up to 04b32af0c1)
- minor edits

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Apply the feedback

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-17 11:34:58 +02:00
Suguru Hirahara
2773c053d0
Update files for coturn (#3953)
* Update docs/configuring-playbook-turn.md: add a section for description about installing

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-turn.md and a related file

- Edit the introducion based on docs/configuring-playbook-client-element-web.md
- Adopt the commont format by creating the section "Adjusting the playbook configuration"
- Add the section "Extending the configuration"
- Move the section "Disabling Coturn" to the bottom

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Fix capitalization: Coturn → coturn

See: https://github.com/coturn/coturn. Note that "coturn" is not capitalized even on the start of a sentence, except some rare cases like on the releases page: https://github.com/coturn/coturn/releases

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-17 10:19:17 +02:00
Slavi Pantaleev
96dbb98b37
Merge pull request #3952 from luixxiul/fix
Mentions mash-playbook on feature_request.md and faq.md
2025-01-17 09:38:54 +02:00
Suguru Hirahara
686d9935e2
Mentions mash-playbook on feature_request.md and faq.md
Make one of the list items compact for the new item about mash-playbook

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-17 13:53:59 +09:00
Slavi Pantaleev
6486362162
Merge pull request #3950 from spantaleev/renovate/matrixdotorg-dendrite-monolith-0.x
Update matrixdotorg/dendrite-monolith Docker tag to v0.14.1
2025-01-16 21:39:32 +02:00
Slavi Pantaleev
f180b7a643
Merge pull request #3949 from spantaleev/renovate/ghcr.io-t2bot-matrix-media-repo-1.x
Update ghcr.io/t2bot/matrix-media-repo Docker tag to v1.3.8
2025-01-16 21:38:28 +02:00
renovate[bot]
dc0af85361
Update matrixdotorg/dendrite-monolith Docker tag to v0.14.1 2025-01-16 19:31:01 +00:00