You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Group calls with WebRTC that leverage [Matrix](https://matrix.org) and an open-source WebRTC toolkit from [LiveKit](https://livekit.io/).
6
+
Group calls with WebRTC that leverage [Matrix](https://matrix.org) and an
7
+
open-source WebRTC toolkit from [LiveKit](https://livekit.io/).
7
8
8
-
For prior version of the Element Call that relied solely on full-mesh logic, check [`full-mesh`](https://github.com/element-hq/element-call/tree/full-mesh) branch.
9
+
For prior version of the Element Call that relied solely on full-mesh logic,
11
14
12
-
To try it out, visit our hosted version at [call.element.io](https://call.element.io). You can also find the latest development version continuously deployed to [call.element.dev](https://call.element.dev/).
15
+
To try it out, visit our hosted version at
16
+
[call.element.io](https://call.element.io). You can also find the latest
17
+
development version continuously deployed to
18
+
[call.element.dev](https://call.element.dev/).
13
19
14
20
## Host it yourself
15
21
16
-
Until prebuilt tarballs are available, you'll need to build Element Call from source. First, clone and install the package:
22
+
Until prebuilt tarballs are available, you'll need to build Element Call from
If all went well, you can now find the build output under `dist` as a series of static files. These can be hosted using any web server that can be configured with custom routes (see below).
32
+
If all went well, you can now find the build output under `dist` as a series of
33
+
static files. These can be hosted using any web server that can be configured
34
+
with custom routes (see below).
26
35
27
-
You may also wish to add a configuration file (Element Call uses the domain it's hosted on as a Homeserver URL by default,
28
-
but you can change this in the config file). This goes in `public/config.json` - you can use the sample as a starting point:
36
+
You may also wish to add a configuration file (Element Call uses the domain it's
37
+
hosted on as a Homeserver URL by default, but you can change this in the config
38
+
file). This goes in `public/config.json` - you can use the sample as a starting
39
+
point:
29
40
30
41
```
31
42
cp config/config.sample.json public/config.json
32
43
# edit public/config.json
33
44
```
34
45
35
-
Because Element Call uses client-side routing, your server must be able to route any requests to non-existing paths back to `/index.html`. For example, in Nginx you can achieve this with the `try_files` directive:
46
+
Because Element Call uses client-side routing, your server must be able to route
47
+
any requests to non-existing paths back to `/index.html`. For example, in Nginx
48
+
you can achieve this with the `try_files` directive:
36
49
37
50
```
38
51
server {
@@ -44,28 +57,63 @@ server {
44
57
}
45
58
```
46
59
47
-
By default, the app expects you to have a Matrix homeserver (such as [Synapse](https://element-hq.github.io/synapse/latest/setup/installation.html)) installed locally and running on port 8008. If you wish to use a homeserver on a different URL or one that is hosted on a different server, you can add a config file as above, and include the homeserver URL that you'd like to use.
60
+
By default, the app expects you to have a Matrix homeserver (such as
installed locally and running on port 8008. If you wish to use a homeserver on a
63
+
different URL or one that is hosted on a different server, you can add a config
64
+
file as above, and include the homeserver URL that you'd like to use.
48
65
49
-
Element Call requires a homeserver with registration enabled without any 3pid or token requirements, if you want it to be used by unregistered users. Furthermore, it is not recommended to use it with an existing homeserver where user accounts have joined normal rooms, as it may not be able to handle those yet and it may behave unreliably.
66
+
Element Call requires a homeserver with registration enabled without any 3pid or
67
+
token requirements, if you want it to be used by unregistered users.
68
+
Furthermore, it is not recommended to use it with an existing homeserver where
69
+
user accounts have joined normal rooms, as it may not be able to handle those
70
+
yet and it may behave unreliably.
50
71
51
-
Therefore, to use a self-hosted homeserver, this is recommended to be a new server where any user account created has not joined any normal rooms anywhere in the Matrix federated network. The homeserver used can be setup to disable federation, so as to prevent spam registrations (if you keep registrations open) and to ensure Element Call continues to work in case any user decides to log in to their Element Call account using the standard Element app and joins normal rooms that Element Call cannot handle.
72
+
Therefore, to use a self-hosted homeserver, this is recommended to be a new
73
+
server where any user account created has not joined any normal rooms anywhere
74
+
in the Matrix federated network. The homeserver used can be setup to disable
75
+
federation, so as to prevent spam registrations (if you keep registrations open)
76
+
and to ensure Element Call continues to work in case any user decides to log in
77
+
to their Element Call account using the standard Element app and joins normal
78
+
rooms that Element Call cannot handle.
52
79
53
80
## Configuration
54
81
55
-
There are currently two different config files. `.env` holds variables that are used at build time, while `public/config.json` holds variables that are used at runtime. Documentation and default values for `public/config.json` can be found in [ConfigOptions.ts](src/config/ConfigOptions.ts).
82
+
There are currently two different config files. `.env` holds variables that are
83
+
used at build time, while `public/config.json` holds variables that are used at
84
+
runtime. Documentation and default values for `public/config.json` can be found
85
+
in [ConfigOptions.ts](src/config/ConfigOptions.ts).
56
86
57
-
If you're using [Synapse](https://github.com/element-hq/synapse/), you'll need to additionally add the following to `homeserver.yaml` or Element Call won't work:
87
+
If you're using [Synapse](https://github.com/element-hq/synapse/), you'll need
88
+
to additionally add the following to `homeserver.yaml` or Element Call won't
89
+
work:
58
90
59
91
```
60
92
experimental_features:
93
+
# MSC3266: Room summary API. Used for knocking over federation
61
94
msc3266_enabled: true
95
+
96
+
# The maximum allowed duration by which sent events can be delayed, as
97
+
# per MSC4140.
98
+
max_event_delay_duration: 24h
99
+
100
+
rc_message:
101
+
# This needs to match at least the heart-beat frequency plus a bit of headroom
102
+
# Currently the heart-beat is every 5 seconds which translates into a rate of 0.2s
103
+
per_second: 0.5
104
+
burst_count: 30
62
105
```
63
106
64
-
MSC3266 allows to request a room summary of rooms you are not joined.
65
-
The summary contains the room join rules. We need that to decide if the user gets prompted with the option to knock ("ask to join"), a cannot join error or the join view.
107
+
MSC3266 allows to request a room summary of rooms you are not joined. The
108
+
summary contains the room join rules. We need that to decide if the user gets
109
+
prompted with the option to knock ("ask to join"), a cannot join error or the
110
+
join view.
66
111
67
-
Element Call requires a Livekit SFU behind a Livekit jwt service to work. The url to the Livekit jwt service can either be configured in the config of Element Call (fallback/legacy configuration) or be configured by your homeserver via the `.well-known`.
68
-
This is the recommended method.
112
+
Element Call requires a Livekit SFU alongside a [Livekit JWT
113
+
service](https://github.com/element-hq/lk-jwt-service) to work. The url to the
114
+
Livekit JWT service can either be configured in the config of Element Call
115
+
(fallback/legacy configuration) or be configured by your homeserver via the
116
+
`.well-known/matrix/client`. This is the recommended method.
69
117
70
118
The configuration is a list of Foci configs:
71
119
@@ -88,13 +136,18 @@ The configuration is a list of Foci configs:
88
136
89
137
## Translation
90
138
91
-
If you'd like to help translate Element Call, head over to [Localazy](https://localazy.com/p/element-call). You're also encouraged to join the [Element Translators](https://matrix.to/#/#translators:element.io) space to discuss and coordinate translation efforts.
139
+
If you'd like to help translate Element Call, head over to
140
+
[Localazy](https://localazy.com/p/element-call). You're also encouraged to join
141
+
the [Element Translators](https://matrix.to/#/#translators:element.io) space to
142
+
discuss and coordinate translation efforts.
92
143
93
144
## Development
94
145
95
146
### Frontend
96
147
97
-
Element Call is built against [matrix-js-sdk](https://github.com/matrix-org/matrix-js-sdk/pull/2553). To get started, clone, install, and link the package:
148
+
Element Call is built against
149
+
[matrix-js-sdk](https://github.com/matrix-org/matrix-js-sdk/pull/2553). To get
- Minimum LiveKit SFU Setup using dev defaults for config
193
+
- Redis db for completness
131
194
132
-
```json
133
-
"livekit": {
134
-
"livekit_service_url": "http://localhost:7881"
135
-
},
136
-
```
195
+
These use a test 'secret' published in this repository, so this must be used
196
+
only for local development and **_never be exposed to the public Internet._**
137
197
138
198
Run backend components:
139
199
140
200
```
141
201
yarn backend
202
+
# or for podman-compose
203
+
# podman-compose -f dev-backend-docker-compose.yml up
142
204
```
143
205
144
206
### Test Coverage
@@ -150,22 +212,25 @@ yarn backend
150
212
To add a new translation key you can do these steps:
151
213
152
214
1. Add the new key entry to the code where the new key is used: `t("some_new_key")`
153
-
1. Run `yarn i18n` to extract the new key and update the translation files. This will add a skeleton entry to the `public/locales/en-GB/app.json` file:
215
+
1. Run `yarn i18n` to extract the new key and update the translation files. This
216
+
will add a skeleton entry to the `public/locales/en-GB/app.json` file:
154
217
```jsonc
155
218
{
156
219
...
157
220
"some_new_key":"",
158
221
...
159
222
}
160
223
```
161
-
1. Update the skeleton entry in the `public/locales/en-GB/app.json` file with the English translation:
162
-
```jsonc
224
+
1. Update the skeleton entry in the `public/locales/en-GB/app.json` file with
0 commit comments