element-web/docs/jitsi.md

73 lines
3.3 KiB
Markdown
Raw Normal View History

2020-07-17 13:19:19 +02:00
# Jitsi in Element
2020-07-17 13:19:19 +02:00
Element uses [Jitsi](https://jitsi.org/) for conference calls, which provides options for
self-hosting your own server and supports most major platforms.
1:1 calls, or calls between you and one other person, do not use Jitsi. Instead, those
calls work directly between clients or via TURN servers configured on the respective
2020-04-06 22:50:06 +02:00
homeservers.
There's a number of ways to start a Jitsi call: the easiest way is to click on the
voice or video buttons near the message composer in a room with more than 2 people. This
will add a Jitsi widget which allows anyone in the room to join.
Integration managers (available through the 4 squares in the top right of the room) may
2020-04-06 22:50:06 +02:00
provide their own approaches for adding Jitsi widgets.
2020-07-17 13:19:19 +02:00
## Configuring Element to use your self-hosted Jitsi server
You can host your own Jitsi server to use with Element. It's usually advisable to use a recent
version of Jitsi. In particular, versions older than around 6826 will cause problems with
Element 1.9.10 or newer.
2020-07-17 13:19:19 +02:00
Element will use the Jitsi server that is embedded in the widget, even if it is not the
one you configured. This is because conference calls must be held on a single Jitsi
server and cannot be split over multiple servers.
2022-12-09 13:28:29 +01:00
However, you can configure Element to _start_ a conference with your Jitsi server by adding
to your [config](./config.md) the following:
2022-12-09 13:28:29 +01:00
```json
{
2022-12-09 13:28:29 +01:00
"jitsi": {
"preferred_domain": "your.jitsi.example.org"
2022-12-09 13:28:29 +01:00
}
}
```
Element's default is `meet.element.io` (a free service offered by Element). `meet.jit.si`
is an instance hosted by Jitsi themselves and is also free to use.
2020-07-17 13:19:19 +02:00
Once you've applied the config change, refresh Element and press the call button. This
should start a new conference on your Jitsi server.
2020-07-17 13:19:19 +02:00
**Note**: The widget URL will point to a `jitsi.html` page hosted by Element. The Jitsi
domain will appear later in the URL as a configuration parameter.
**Hint**: If you want everyone on your homeserver to use the same Jitsi server by
default, and you are using element-web 1.6 or newer, set the following on your homeserver's
`/.well-known/matrix/client` config:
2022-12-09 13:28:29 +01:00
```json
{
2022-12-09 13:28:29 +01:00
"im.vector.riot.jitsi": {
"preferredDomain": "your.jitsi.example.org"
}
}
```
## Element Android
2020-08-19 19:18:50 +02:00
Element Android (1.0.5+) supports custom Jitsi domains, similar to Element Web above.
1:1 calls, or calls between you and one other person, do not use Jitsi. Instead, those
calls work directly between clients or via TURN servers configured on the respective
homeservers.
For rooms with more than 2 joined members, when creating a Jitsi conference via call/video buttons of the toolbar (not via integration manager), Element Android will create a widget using the [wrapper](https://github.com/element-hq/element-web/blob/develop/docs/jitsi-dev.md) hosted on `app.element.io`.
The domain used is the one specified by the `/.well-known/matrix/client` endpoint, and if not present it uses the fallback defined in `config.json` (meet.element.io)
2020-08-19 19:18:50 +02:00
For active Jitsi widgets in the room, a native Jitsi widget UI is created and points to the instance specified in the `domain` key of the widget content data.
2020-08-19 19:18:50 +02:00
Element Android manages allowed native widgets permissions a bit differently than web widgets (as the data shared are different and never shared with the widget URL). For Jitsi widgets, permissions are requested only once per domain (consent saved in account data).