annotate mod_lastlog/README.markdown @ 4542:fb4a50bf60f1

mod_prometheus: Invoke stats collection if in 'manual' mode Since 10d13e0554f9 a special value for statistics_interval "manual" exists, where a module is expected to invoke processing in connection to collection of stats. This makes internal collection and exporting to Prometheus happens at the same time with no chance of timers getting out of sync.
author Kim Alvefur <zash@zash.se>
date Tue, 13 Apr 2021 23:53:53 +0200
parents 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'
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
4 summary: Log last login time
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
5 ...
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
7 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
8 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 Simple module that stores the timestamp of when a user logs in.
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
12 Usage
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
13 =====
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
1859
4b838e61c68e mod_lastlog/README: Adjust formatting / indentation to help pandoc produce fancy html
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
18 ``` lua
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
4b838e61c68e mod_lastlog/README: Adjust formatting / indentation to help pandoc produce fancy html
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
21 "lastlog",
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
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
25 Configuration
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
26 =============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 There are some options you can add to your config file:
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29
3117
dd6313ddd3e0 mod_lastlog: Split Values into Type/Default. (documentation)
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 1859
diff changeset
30 Name Type Default Description
dd6313ddd3e0 mod_lastlog: Split Values into Type/Default. (documentation)
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 1859
diff changeset
31 ------------------------- ------- ------- ------------------------------------
dd6313ddd3e0 mod_lastlog: Split Values into Type/Default. (documentation)
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 1859
diff changeset
32 lastlog\_ip\_address boolean false Log the IP address of the user?
dd6313ddd3e0 mod_lastlog: Split Values into Type/Default. (documentation)
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 1859
diff changeset
33 lastlog\_stamp\_offline boolean false Add timestamp to offline presence?
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
35 Usage
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
36 =====
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 You can check a user's last activity by running:
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39
1859
4b838e61c68e mod_lastlog/README: Adjust formatting / indentation to help pandoc produce fancy html
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
40 prosodyctl mod_lastlog username@example.com
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
42 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
43 =============
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
44
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
45 ----- -------
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
46 0.9 Works
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
47 ----- -------