view mod_devices/README.markdown @ 4494:aa4dcd4b39c8

mod_rest/openapi: Improve organization and navigation Properties roughly sorted by documentation first. GET paths sorted by complexity. Spacing to help with navigation. Some XML stuff that should arguably be a separate commit, but whatever. Tags.
author Kim Alvefur <zash@zash.se>
date Thu, 04 Mar 2021 01:21:11 +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
  ------- -----------------------