prosody-modules
24316a399978
mod_lastlog2/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_lastlog2/README.md @ 6210:24316a399978 draft

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:19:25 +0700
parent 6209:d611ed13df7e
child 6211:750d64c47ec6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6209
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
1 ---
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
2 labels:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
3 - 'Stage-Beta'
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
4 summary: Record last timestamp of events
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
5 ---
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
6
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
7 # Introduction
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
8
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
9 Similar to [mod_lastlog], this module records the last timestamp of
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
10 various events, but keeps the last timestamp per type of event, instead
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
11 of the last event.
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
12
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
13 # Usage
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
14
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
15 As with all modules, copy it to your plugins directory and then add it
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
16 to the modules\_enabled list:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
17
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
18 ``` {.lua}
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
19 modules_enabled = {
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
20 -- other modules
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
21 "lastlog2",
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
22 }
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
23 ```
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
24
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
25 # Configuration
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
26
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
27 There are some options you can add to your config file:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
28
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
29 Name Type Default Description
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
30 ---------------------- --------- --------- ---------------------------------
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
31 lastlog\_ip\_address boolean false Log the IP address of the user?
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
32
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
33 # Usage
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
34
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
35 You can check a user's last activity by running:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
36
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
37 prosodyctl mod_lastlog2 username@example.com
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
38
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
39 With Prosody trunk the command can be used via the shell:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
40
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
41 prosodyctl shell lastlog show username@example.com
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
42
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
43 # Compatibility
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
44
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
45 Version State
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
46 --------- -------
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
47 Any *TBD*