diff mod_storage_memory/README.md @ 5975: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
parents mod_storage_memory/README.markdown@f5d4e23fa8f7
children ad3c709a1b16
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_storage_memory/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,29 @@
+---
+labels:
+- 'Stage-Merged'
+- 'Type-Storage'
+- ArchiveStorage
+summary: 'Simple memory-only storage module'
+...
+
+Introduction
+============
+
+This module acts as a normal storage module for Prosody, but saves all
+data in memory only. All data is lost when the server stops. This makes
+it useful for testing, or certain specialized applications.
+
+Details
+=======
+
+Because the accounts store will always begin empty, it is mostly useful
+combined with an authentication plugin which doesn't use Prosody's
+storage API, or with [mod\_auth\_any](mod_auth_any.html), or you can
+create user accounts manually each time the server starts.
+
+Compatibility
+=============
+
+  ----- -------
+  0.9   Works
+  ----- -------