Commit Graph

1809 Commits

Author SHA1 Message Date
Suguru Hirahara
e77487ea05
Update docs/configuring-playbook-bot-maubot.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-30 01:17:23 +09:00
Suguru Hirahara
64672bfa70
Update docs/configuring-playbook-ntfy.md: add the instruction for checking logs to the section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-29 18:27:52 +09:00
Suguru Hirahara
0ae2f08e33
Update docs/configuring-playbook-ntfy.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-29 18:26:07 +09:00
Suguru Hirahara
496b921261
Update docs/container-images.md: remove definite articles from descriptions
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 22:29:27 +09:00
Suguru Hirahara
78e3089af1
Update README.md and docs/container-images.md: remove indefinite articles from descriptions to improve consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 22:29:11 +09:00
Suguru Hirahara
4b891b89eb
Update README.md and docs/container-images.md: remove the subject from the descriptions of matrix-media-repo
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 22:26:10 +09:00
Suguru Hirahara
4ab983ffc9
Update README.md and docs/container-images.md: remove periods
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 22:25:03 +09:00
Suguru Hirahara
bf3b6b75f7
Update README.md and docs/container-images.md: use the common description
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 22:24:50 +09:00
Suguru Hirahara
ce08f618db
Update docs/configuring-playbook-bot-matrix-reminder-bot.md: fix the service name
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:33:29 +09:00
Suguru Hirahara
8739de6d9c
Update docs/configuring-playbook-bot-go-neb.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:14:31 +09:00
Suguru Hirahara
6e9160053d
Update docs/configuring-playbook-bot-go-neb: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:14:15 +09:00
Suguru Hirahara
ef48afca67
Update docs/configuring-playbook-bot-honoroit.md: add the common section "Troubleshooting"
See da66cc4d0e/internal/config/config_test.go for the confirmation of logging level (debug).

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:13:09 +09:00
Suguru Hirahara
53fabab5a7
Update docs/configuring-playbook-bot-honoroit.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:12:52 +09:00
Suguru Hirahara
ce09746003
Update files for matrix-reminder-bot: adopt the common description for logging verbosity levels
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:11:19 +09:00
Suguru Hirahara
4ed111ff74
Update docs/configuring-playbook-bot-matrix-reminder-bot.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:11:06 +09:00
Suguru Hirahara
61987994ad
Update docs/configuring-playbook-bot-matrix-reminder-bot.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:10:45 +09:00
Suguru Hirahara
e5b526a55e
Update docs/configuring-playbook-bot-chatgpt.md: add the common description and section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:09:48 +09:00
Suguru Hirahara
f4b4c7ad17
Update docs/configuring-playbook-bot-chatgpt.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 18:09:02 +09:00
Suguru Hirahara
63ced228c6
Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: change placeholders
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 15:52:39 +09:00
Suguru Hirahara
049fb1d658
Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: introductory sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 15:52:30 +09:00
Suguru Hirahara
c4b4deeef6
Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 15:24:01 +09:00
Suguru Hirahara
2da5c13c26
Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 15:23:49 +09:00
Slavi Pantaleev
4f00a1f8f0
Merge pull request #4005 from luixxiul/fix
Update files for matrix-bridge-wechat
2025-01-28 07:45:48 +02:00
Suguru Hirahara
6814ead8fc
Update docs/configuring-playbook-ma1sd.md: fix configuration for increasing logging verbosity
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 13:55:52 +09:00
Suguru Hirahara
aaf76adbd7
Update files for matrix-bridge-wechat: sort the logging verbosity levels
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 13:11:59 +09:00
Suguru Hirahara
855ba5581a
Update files for matrix-bridge-wechat: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 13:11:52 +09:00
Suguru Hirahara
16d3d0e3fe
Update docs/configuring-playbook-bridge-wechat.md: add the section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 13:10:27 +09:00
Suguru Hirahara
eb5831efa3
Update files for ma1sd: add the common section "Increase logging verbosity"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 02:02:15 +09:00
Suguru Hirahara
cf01549168
Update docs/configuring-playbook-ma1sd.md: adopt the common format for the section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-28 02:01:59 +09:00
Suguru Hirahara
8f2c51305a
Update files for Email2Matrix: reflect the fact that the component has been deprecated
Unfortunately Email2Matrix has been deprecated this month. See: f1032f0ac8. As a long time user of the component, I'd like to shout out a big thank-you to Slavi!

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 23:21:25 +09:00
Suguru Hirahara
3c33f0be3b
Update files for Email2Matrix: fix capitalization
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 23:07:01 +09:00
Suguru Hirahara
e1f2d764e5
Update docs/configuring-playbook-email2matrix.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 23:06:47 +09:00
Suguru Hirahara
fa33e0b4bd
Update docs/configuring-playbook-email2matrix.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 23:04:21 +09:00
Suguru Hirahara
1db5f76024
Replace double hyphens with "Em Dash" unicode character (U+2014)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 16:36:14 +09:00
Suguru Hirahara
76e346573c
Replace hyphen as dash with "Em Dash" unicode character (U+2014)
This commit replaces hyphen characters used as dash with the actual unicode character for dash. It avoids using HTML character entity reference (&mdash;), because IMHO it would make it a bit harder to read documents as plain markdown files on your local text editor.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 16:35:59 +09:00
Suguru Hirahara
abff629e36
Update docs/configuring-playbook-cactus-comments.md: replace "-" with "&mdash;"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:42:44 +09:00
Suguru Hirahara
1f532fe90d
Update docs/configuring-playbook-cactus-comments.md: add the configuration for changing the default username (bot.cactusbot)
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:40:31 +09:00
Suguru Hirahara
89864c6de0
Update files for cactus-comments: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:22:43 +09:00
Suguru Hirahara
83ad4d4975
Update docs/configuring-playbook-cactus-comments.md: adopt the common instruction to start using the component
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:22:09 +09:00
Suguru Hirahara
f2083aa8a7
Update docs/configuring-playbook-cactus-comments.md: replace the placeholders for the site name
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:22:00 +09:00
Suguru Hirahara
7f13747e82
Update docs/configuring-playbook-cactus-comments.md: move the configuration enabled by default
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:21:43 +09:00
Suguru Hirahara
909ca59cb7
Update docs/configuring-playbook-cactus-comments.md: remove the uncommon comment block
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:20:36 +09:00
Suguru Hirahara
50f259d505
Update docs/configuring-playbook-cactus-comments.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-26 11:20:24 +09:00
Suguru Hirahara
0dc566f1a3
Update docs/configuring-playbook-bot-buscarron.md: add the common expression for linking to the documentation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 22:34:28 +09:00
Suguru Hirahara
2a7111f287
Update docs/configuring-playbook-bot-buscarron.md: add the common section "Troubleshooting"
See roles/custom/matrix-bot-buscarron/defaults/main.yml at 601406ddda for the default log value (INFO).

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 22:32:30 +09:00
Suguru Hirahara
6c19bf509e
Update docs/configuring-playbook-bot-buscarron.md: add the section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 22:30:18 +09:00
Suguru Hirahara
5c80c820bc
Update docs/configuring-playbook-bridge-hookshot.md: add a period
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:24:40 +09:00
Suguru Hirahara
acf2b90346
Update files for matrix-bridge-hookshot: change the file path of config.yml.j2 in order to improve consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:13:59 +09:00
Suguru Hirahara
e8213768a5
Update files for matrix-bridge-hookshot: sort logging levels
Based on docs/configuring-playbook-alertmanager-receiver.md

