Diff

mod_lastlog2/README.md @ 6209:d611ed13df7e draft

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:16:25 +0700
child 6211:750d64c47ec6
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_lastlog2/README.md	Tue Mar 18 00:16:25 2025 +0700
@@ -0,0 +1,47 @@
+---
+labels:
+- 'Stage-Beta'
+summary: Record last timestamp of events
+---
+
+# Introduction
+
+Similar to [mod_lastlog], this module records the last timestamp of
+various events, but keeps the last timestamp per type of event, instead
+of the last event.
+
+# Usage
+
+As with all modules, copy it to your plugins directory and then add it
+to the modules\_enabled list:
+
+``` {.lua}
+modules_enabled = {
+  -- other modules
+  "lastlog2",
+}
+```
+
+# Configuration
+
+There are some options you can add to your config file:
+
+  Name                   Type      Default   Description
+  ---------------------- --------- --------- ---------------------------------
+  lastlog\_ip\_address   boolean   false     Log the IP address of the user?
+
+# Usage
+
+You can check a user's last activity by running:
+
+    prosodyctl mod_lastlog2 username@example.com
+
+With Prosody trunk the command can be used via the shell:
+
+    prosodyctl shell lastlog show username@example.com
+
+# Compatibility
+
+  Version   State
+  --------- -------
+  Any       *TBD*