File

mod_devices/README.markdown @ 5931: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
parent 3397:4cf65afd90f4
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: 'Device identification'
...

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

This is an experimental module that aims to identify the different
devices (technically clients) that a user uses with their account.

It is expected that at some point this will be backed by a nicer protocol,
but it currently uses a variety of hacky methods to track devices between
sessions.

Usage
=====

``` {.lua}
modules_enabled = {
    -- ...
    "devices",
    -- ...
}
```

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

Option summary
--------------

  option                         type                    default
  ------------------------------ ----------------------- -----------
  max\_user\_devices             number                  `5`


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

  ------- -----------------------
  trunk   Works
  0.11    Works
  0.10    Does not work
  ------- -----------------------