Diff

mod_lastlog/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parent 1782:29f3d6b7ad16
child 1859:4b838e61c68e
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_lastlog/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,46 @@
+---
+labels:
+- 'Stage-Beta'
+summary: Log last login time
+...
+
+Introduction
+============
+
+Simple module that stores the timestamp of when a user logs in.
+
+Usage
+=====
+
+As with all modules, copy it to your plugins directory and then add it
+to the modules\_enabled list:
+
+        modules_enabled = {
+                        -- ...
+                        "lastlog",
+                        -- ...
+            }
+
+Configuration
+=============
+
+There are some options you can add to your config file:
+
+  Name                      Values       Description
+  ------------------------- ------------ ------------------------------------
+  lastlog\_ip\_address      true/false   Log the IP address of the user?
+  lastlog\_stamp\_offline   true/false   Add timestamp to offline presence?
+
+Usage
+=====
+
+You can check a user's last activity by running:
+
+      prosodyctl mod_lastlog username@example.com
+
+Compatibility
+=============
+
+  ----- -------
+  0.9   Works
+  ----- -------