view mod_lastlog/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 dd6313ddd3e0
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
summary: Log last login time
...

Introduction
============

Simple module that stores the timestamp of when a user logs in.

Usage
=====

As with all modules, copy it to your plugins directory and then add it
to the modules\_enabled list:

``` lua
modules_enabled = {
  -- other modules
  "lastlog",
}
```

Configuration
=============

There are some options you can add to your config file:

  Name                      Type    Default Description
  ------------------------- ------- ------- ------------------------------------
  lastlog\_ip\_address      boolean false   Log the IP address of the user?
  lastlog\_stamp\_offline   boolean false   Add timestamp to offline presence?

Usage
=====

You can check a user's last activity by running:

    prosodyctl mod_lastlog username@example.com

Compatibility
=============

  ----- -------
  0.9   Works
  ----- -------