annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 labels:
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
3 - 'Stage-Beta'
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
4 summary: Record last timestamp of events
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
5 ---
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
6
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
7 # Introduction
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
9 Similar to [mod_lastlog], this module records the last timestamp of
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
10 various events, but keeps the last timestamp per type of event, instead
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
11 of the last event.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
13 # Usage
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
15 As with all modules, copy it to your plugins directory and then add it
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
16 to the modules\_enabled list:
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
18 ``` {.lua}
1859
4b838e61c68e mod_lastlog/README: Adjust formatting / indentation to help pandoc produce fancy html
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
19 modules_enabled = {
4b838e61c68e mod_lastlog/README: Adjust formatting / indentation to help pandoc produce fancy html
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
20 -- other modules
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
21 "lastlog2",
1859
4b838e61c68e mod_lastlog/README: Adjust formatting / indentation to help pandoc produce fancy html
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
22 }
4b838e61c68e mod_lastlog/README: Adjust formatting / indentation to help pandoc produce fancy html
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
23 ```
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
25 # Configuration
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 There are some options you can add to your config file:
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
29 Name Type Default Description
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
30 ---------------------- --------- --------- ---------------------------------
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
31 lastlog\_ip\_address boolean false Log the IP address of the user?
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
33 # Usage
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 You can check a user's last activity by running:
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36
1859
4b838e61c68e mod_lastlog/README: Adjust formatting / indentation to help pandoc produce fancy html
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
37 prosodyctl mod_lastlog username@example.com
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
39 # Compatibility
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
40
4012
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
41 Version State
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
42 --------- -------
fd582067c732 mod_lastlog2: Store last timestamp per account event
Kim Alvefur <zash@zash.se>
parents: 3117
diff changeset
43 Any *TBD*