From 70d10e81b35169e6f5ad04196f84cce49d2afa11 Mon Sep 17 00:00:00 2001 From: Juliusz Chroboczek Date: Wed, 9 Jul 2025 23:21:56 +0200 Subject: [PATCH] Fixes to documentation. Thanks to the kind people on the Yunohost forums for pointing out the issues. --- INSTALL | 11 ++++++++--- README | 16 ++++++++-------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/INSTALL b/INSTALL index acdb2a8..02b8221 100644 --- a/INSTALL +++ b/INSTALL @@ -17,13 +17,18 @@ On Windows, do Set up a group called *test* by creating a file `groups/test.json`: mkdir groups - vi groups/name.json + vi groups/test.json You may use the following definition: { - "op": [{"username": "admin", "password": "1234"}], - "presenter": [{}] + "users":{ + "admin": {"password": "1234", "permissions": "op"} + }, + "wildcard-user": { + "password": {"type": "wildcard"}, + "permissions": "present" + } } See the README file for more details about defining groups. diff --git a/README b/README index 2a99d39..9e0d1d6 100644 --- a/README +++ b/README @@ -32,7 +32,7 @@ Groups are available under `/group/groupname/`. You may share this URL with others, there is no need to go through the landing page. Recordings can be accessed under `/recordings/groupname/`. This is only -available to the administrator of the group. +available to the group operator. Some statistics are available under `/stats.json`, with a human-readable version at `/stats.html`. This is only available to the server administrator. @@ -146,12 +146,12 @@ A typical group definition file looks like this: "auto-subgroups": true } -This defines a group with the operator (administrator) username *jch* and -password *1234*. The `allow-recording` entry says that the operator is -allowed to record videos to disk, and the `auto-subgroups` entry says -that subgroups will be created automatically. This particular group does -not allow password login for ordinary users, and is suitable if you use -invitations (see *Stateful Tokens* below) for ordinary users. +This defines a group with the operator username *jch* and password *1234*. +The `allow-recording` entry says that the operator is allowed to record +videos to disk, and the `auto-subgroups` entry says that subgroups will be +created automatically. This particular group does not allow password +login for ordinary users, and is suitable if you use invitations (see +*Stateful Tokens* below) for ordinary users. In order to allow password login for ordinary users, add password entries with the permission `present`: @@ -339,7 +339,7 @@ a hashed password looks like this: ### Stateful tokens Stateful tokens allow to temporarily grant access to a user. In order to -generate a stateful token, the group administrator types +generate a stateful token, the group operator types /invite user period