From 2b2793fac6b2384217e70424dbd16752060dec14 Mon Sep 17 00:00:00 2001 From: Tamara Schmitz Date: Mon, 4 Nov 2024 14:27:43 +0100 Subject: [PATCH] docs: add note about the nixos service defaulting to sqlite MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: June 🍓🦴 --- docs/deploying/nixos.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/deploying/nixos.md b/docs/deploying/nixos.md index 9147db7f..61fb3916 100644 --- a/docs/deploying/nixos.md +++ b/docs/deploying/nixos.md @@ -39,6 +39,15 @@ The `flake.nix` and `default.nix` do not currently provide a NixOS module (contr welcome!), so [`services.matrix-conduit`][module] from Nixpkgs can be used to configure conduwuit. +### Conduit NixOS Config Module and SQLite + +Beware! The [`services.matrix-conduit`][module] module defaults to SQLite as a database backend. +Conduwuit dropped SQLite support in favor of exclusively supporting the much faster RocksDB. +Make sure that you are using the RocksDB backend before migrating! + +There is a [tool to migrate a Conduit SQLite database to +RocksDB](https://github.com/ShadowJonathan/conduit_toolbox/). + If you want to run the latest code, you should get conduwuit from the `flake.nix` or `default.nix` and set [`services.matrix-conduit.package`][package] appropriately to use conduwuit instead of Conduit.