Configuration file - YunoHost-Apps/galene_ynh GitHub Wiki

groupname.json

{
	"op": [{"username": "admin", "password": "1234"}],
	"presenter": [
		{"username": "mom", "password": "0000"},
		{"username": "dad", "password": "1111"}
	],
        "other": [{}],
	"contact": "[email protected]",
 	"comment": "Public Conference",
 	"description": "a human-readable description of the group; this is displayed on the landing page for public groups.",
 	"autolock": true,
        "autokick": false,
	"public": true,
	"max-clients": 20,
        "max-history-age": 14400,
	"allow-recording": true,
	"allow-anonymous": true,
	"allow-subgroups": true,
	"redirect": "",
	"codecs": ["vp8", "opus"]
}

Every group definition file contains a JSON directory with the following fields. 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.

  • op, presenter, other: each of these is an array of user definitions (see below) and specifies the users allowed to connect respectively with operator privileges, with presenter privileges, and as passive listeners;
  • public: if true, then the group is visible on the landing page;
  • description: a human-readable description of the group; this is displayed on the landing page for public groups;
  • contact: a human-readable contact for this group, such as an e-mail address;
  • comment: a human-readable string;
  • max-clients: the maximum number of clients that may join the group at a time;
  • max-history-age: the time, in seconds, during which chat history is kept (default 14400, i.e. 4 hours);
  • allow-recording: if true, then recording is allowed in this group;
  • allow-anonymous: if true, then users may connect with an empty username;
  • allow-subgroups: if true, then subgroups of the form group/subgroup are automatically created when first accessed;
  • autolock: if true, the group will start locked and become locked whenever there are no clients with operator privileges;
  • autokick: if true, all clients will be kicked out whenever there are no clients with operator privileges; this is not recommended, prefer the autolock option instead;
  • redirect: if set, then attempts to join the group will be redirected to the given URL; most other fields are ignored in this case;
  • codecs: this is a list of codecs allowed in this group. The default is ["vp8", "opus"].

Supported video codecs include:

  • "vp8" (compatible with all supported browsers);
  • "vp9" (better video quality, but incompatible with Safari);
  • "av1" (even better video quality, only supported by some browsers, recording is not supported, SVC is not supported);
  • "h264" (incompatible with Debian and with some Android devices, SVC is not supported).

Supported audio codecs include "opus", "g722", "pcmu" and "pcma". Only Opus can be recorded to disk. There is no good reason to use anything except Opus.

TURN server test

To check if the TURN server is up and running, type /relay-test in the chat box; if the TURN server is properly configured, you should see a message saying that the relay test has been successful.

How do I record my lecture?

Make sure allow-recording is set in your group configuration. Log-in as an operator, then say /record before you start your lecture. Don't forget to say /unrecord at the end. You will find your recordings under https://server.example.com/recordings/groupname/.