Mercurial > prosody-modules

annotate mod_list_active/README.markdown @ 5907:d194d1012fd3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 33f7ca7bdc86
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 Description
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 ===========
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3
2638
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
4 This module lists those users, who **have** used their account in a
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
5 defined time-frame, basically the inverse of [mod_list_inactive].
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 Dependencies
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 ============
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
2190
0c01444f8bc2 mod_list_inactive/README: Describe what the dependency does
Kim Alvefur <zash@zash.se>
parents: 2189
diff changeset
10 [mod_lastlog] must be enabled to collect the data used by this module.
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 Usage
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 =====
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14
2638
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
15 prosodyctl mod_list_active example.com time [format]
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
17 Time is a number followed by 'day', 'week', 'month' or 'year'
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
18
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
19 Formats are:
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
2189
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
21 --------- ------------------------------------------------
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
22 default `user@example.com`
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
23 event `user@example.com last action`
093b1180aa42 mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents: 2188
diff changeset
24 --------- ------------------------------------------------
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 Example
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
27 =======
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
28
2638
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
29 prosodyctl mod_list_active example.com 1year
2187
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 Help
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
32 ====
287f37e6b6e1 mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
33
2638
33f7ca7bdc86 mod_list_active: Add README
Kim Alvefur <zash@zash.se>
parents: 2190
diff changeset
34 prosodyctl mod_list_active