diff mod_lastlog2/README.markdown @ 4012:fd582067c732

mod_lastlog2: Store last timestamp per account event Incompatible with mod_lastlog and other modules using its data due to use of map store
author Kim Alvefur <zash@zash.se>
date Sun, 29 Mar 2020 15:09:25 +0200
parents mod_lastlog/README.markdown@dd6313ddd3e0
children c5df6d53f17f
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_lastlog2/README.markdown	Sun Mar 29 15:09:25 2020 +0200
@@ -0,0 +1,43 @@
+---
+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_lastlog username@example.com
+
+# Compatibility
+
+  Version   State
+  --------- -------
+  Any       *TBD*