mirror of
https://github.com/jech/galene.git
synced 2024-11-10 02:35:58 +01:00
The Galène videoconference server
1fe64e15f0
It's not obvious that it's useful, especially now that the writer is split into multiple threads. Do retain the dynamically computed delay in case of audio congestion. |
||
---|---|---|
data | ||
estimator | ||
jitter | ||
packetcache | ||
rtptime | ||
static | ||
.gitignore | ||
client.go | ||
conn.go | ||
disk.go | ||
go.mod | ||
go.sum | ||
group.go | ||
README | ||
README.FRONTEND | ||
rtpconn.go | ||
rtpwriter.go | ||
sfu.go | ||
webclient.go | ||
webserver.go |
# Installation Build the server binary: CGO_ENABLED=0 go build -ldflags='-s -w' Create a server certificate: mkdir data openssl req -newkey rsa:2048 -nodes -keyout data/key.pem -x509 -days 365 -out data/cert.pem Set the server administrator's username and password (optional): echo 'god:topsecret' > data/passwd Configure the list of STUN and TURN servers (optional): vi data/ice-servers.json Set up a group mkdir groups vi groups/public.json { "public":true, "op":[{"username":"jch","password":"1234"}], "presenter":[{}], "max-users":100 } Copy the necessary files to your server: rsync -a sfu static data groups server.example.org:/home/sfu/ Run the server binary: ssh server.example.org cd /home/sfu/ nohup ./sfu & # Locations There is a landing page at the root of the server. It contains a form for typing the name of a group, and a clickable list of public groups. 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. Some statistics are available under `/stats`. This is only available to the server administrator. # Group definitions Groups are defined by files in the directory defined by the `-groups` command-line option, one per group. The group definition file does not contain the name of the group -- that makes it possible to set up a new group just by copying a template file. The group definition file contains a JSON directory with the following fields, all of which are optional. - `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; - `max-clients`: the maximum number of clients that may join the group at a time; - `allow-recording`: if true, then recording is allowed in this group; - `allow-anonymous`: if true, then users may connect with an empty username; this is not recommended, since anonymous users are not allowed to participate in the chat; - `redirect`: if set, then attempts to join the group will be redirected to the given URL; most other fields are ignored in this case. A user definition is a dictionary with the following fields: - `username`: the username of the user; if omitted, any username is allowed; - `password`: the password of the user; if omitted, then any password (including the empty paassword) is allowed. For example {"username":"jch", "password":"topsecret"} specifies user *jch* with password *topsecret*, while {"password":"topsecret"} specifies that any username will do. The empty dictionary {} specifies that any username will do and that password are not verified. # Commands Typing a line starting with a slash `/` in the chat dialogue causes a command to be sent to the server. The following commands are available to all users: - `/me text`: sends a chat message starting with the sender's username; - `/leave`: equivalent to clicking the *Disconnect* button. The following commands are only available to users with operator privileges: - `/clear`: clears the chat history for all users; - `/lock`: prevents any new users from connecting to the group unless they have operator privileges; - `/unlock`: reverts the effect of `/lock`; - `/record`: start recording; - `/unrecord`: stop recording; - `/op user`: gives operator privileges to a user; - `/unop user`: takes away operator privileges; - `/present user`: gives presenter privileges to a user; - `/unpresent user`: takes away presenter privileges from a user and forcibly closes any presentations from that user that may be taking place; - `/kick user`: forcibly disconnects a user from the group. --- Juliusz Chroboczek <https://www.irif.fr/~jch/>