File

mod_devices/README.markdown @ 4919:b9f8dd9a7fdb

mod_rest/README: Mention the OPTIONS probe fired at the callback ... in passing. Should be documented better. But not this day! This day, I commit features!
author Kim Alvefur <zash@zash.se>
date Sat, 09 Apr 2022 00:37:55 +0200
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
  ------- -----------------------