From a2ddbb81690dec5075bd75a691010c2509b1d297 Mon Sep 17 00:00:00 2001 From: Catalan Lover Date: Fri, 30 May 2025 11:03:59 +0200 Subject: [PATCH] Update Draupnir config template to v2.3.1 template Also removes the FIX ME for Polling as well it being broken in the playbook is no longer true. --- .../templates/production.yaml.j2 | 38 ++++++++----------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/roles/custom/matrix-bot-draupnir/templates/production.yaml.j2 b/roles/custom/matrix-bot-draupnir/templates/production.yaml.j2 index 21a9eeeef..874a3badd 100644 --- a/roles/custom/matrix-bot-draupnir/templates/production.yaml.j2 +++ b/roles/custom/matrix-bot-draupnir/templates/production.yaml.j2 @@ -7,7 +7,8 @@ SPDX-FileCopyrightText: 2024 Suguru Hirahara SPDX-License-Identifier: AGPL-3.0-or-later #} -# Endpoint URL that Draupnir uses to interact with the Matrix homeserver (client-server API), +# 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. homeserverUrl: {{ matrix_bot_draupnir_config_homeserverUrl | to_json }} # Endpoint URL that Draupnir could use to fetch events related to reports (client-server API and /_synapse/), @@ -22,7 +23,10 @@ accessToken: {{ matrix_bot_draupnir_config_accessToken | to_json }} {% if matrix_bot_draupnir_pantalaimon_use or matrix_bot_draupnir_login_native %} # Options related to Pantalaimon (https://github.com/matrix-org/pantalaimon) pantalaimon: - # Set to `true` when the bot is to login and fetch the access token on its own. + # Whether or not Draupnir will use pantalaimon to access the matrix homeserver, + # set to `true` if you're using pantalaimon. + # + # Be sure to point homeserverUrl to the pantalaimon instance. # # Draupnir will log in using the given username and password once, # then store the resulting access token in a file under dataPath. @@ -34,13 +38,14 @@ pantalaimon: # The password Draupnir will login with. # # After successfully logging in once, this will be ignored, so this value can be blanked after first startup. - # This option can be loaded from a file by passing "--password-path " at the command line, + # This option can be loaded from a file by passing "--pantalaimon-password-path " at the command line, # which would allow using secret management systems such as systemd's service credentials. password: {{ matrix_bot_draupnir_password | to_json }} {% endif %} -# Experimental usage of the matrix-bot-sdk rust crypto. This can not be used with Pantalaimon. -# Make sure Pantalaimon is disabled in Draupnir's configuration. +# Experimental usage of the matrix-bot-sdk rust crypto. +# This can not be used with Pantalaimon. +# Make sure to setup the bot as if you are not using pantalaimon for this. # # Warning: At this time this is not considered production safe. experimentalRustCrypto: {{ matrix_bot_draupnir_config_experimentalRustCrypto | to_json }} @@ -68,22 +73,12 @@ recordIgnoredInvites: false # (see verboseLogging to adjust this a bit.) managementRoom: {{ matrix_bot_draupnir_config_managementRoom | to_json }} -# Deprecated and will be removed in a future version. -# Running with verboseLogging is unsupported. -# Whether Draupnir should log a lot more messages in the room, -# mainly involves "all-OK" messages, and debugging messages for when Draupnir checks bans in a room. -verboseLogging: false - # The log level of terminal (or container) output, # can be one of DEBUG, INFO, WARN and ERROR, in increasing order of importance and severity. # # This should be at INFO or DEBUG in order to get support for Draupnir problems. logLevel: "INFO" -# Whether or not Draupnir should synchronize policy lists immediately after startup. -# Equivalent to running '!draupnir sync'. -syncOnStartup: true - # Whether or not Draupnir should check moderation permissions in all protected rooms on startup. # Equivalent to running `!draupnir verify`. verifyPermissionsOnStartup: true @@ -131,11 +126,13 @@ protectAllJoinedRooms: false # of the homeserver may be more impacted. backgroundDelayMS: 500 -# Server administration commands, these commands will only work if Draupnir is +# Server administrative features. These will only work if Draupnir is # a global server administrator, and the bot's server is a Synapse instance. +# Please review https://the-draupnir-project.github.io/draupnir-documentation/bot/homeserver-administration admin: - # Whether or not Draupnir can temporarily take control of any eligible account from the local homeserver who's in the room - # (with enough permissions) to "make" a user an admin. + # Whether to enable the make admin command. + # This command allows Draupnir can temporarily take control of any eligible account + # from the local homeserver in the target room (with enough permissions) to "make" another user an admin. # # This only works if a local user with enough admin permissions is present in the room. enableMakeRoomAdminCommand: {{ matrix_bot_draupnir_config_admin_enableMakeRoomAdminCommand | to_json }} @@ -300,13 +297,10 @@ web: authorization: {{ matrix_bot_draupnir_config_web_synapseHTTPAntispam_authorization | to_json }} {% endif %} -# FIXME: This configuration option is currently broken in the playbook as admin APIs cannot -# be accessed from containers. See https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3389 -# and https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3308 # Whether or not to actively poll synapse for abuse reports, to be used # instead of intercepting client calls to synapse's abuse endpoint, when that # isn't possible/practical. -#pollReports: false +pollReports: false # Whether or not new reports, received either by webapi or polling, # should be printed to our managementRoom.