view mod_list_inactive/README.markdown @ 5907:d194d1012fd3

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 0c01444f8bc2
children
line wrap: on
line source

Description
===========

This module lists those users, who haven't used their account in a
defined time-frame.

Dependencies
============

[mod_lastlog] must be enabled to collect the data used by this module.

Usage
=====

    prosodyctl mod_list_inactive example.com time [format]

Time is a number followed by 'day', 'week', 'month' or 'year'

Formats are:

  --------- ------------------------------------------------
  delete    `user:delete"user@example.com" -- last action`
  default   `user@example.com`
  event     `user@example.com last action`
  --------- ------------------------------------------------

Example
=======

    prosodyctl mod_list_inactive example.com 1year

Help
====

    prosodyctl mod_list_inactive