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
Copy file name to clipboardExpand all lines: README.md
+33-16Lines changed: 33 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ You may also wish to add a configuration file (Element Call uses the domain it's
28
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:
29
29
30
30
```
31
-
cp config/config.sample.json public/config.json
31
+
cp config/config.devenv.json public/config.json
32
32
# edit public/config.json
33
33
```
34
34
@@ -58,14 +58,24 @@ If you're using [Synapse](https://github.com/element-hq/synapse/), you'll need t
58
58
59
59
```
60
60
experimental_features:
61
+
# MSC3266: Room summary API. Used for knocking over federation
61
62
msc3266_enabled: true
63
+
64
+
# The maximum allowed duration by which sent events can be delayed, as
65
+
# per MSC4140.
66
+
max_event_delay_duration: 24h
67
+
68
+
rc_message:
69
+
# This needs to match at least the heart-beat frequency plus a bit of headroom
70
+
# Currently the heart-beat is every 5 seconds which translates into a rate of 0.2s
71
+
per_second: 0.5
72
+
burst_count: 30
62
73
```
63
74
64
75
MSC3266 allows to request a room summary of rooms you are not joined.
65
76
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.
66
77
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.
78
+
Element Call requires a Livekit SFU behind a [Livekit JWT service](https://github.com/element-hq/lk-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/matrix/client`. This is the recommended method.
69
79
70
80
The configuration is a list of Foci configs:
71
81
@@ -112,6 +122,14 @@ yarn
112
122
yarn link matrix-js-sdk
113
123
```
114
124
125
+
To use it, create a local config by, e.g., `cp ./config/config.sample.json
126
+
./public/config.json` and adapt it if necessary. The sample config should work
127
+
with the backend development environment as outlined in the next section out of
128
+
box.
129
+
130
+
(Be aware, that this is only the fallback Livekit SFU. If the homeserver
131
+
advertises one in the client well-known, this will not be used.)
132
+
115
133
You're now ready to launch the development server:
116
134
117
135
```
@@ -120,25 +138,24 @@ yarn dev
120
138
121
139
### Backend
122
140
123
-
A docker compose file is provided to start a LiveKit server and auth
124
-
service for development. These use a test 'secret' published in this
125
-
repository, so this must be used only for local development and
126
-
**_never be exposed to the public Internet._**
141
+
A docker compose file `dev-backend-docker-compose.yml` is provided to start the
142
+
whole stack of components which is required for a local development environment:
0 commit comments