We can re-sort the levels it if is found out that debug should be placed at the first.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:13:31 +09:00
Suguru Hirahara
5c39ef8ca2
Update docs/configuring-playbook-bridge-hookshot.md: add the common section "Troubleshooting"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:13:20 +09:00
Suguru Hirahara
5b2282de27
Update docs/configuring-playbook-bridge-hookshot.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 18:07:13 +09:00
Suguru Hirahara
21b5963f63
Update files for the matrix-alertmanager-receiver: rename config.yml.j2 to config.yaml.j2 in order to improve consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 12:04:41 +09:00
Suguru Hirahara
42f38dae07
Update docs/configuring-playbook-alertmanager-receiver.md: add the common section "Troubleshooting"
The configuration was copied from main.yml.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 12:04:26 +09:00
Suguru Hirahara
d225f52ba2
Update docs/configuring-playbook-alertmanager-receiver.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-25 12:04:16 +09:00
Suguru Hirahara
30d01cc22d
Update docs/configuring-playbook-dimension.md: replace right arrows with actual ones
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 23:01:10 +09:00
Suguru Hirahara
4400d3c06d
Update docs/configuring-playbook-dimension.md: create the section "Usage"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 23:00:58 +09:00
Suguru Hirahara
5ea579d4ee
Update docs/configuring-playbook-dimension.md: apply the fact that the project has been finished and the update will not be provided
The original description has been added with a0ce5eec64 on 2020.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 22:56:16 +09:00
Suguru Hirahara
9d8dac83cc
Update docs/configuring-playbook-dimension.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 22:45:49 +09:00
Suguru Hirahara
e6d631c6f1
Update docs/configuring-playbook-bridge-appservice-slack.md: change the instruction into a sentence
Fixing the grammatical structure to avoid word puzzles for better i18n.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 18:02:39 +09:00
Suguru Hirahara
2b4865d44b
Update docs/configuring-playbook-bridge-appservice-slack.md: adopt the common expression for troubleshooting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 18:02:19 +09:00
Suguru Hirahara
ff7dbcee1b
Update docs/configuring-playbook-bridge-appservice-slack.md: add the common section "Extending the configuration"
Also: add an example for "+matrix_appservice_slack_configuration_extension_yaml"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 18:02:05 +09:00
Suguru Hirahara
d6abd30904
Update docs/configuring-playbook-user-verification-service.md (#3994)
* Update docs/configuring-playbook-user-verification-service.md: add the common section "Extending the configuration"

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

* Update docs/configuring-playbook-user-verification-service.md: replace single quotes with backticks

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

* Update docs/configuring-playbook-user-verification-service.md: adopt the common section "Troubleshooting"

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

* Update docs/configuring-playbook-user-verification-service.md: use the variable specified on main.yml directly

There are other variables specified on .env.j2 such as UVS_ACCESS_TOKEN and UVS_AUTH_TOKEN, but these are not used in the description on the document other than UVS_LOG_LEVEL. This commit therefore replaces the variable with the one specified on main.yml (matrix_user_verification_service_uvs_log_level) to improve consistency.

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

* Update docs/configuring-playbook-user-verification-service.md: fix capitalization

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

* Update docs/configuring-playbook-user-verification-service.md: replace the placeholder TOKEN with YOUR_TOKEN_HERE

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

* Update docs/configuring-playbook-user-verification-service.md: change a section title

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-24 09:01:51 +02:00
Suguru Hirahara
4c00e88fa4
Update docs/configuring-playbook-pantalaimon.md: add the common section "Troubleshooting"
The comment was copied from roles/custom/matrix-pantalaimon/defaults/main.yml. The latest status of the variable "matrix_pantalaimon_log_level" can be checked on 55fcaac1f1.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 02:04:46 +09:00
Suguru Hirahara
74e4c2a5bd
Update docs/configuring-playbook-pantalaimon.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-24 01:38:53 +09:00
Suguru Hirahara
a6333df04e
Update configuring-playbook-bot-baibot.md and configuring-playbook-bridge-postmoogle.md: the common section for troubleshooting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-23 23:30:40 +09:00
Suguru Hirahara
e047e860ff
Update docs/configuring-playbook-bridge-postmoogle.md: add the section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-23 23:30:31 +09:00
Suguru Hirahara
97418bf2ea
Update docs/configuring-playbook-email.md: tidy up
This commit applies the common format to the file.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-23 18:55:00 +09:00
Suguru Hirahara
c8ca9489bb
Update docs/configuring-playbook-bridge-mautrix-wsproxy.md: move down the section "Extending the configuration" for consistency
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-23 02:11:03 +09:00
Suguru Hirahara
fbe32cc17c
Update docs/configuring-playbook-backup-borg.md and docs/configuring-playbook-synapse-auto-compressor.md: adopt the common description
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-22 01:38:26 +09:00
Suguru Hirahara
3b685df1ab
Update docs for Draupnir and Mjolnir: improve the instructions for running the curl command to disable rate limiting
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-21 15:56:24 +09:00
Slavi Pantaleev
450e9f196d
Merge pull request #3981 from luixxiul/patch-3
Update docs/configuring-playbook-bot-draupnir.md: create and invite the bot before starting
2025-01-21 08:21:07 +02:00
Slavi Pantaleev
aaba19e1e7
Merge pull request #3977 from luixxiul/patch-1
Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md
2025-01-21 08:16:10 +02:00
Slavi Pantaleev
3343eadd46
Replace old warnings with Github Markdown Warnings on Draupnir doc page
Ref: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3980
2025-01-21 08:14:49 +02:00
Slavi Pantaleev
2698ed85a0
Replace old warnings with Github Markdown Warnings
Ref: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3980
2025-01-21 08:13:31 +02:00
Suguru Hirahara
66d96844d6
Update docs/configuring-playbook-bot-draupnir.md: move the note about the "ensure-matrix-users-created" playbook tag
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 23:14:34 +09:00
Suguru Hirahara
cb0798bc06
Update docs/configuring-playbook-bot-draupnir.md: create and soon invite the bot user to the management room
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 23:13:44 +09:00
Catalan Lover
177ac8caa1
Replace old warnings with Github Markdown Warnings
I executed a Search for `⚠️ **Warning**:` and replaced it with
```
> [!WARNING]
>
```

I also capitalised the first letter where missing.

Draupnir Docs have been excluded from this Commit as to not cause a separate PR im working on for the Draupnir docs to have potential merge conflicts and im making said change in that document too.
2025-01-20 14:39:40 +01:00
Suguru Hirahara
8eb513a49d
Update docs for Draupnir and Mjolnir: improve instructions to replace the IDs
Also: replace the placeholder for the clean access token

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 17:58:31 +09:00
Suguru Hirahara
9a0e1e64a8
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
Also: clarify that it is the admin account that needs to be obtained for Synapse's Admin APIs.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 17:58:18 +09:00
Suguru Hirahara
aea2a6d53f
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-20 17:57:58 +09:00
Suguru Hirahara
30a53efadd
Update docs for Draupnir and Mjolnir: move the note about API access above
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 17:57:30 +09:00
Slavi Pantaleev
94b10ad446
Merge pull request #3973 from luixxiul/patch-2
Update docs for Draupnir and Mjolnir: misc changes before iteration
2025-01-20 09:48:10 +02:00
Slavi Pantaleev
dbfa190456
Merge pull request #3972 from luixxiul/patch-1
Update docs for Draupnir, D4A, and Mjolnir: adopt the common section "Extending the configuration"
2025-01-20 09:45:33 +02:00
Suguru Hirahara
887db388e8
Apply the review from another PR
Cherry-picked from f7c01cca9c.
Regressed by f15c0a46be.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 16:42:24 +09:00
Suguru Hirahara
c4507d42e3
Update docs/configuring-playbook-bot-draupnir.md: add "optoional, recommended" label to the section
Unlike Mjolnir, the step is no longer required. It is optional and recommended on Draupnir, therefore it should be clarified so.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 14:00:19 +09:00
Suguru Hirahara
7186d5fb93
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 13:55:14 +09:00
Suguru Hirahara
2c7914d071
Update docs/configuring-playbook-bot-draupnir.md: 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. It is not friendly to instruct to invite the bot which does not exist just yet, only to let the known error message about the nonexistent user displayed.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:54:35 +09:00
Suguru Hirahara
7b6b103e01
Update docs/configuring-playbook-bot-draupnir.md: misc changes mainly fixing typos
The typos were introduced by f15c0a46be.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:53:37 +09:00
Suguru Hirahara
340e569984
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-20 13:51:59 +09:00
Suguru Hirahara
04ff68e229
Update docs for Draupnir and Mjolnir: tidy up the instruction to check the room ID
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:51:49 +09:00
Suguru Hirahara
39625aae15
Update docs for Draupnir and Mjolnir: small edits for the common sentences
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:51:27 +09:00
Suguru Hirahara
4e5532a0d5
Update docs for Draupnir, D4A, and Mjolnir: emphasize the importance of being careful when inviting a user to the management room
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 13:51:10 +09:00
Suguru Hirahara
8ba607a76a
Change capitalization per author's preference: Conduwuit → conduwuit
See: e8508d16e1

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 12:38:37 +09:00
Suguru Hirahara
f987d295ee
Update docs for Draupnir, D4A, and Mjolnir: adopt the common section "Extending the configuration"
Also: fix the variable "matrix_appservice_draupnir_for_all_configuration_yaml"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-20 11:43:15 +09:00
Catalan Lover
ba19e4d303
Replace Discharge with Disable
In the context of disabling rate limits on an API its disable that is correct. We arent talking about controlling the discharge rate of a battery we dont want to blow up or harm. We are talking about matrix APIs and disabling the rate limiter on them.
2025-01-19 18:14:05 +01:00
Slavi Pantaleev
1fe8b49755 Mention Conduwuit in a few more places in the documentation
Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3967
2025-01-19 16:15:41 +02:00
Slavi Pantaleev
24f3493caf Add various polish to Conduwuit
https://github.com/Virkkunen and I have been working on the same feature
simultaneously.

This patch adds my additional independent work on top of his changes.

Notable changes here compared to Virkkunen's original work:

- renaming config-related variables (`matrix_conduwuit_*` ->
  `matrix_conduwuit_config_*`). This is consistent with other roles (and
  better), but deviates from how the Conduit role was implemented.

- using a full configuration sample from https://conduwuit.puppyirl.gay/configuration.html
  instead of using the old Conduit config file template

- introducing configurability for more Conduwuit config settings, to support easy registration, etc.

- removing configuration settings that Conduwuit does not support
  anymore (e.g. `max_concurrent_requests`)

- cross-linking docs pages for Conduit and Conduwuit

- a Conduwuit docs page which is much improved compared to the old
  Conduit one

- REAMDE updates
2025-01-19 16:06:37 +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
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