Running without WAL enabled

By default during the startup bitwarden_rs will try to enable WAL for the DB. Adding this improves performance and in the past helped preventing failed requests under some circumstances.

Reasons to turn WAL off

Generally speaking unless you're absolutely sure, that you need to turn WAL off, you should leave it enabled. However there might be some valid cases to turn it off. For example:

• Some filesystems don't support WAL - this is especially true for network filesystems. If you're using such filesystem, the service will fail to start with Failed to turn on WAL error message.
• The database requires sqlite version 3.7.0 or newer, so if you for any reason (for example backups) require to access the DB directly with some other tool that cannot be updated, you might need to disable WAL.
• One of the disadvantages described here affects you

How to turn WAL off

0. Make backup

These changes are generally safe and can be done without data loss, however backing up your data prior to any changes is strongly advised.

1. Disable WAL on old DB

If you have old DB, that was used with WAL enabled, you need to enable it using sqlite:

1. Stop bitwarden_rs
2. Locate your data folder. Normally there will be db.sqlite3 file there unless you specified some other name to use.
3. Open the file using sqlite:

sqlite3 db.sqlite3

4. Disable WAL by typing PRAGMA journal_mode=delete; and pressing enter:

sqlite> PRAGMA journal_mode=delete;
delete

5. Quit sqlite utility by typing .quit and pressing enter. (notice the dot at the beginning)

2. Disable WAL in bitwarden_rs

To turn WAL off, you need to start bitwarden_rs with ENABLE_DB_WAL variable set to false:

docker run -d --name bitwarden \
  -e ENABLE_DB_WAL=false \
  -v /bw-data/:/data/ \
  -p 80:80 \
  mprasil/bitwarden:latest

Make sure to always start with this variable present as starting even once without it will enable WAL again. (if that happens start at the first step to disable it again)

How to turn WAL on

Generally speaking you just start bitarden_rs without ENABLE_DB_WAL set to false and server will automatically enable WAL for you. You can verify this by running:

sqlite3 db.sqlite3 'PRAGMA journal_mode'

Where db.sqlite3 is the DB file used by bitwarden_rs. It should return back the mode that is currently used, so in our case it's wal. Disabled WAL will typically report back delete as this is the default.