summaryrefslogtreecommitdiff
path: root/README.md
blob: 9717b0db4d0fd36abb77fa59ace7aee5c5f67113 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# keks-meet

A simple webrtc powered conference application

## Parameters

For configuration just add a set of the following options as query parameters to the URL (e.g. `/room/asdfg?username=bob`).

Booleans can be either `1`, `true`, `yes` or their opposites.

| Option name     | Type    | Description                            |
| --------------- | ------- | -------------------------------------- |
| `username`      | string  | Sets the username                      |
| `rnnoise`       | boolean | Enables noise suppression with rnnoise |
| `audio_enabled` | boolean | Enables audio transmission by default  |
| `video_enabled` | boolean | Enables video transmission by default  |

## Licence

See `LICENCE` file.