Diff

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_metronome_readonly/README.markdown	Fri Jan 10 23:17:09 2025 +0100
@@ -0,0 +1,48 @@
+---
+labels:
+- 'Type-Storage'
+- 'Stage-Alpha'
+summary: Metronome Read-only Storage Module
+...
+
+Introduction
+============
+
+This is a storage backend using Metronome Lua storage.
+
+This module only works in read-only, and was made to be used by [mod\_migrate]
+to migrate from Metronome’s storage.
+
+So far it has only been tested migrating to sqlite, because
+mod\_storage\_internal relies on the same `data_path` variable as this module,
+and thus would overwrite the files we just read.
+
+I’ve also only tested it on a dump from a Metronome configured by Yunohost, so
+using LDAP and such for user accounts, I don’t yet know how to migrate from
+different Metronome account storages.
+
+Configuration
+=============
+
+Copy the module to the prosody modules/plugins directory.
+
+In Prosody's configuration file, set:
+
+    storage = "metronome_readonly"
+    data_path = "/var/lib/metronome"
+
+To run the actual migration, run this command:
+
+    ./prosodyctl mod_migrate kl.netlib.re roster,vcard,private,cloud_notify,pep,pep-archive,offline-archive,archive-archive sql
+
+It will create a file in `/var/lib/metronome/prosody.sqlite`, after which you
+can change your configuration file to point to it, or alternatively you can
+perform a second migration to the internal storage if you prefer that.
+
+Compatibility
+=============
+
+  ------------------------ --------
+  trunk (as of 2025-01-10) Works
+  0.12                     Untested
+  ------------------------ --------