From d817810be96fffa3a009ee6408a2910bd3702a8d Mon Sep 17 00:00:00 2001 From: gnuxie Date: Wed, 2 Oct 2024 17:23:34 +0100 Subject: [PATCH] Add more detail about safe mode to the config file. --- config/default.yaml | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/config/default.yaml b/config/default.yaml index 03ce765d..d4570ccc 100644 --- a/config/default.yaml +++ b/config/default.yaml @@ -211,9 +211,19 @@ protections: roomStateBackingStore: enabled: false +# Safe mode provides recovery options for some failure modes when Draupnir +# fails to start. For example, if the bot fails to resolve a room alias in +# a watched list, or if the server has parted from a protected room and can't +# find a way back in. Safe mode will provide different options to recover from +# these. Such as unprotecting the room or unwatching the policy list. +# By default Draupnir will boot into safe mode only when the failure mode +# is recoverable. +# It may be desirable to prevent the bot from starting into safe mode if you have +# a pager system when Draupnir is down, as Draupnir could prevent your monitoring +# system from identifying a failure to start. #safeMode: # # The option for entering safe mode when Draupnir fails to start up. -# # - "RecoveryOnly" will only start the bot in safe mode when there are recovery options available. +# # - "RecoveryOnly" will only start the bot in safe mode when there are recovery options available. This is the default. # # - "Never" will never start the bot in safe mode when Draupnir fails to start normally. # # - "Always" will always start the bot in safe mode when Draupnir fails to start normally. # bootOption: RecoveryOnly