view mod_devices/README.markdown @ 4493:89571a20196f

mod_rest/openapi: Describe 'version' endpoint in more detail Use the limited xml "support" in openapi to show both forms of the response.
author Kim Alvefur <zash@zash.se>
date Thu, 04 Mar 2021 00:44:15 +0100
parents 4cf65afd90f4
children
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
  ------- -----------------------