1
Fork 0
mirror of https://github.com/jech/galene.git synced 2024-11-10 02:35:58 +01:00

Tweak README.

This commit is contained in:
Juliusz Chroboczek 2023-05-03 14:47:06 +02:00
parent 1879ec81ea
commit 3228147eed

43
README
View file

@ -91,11 +91,13 @@ it easy to copy or link group definitions. You may use subdirectories:
a file `groups/teaching/networking.json` defines a group called a file `groups/teaching/networking.json` defines a group called
*teaching/networking*. *teaching/networking*.
## Examples
A typical group definition file looks like this: A typical group definition file looks like this:
{ {
"op":[{"username":"jch","password":"1234"}], "op":[{"username":"jch","password":"1234"}],
"presenter":[{}],
"allow-recording": true, "allow-recording": true,
"allow-subgroups": true "allow-subgroups": true
} }
@ -105,20 +107,45 @@ password *1234*, empty username and password for presenters (ordinary
users with the right to enable their camera and microphone). The users with the right to enable their camera and microphone). The
`allow-recording` entry says that the operator is allowed to record videos `allow-recording` entry says that the operator is allowed to record videos
to disk, and the `allow-subgroups` entry says that subgroups will be to disk, and the `allow-subgroups` entry says that subgroups will be
created automatically. created automatically. This particular group does not allow password
login for ordinary users, and is suitable if you use invitations (see
*Stateful Token* below) for ordinary users.
More precisely, every group definition file contains a single JSON In order to allow password login for ordinary users, add a list of users
directory (a list of entries between `{' and `}'). All fields are as the entry `presenter`:
optional, but unless you specify at least one user definition (`op`,
`presenter`, or `other`), nobody will be able to join the group. The {
following fields are allowed: "op": [{"username":"jch","password":"1234"}],
"presenter": [{"username":"john", "password": "secret"}]
}
If the group is to be publicly accessible, you may allow logins with any
username and an empty password:
{
"op": [{"username":"jch","password":"1234"}],
"presenter": [{}],
"public": true
}
The empty dictionary `{}` is a wildcard entry: it matches any username and
any password. Setting `public` causes the group to be displayed in the
list of public groups on the landing page
## Reference
Every group definition file contains a single JSON directory (a list of
entries between `{' and `}'). All fields are optional, but unless you
specify at least one user definition (`op`, `presenter`, or `other`),
nobody will be able to join the group. The following fields are allowed:
- `op`, `presenter`, `other`: each of these is an array of user - `op`, `presenter`, `other`: each of these is an array of user
definitions (see *Authorisation* below) and specifies the users allowed definitions (see *Authorisation* below) and specifies the users allowed
to connect respectively with operator privileges, with presenter to connect respectively with operator privileges, with presenter
privileges, and as passive listeners; privileges, and as passive listeners;
- `authKeys`, `authServer` and `authPortal`: see *Authorisation* below; - `authKeys`, `authServer` and `authPortal`: see *Authorisation* below;
- `public`: if true, then the group is visible on the landing page; - `public`: if true, then the group is listed on the landing page;
- `displayName`: a human-friendly version of the group name; - `displayName`: a human-friendly version of the group name;
- `description`: a human-readable description of the group; this is - `description`: a human-readable description of the group; this is
displayed on the landing page for public groups; displayed on the landing page for public groups;