Diff

mod_storage_lmdb/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 1820:8de50be756e5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_lmdb/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,31 @@
+---
+labels:
+- 'Stage-Beta'
+- 'Type-Storage'
+summary: 'Lightning Memory-Mapped Database storage'
+...
+
+Introduction
+============
+
+This is a storage module using OpenLDAP Lightning Memory-Mapped Database
+as backend.
+
+Dependencies
+============
+
+[lightningdbm](https://github.com/shmul/lightningdbm) is required to
+access LMDB databases.
+
+Details
+=======
+
+Refer to [Prosodys data storage
+documentation](https://prosody.im/doc/storage).
+
+Compatibility
+=============
+
+  -------- -------------
+  \>=0.9   Should work
+  -------- -------------