Fixes to documentation.
Thanks to the kind people on the Yunohost forums for pointing out the issues.
This commit is contained in:
@@ -17,13 +17,18 @@ On Windows, do
|
|||||||
Set up a group called *test* by creating a file `groups/test.json`:
|
Set up a group called *test* by creating a file `groups/test.json`:
|
||||||
|
|
||||||
mkdir groups
|
mkdir groups
|
||||||
vi groups/name.json
|
vi groups/test.json
|
||||||
|
|
||||||
You may use the following definition:
|
You may use the following definition:
|
||||||
|
|
||||||
{
|
{
|
||||||
"op": [{"username": "admin", "password": "1234"}],
|
"users":{
|
||||||
"presenter": [{}]
|
"admin": {"password": "1234", "permissions": "op"}
|
||||||
|
},
|
||||||
|
"wildcard-user": {
|
||||||
|
"password": {"type": "wildcard"},
|
||||||
|
"permissions": "present"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
See the README file for more details about defining groups.
|
See the README file for more details about defining groups.
|
||||||
|
|||||||
@@ -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.
|
with others, there is no need to go through the landing page.
|
||||||
|
|
||||||
Recordings can be accessed under `/recordings/groupname/`. This is only
|
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
|
Some statistics are available under `/stats.json`, with a human-readable
|
||||||
version at `/stats.html`. This is only available to the server administrator.
|
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
|
"auto-subgroups": true
|
||||||
}
|
}
|
||||||
|
|
||||||
This defines a group with the operator (administrator) username *jch* and
|
This defines a group with the operator username *jch* and password *1234*.
|
||||||
password *1234*. The `allow-recording` entry says that the operator is
|
The `allow-recording` entry says that the operator is allowed to record
|
||||||
allowed to record videos to disk, and the `auto-subgroups` entry says
|
videos to disk, and the `auto-subgroups` entry says that subgroups will be
|
||||||
that subgroups will be created automatically. This particular group does
|
created automatically. This particular group does not allow password
|
||||||
not allow password login for ordinary users, and is suitable if you use
|
login for ordinary users, and is suitable if you use invitations (see
|
||||||
invitations (see *Stateful Tokens* below) for ordinary users.
|
*Stateful Tokens* below) for ordinary users.
|
||||||
|
|
||||||
In order to allow password login for ordinary users, add password entries
|
In order to allow password login for ordinary users, add password entries
|
||||||
with the permission `present`:
|
with the permission `present`:
|
||||||
@@ -339,7 +339,7 @@ a hashed password looks like this:
|
|||||||
### Stateful tokens
|
### Stateful tokens
|
||||||
|
|
||||||
Stateful tokens allow to temporarily grant access to a user. In order to
|
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
|
/invite user period
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user