From 9c5cd42af156a07970968da52462edb77aeb4b49 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 19 Jan 2025 13:44:14 +0900 Subject: [PATCH 1/8] Update roles/custom/matrix-bot-draupnir/defaults/main.yml: fix capitalization, typo, and sentences Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bot-draupnir/defaults/main.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index aa4da34f6..632c9bfff 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -72,12 +72,12 @@ matrix_bot_draupnir_access_token: "" matrix_bot_draupnir_pantalaimon_username: "" matrix_bot_draupnir_pantalaimon_password: "" -# Username and password the bot uses for logging in directly. If using Pantalimon +# Username and password the bot uses for logging in directly. If using Pantalaimon # these values become the values of `matrix_bot_draupnir_pantalaimon_username` and `matrix_bot_draupnir_pantalaimon_password` matrix_bot_draupnir_login: "{{ matrix_bot_draupnir_pantalaimon_username if matrix_bot_draupnir_pantalaimon_use == 'true' else 'bot.draupnir' }}" matrix_bot_draupnir_password: "{{ matrix_bot_draupnir_pantalaimon_password }}" -# Controls if we activate the pantalaimon config block for now. This configuration block is proable to change name for our usecase +# Controls if we activate the Pantalaimon config block for now. This configuration block's name will probably be changed for our usecase # due to a Draupnir push to scrub Pantalaimon from the codebase. matrix_bot_draupnir_login_native: "" @@ -88,11 +88,11 @@ matrix_bot_draupnir_login_native: "" matrix_bot_draupnir_management_room: "" # Endpoint URL that Draupnir uses to interact with the Matrix homeserver (client-server API). -# Set this to the pantalaimon URL if you're using that. +# Set this to the Pantalaimon URL if you're using that. matrix_bot_draupnir_homeserver_url: "" # Endpoint URL that Draupnir could use to fetch events related to reports (client-server API and /_synapse/), -# only set this to the public-internet homeserver client API URL, do NOT set this to the pantalaimon URL. +# only set this to the public-internet homeserver client API URL. Do NOT set this to the Pantalaimon URL. matrix_bot_draupnir_raw_homeserver_url: "" # Disable Server ACL is used if you want to not give the bot the right to apply Server ACLs in rooms without complaints from the bot. From c3e9e513851803edb2833d07300e12acb6259d37 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 20 Jan 2025 18:07:48 +0900 Subject: [PATCH 2/8] Update roles/custom/matrix-bot-draupnir/defaults/main.yml: clarify that setting "matrix_bot_draupnir_pantalaimon_use" to false is opinionated Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bot-draupnir/defaults/main.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index 632c9bfff..6bd3387df 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -49,9 +49,9 @@ matrix_bot_draupnir_systemd_wanted_services_list: [] # Whether Draupnir should talk to the homeserver through Pantalaimon # If true, then other variables must be provided including pointing # `matrix_bot_draupnir_homeserver_url` to the Pantalaimon URL. -# Enabling this option is discouraged, because Draupnir does not support -# running with Pantalaimon as it would break all workflows that involve answering -# prompts with reactions. (Hint: a lot of workflows rely on them.) +# We discourage enabling this option, because it is known that running +# Draupnir along with Pantalaimon breaks all workflows that involve +# answering prompts with reactions. (Hint: a lot of workflows rely on them.) matrix_bot_draupnir_pantalaimon_use: false # If you choose to accept the risks of using Pantalaimon in your installation From 8fadab4ee84e0c9f71d9d2b563d1c8ddf1df30e2 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 21 Jan 2025 12:16:51 +0900 Subject: [PATCH 3/8] Change the expression and fix other typos Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bot-draupnir/defaults/main.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index 6bd3387df..f1d4514de 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -67,7 +67,7 @@ matrix_bot_draupnir_enable_experimental_rust_crypto: false # (Otherwise provide `matrix_bot_draupnir_pantalaimon_username` and `matrix_bot_draupnir_pantalaimon_password` instead.) matrix_bot_draupnir_access_token: "" -# User name and password for the bot. Required when using Pantalaimon. +# Username and password for the bot. Required when using Pantalaimon. # (Otherwise provide `matrix_bot_draupnir_access_token` instead.) matrix_bot_draupnir_pantalaimon_username: "" matrix_bot_draupnir_pantalaimon_password: "" @@ -77,8 +77,8 @@ matrix_bot_draupnir_pantalaimon_password: "" matrix_bot_draupnir_login: "{{ matrix_bot_draupnir_pantalaimon_username if matrix_bot_draupnir_pantalaimon_use == 'true' else 'bot.draupnir' }}" matrix_bot_draupnir_password: "{{ matrix_bot_draupnir_pantalaimon_password }}" -# Controls if we activate the Pantalaimon config block for now. This configuration block's name will probably be changed for our usecase -# due to a Draupnir push to scrub Pantalaimon from the codebase. +# Controls if we activate the config block for Pantalaimon for now. Its name will +# probably be changed for our usecase due to Draupnir's push to scrub Pantalaimon from the codebase. matrix_bot_draupnir_login_native: "" # The room ID where people can use the bot. The bot has no access controls, so @@ -91,8 +91,8 @@ matrix_bot_draupnir_management_room: "" # Set this to the Pantalaimon URL if you're using that. matrix_bot_draupnir_homeserver_url: "" -# Endpoint URL that Draupnir could use to fetch events related to reports (client-server API and /_synapse/), -# only set this to the public-internet homeserver client API URL. Do NOT set this to the Pantalaimon URL. +# Endpoint URL that Draupnir could use to fetch events related to reports (client-server API and /_synapse/). +# Only set this to the public-internet homeserver client API URL. Do NOT set this to the Pantalaimon URL. matrix_bot_draupnir_raw_homeserver_url: "" # Disable Server ACL is used if you want to not give the bot the right to apply Server ACLs in rooms without complaints from the bot. @@ -102,7 +102,7 @@ matrix_bot_draupnir_raw_homeserver_url: "" # DO NOT change this to `true` unless you are very confident that you know what you are doing. # # Please follow the advice of upstream and only change this value if you know what your doing. -# Its Exposed here because its common enough to be valid to expose. +# It is exposed here because it is common enough to be valid to expose. matrix_bot_draupnir_disable_server_acl: "false" # Controls if the room state backing store is activated. From 5731bcd22211933e21e4fdcbf3b72744d49c7f2e Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 21 Jan 2025 12:31:16 +0900 Subject: [PATCH 4/8] Update roles/custom/matrix-bot-draupnir/defaults/main.yml: fix another sentence and capitalization Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bot-draupnir/defaults/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index f1d4514de..e59dfc800 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -95,8 +95,8 @@ matrix_bot_draupnir_homeserver_url: "" # Only set this to the public-internet homeserver client API URL. Do NOT set this to the Pantalaimon URL. matrix_bot_draupnir_raw_homeserver_url: "" -# Disable Server ACL is used if you want to not give the bot the right to apply Server ACLs in rooms without complaints from the bot. -# This setting is described the following way in the Configuration. +# Disable Server ACL is used if you do not want to give the bot the right to apply Server ACLs in rooms without complaints from the bot. +# This setting is described the following way in the configuration. # # Whether or not Draupnir should apply `m.room.server_acl` events. # DO NOT change this to `true` unless you are very confident that you know what you are doing. From a7e1474c3a14af4003b7f8ebd30d210ac0277caa Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 21 Jan 2025 12:32:02 +0900 Subject: [PATCH 5/8] Update roles/custom/matrix-bot-draupnir/defaults/main.yml: strip a noisy warning and the order to check in at the upstream Multiple use of the phrase "you know what you are doing" does not increase its effect but rather makes it noisy instead. Since it is warned with capitalized "DO NOT", it is enough. Also replace the order to check in at the upstream with the recommendation, as it is inconsistent for this project overall to ask users to do so. It is not sensible to make an exception for Draupnir. Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bot-draupnir/defaults/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index e59dfc800..bd283e82b 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -100,8 +100,8 @@ matrix_bot_draupnir_raw_homeserver_url: "" # # Whether or not Draupnir should apply `m.room.server_acl` events. # DO NOT change this to `true` unless you are very confident that you know what you are doing. +# It is recommended to consult with people from the upstream project beforehand. # -# Please follow the advice of upstream and only change this value if you know what your doing. # It is exposed here because it is common enough to be valid to expose. matrix_bot_draupnir_disable_server_acl: "false" From 665f7369d68e43f5e1c898552be7df8586c8b4d7 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 21 Jan 2025 13:41:39 +0900 Subject: [PATCH 6/8] Update roles/custom/matrix-bot-draupnir/defaults/main.yml: change the subject who discourages Pantalaimon This change clarifies that it is the upstream project, not this project owner, that discourages enabling Pantalaimon for Draupnir. This distinction should make it clear who is responsible for the matter. Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bot-draupnir/defaults/main.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index bd283e82b..fb91a1c33 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -49,8 +49,9 @@ matrix_bot_draupnir_systemd_wanted_services_list: [] # Whether Draupnir should talk to the homeserver through Pantalaimon # If true, then other variables must be provided including pointing # `matrix_bot_draupnir_homeserver_url` to the Pantalaimon URL. -# We discourage enabling this option, because it is known that running -# Draupnir along with Pantalaimon breaks all workflows that involve +# +# The upstream project discourages enabling this option, because it is +# known that running Draupnir along with Pantalaimon breaks all workflows that involve # answering prompts with reactions. (Hint: a lot of workflows rely on them.) matrix_bot_draupnir_pantalaimon_use: false From 7b979ff7a93b3fb6a30a438d78dd3f59a065d20a Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 21 Jan 2025 13:55:49 +0900 Subject: [PATCH 7/8] Update roles/custom/matrix-bot-draupnir/defaults/main.yml: replace "when" with "if" for consistency and to clarify that these are conditions Note that there is no other "when" on this file. It is not sensible to keep these exceptions here. Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bot-draupnir/defaults/main.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index fb91a1c33..7c2eacde8 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -64,16 +64,16 @@ matrix_bot_draupnir_pantalaimon_breakage_ignore: false # Rust Crypto requires a clean access token that has not touched E2EE so curl is recommended as a method to obtain it. matrix_bot_draupnir_enable_experimental_rust_crypto: false -# The access token for the bot user. Required when NOT using Pantalaimon. +# The access token for the bot user. Required if Pantalaimon is NOT used. # (Otherwise provide `matrix_bot_draupnir_pantalaimon_username` and `matrix_bot_draupnir_pantalaimon_password` instead.) matrix_bot_draupnir_access_token: "" -# Username and password for the bot. Required when using Pantalaimon. +# Username and password for the bot. Required if Pantalaimon is used. # (Otherwise provide `matrix_bot_draupnir_access_token` instead.) matrix_bot_draupnir_pantalaimon_username: "" matrix_bot_draupnir_pantalaimon_password: "" -# Username and password the bot uses for logging in directly. If using Pantalaimon +# Username and password the bot uses for logging in directly. If Pantalaimon is used, # these values become the values of `matrix_bot_draupnir_pantalaimon_username` and `matrix_bot_draupnir_pantalaimon_password` matrix_bot_draupnir_login: "{{ matrix_bot_draupnir_pantalaimon_username if matrix_bot_draupnir_pantalaimon_use == 'true' else 'bot.draupnir' }}" matrix_bot_draupnir_password: "{{ matrix_bot_draupnir_pantalaimon_password }}" From 9d3ef6134bbba7bc91c915ce136f734317fd8841 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 21 Jan 2025 14:52:39 +0900 Subject: [PATCH 8/8] Update roles/custom/matrix-bot-draupnir/defaults/main.yml: make sure what the word "it" means here Here "it" should not mean "the upstream advice". Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bot-draupnir/defaults/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index 7c2eacde8..2219cdd98 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -56,7 +56,7 @@ matrix_bot_draupnir_systemd_wanted_services_list: [] matrix_bot_draupnir_pantalaimon_use: false # If you choose to accept the risks of using Pantalaimon in your installation -# against the upstream advice, you can enable this to disable the warning about it. +# against the upstream advice, you can enable this to disable the warning about using it. matrix_bot_draupnir_pantalaimon_breakage_ignore: false # Tells the bot if it should use its native E2EE support in the form of experimental Rust Crypto in the bot SDK.