From 0b903fc5f43a02d90551a95dc2a40cd28ff8a834 Mon Sep 17 00:00:00 2001
From: Miroslav Prasil <miroslav@prasil.info>
Date: Mon, 18 Feb 2019 14:57:21 +0000
Subject: [PATCH] Extended the template file and refer to wiki

---
 .env.template | 8 ++++++++
 src/config.rs | 2 +-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/.env.template b/.env.template
index b388e6ff..51494c5d 100644
--- a/.env.template
+++ b/.env.template
@@ -43,6 +43,14 @@
 ## It's recommended to also set 'ROCKET_CLI_COLORS=off'
 # LOG_FILE=/path/to/log
 
+## Enable WAL for the DB
+## Set to false to avoid enabling WAL during startup.
+## Note that if the DB already has WAL enabled, you will also need to disable WAL in the DB,
+## this setting only prevents bitwarden_rs from automatically enabling it on start.
+## Please read project wiki page about this setting first before changing the value as it can
+## cause performance degradation or might render  the service unable to start.
+# ENABLE_DB_WAL=true
+
 ## Disable icon downloading
 ## Set to true to disable icon downloading, this would still serve icons from $ICON_CACHE_FOLDER,
 ## but it won't produce any external network request. Needs to set $ICON_CACHE_TTL to 0,
diff --git a/src/config.rs b/src/config.rs
index dd3377db..12ae4c0f 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -254,7 +254,7 @@ make_config! {
         /// Log file path
         log_file:               String, false,  option;
 
-        /// Enable DB WAL |> Turning this off might lead to worse performance, but might help if using bitwarden_rs on some exotic filesystems, that do not support WAL
+        /// Enable DB WAL |> Turning this off might lead to worse performance, but might help if using bitwarden_rs on some exotic filesystems, that do not support WAL. Please make sure you read project wiki on the topic before changing this setting.
         enable_db_wal:          bool,   false,  def,    true;
     },
 
-- 
GitLab