prettier
This commit is contained in:
21
README.md
21
README.md
@@ -9,7 +9,6 @@
|
|||||||
The world's first 🌐 decentralized and 🤝 federated video conferencing solution
|
The world's first 🌐 decentralized and 🤝 federated video conferencing solution
|
||||||
powered by **the Matrix protocol**.
|
powered by **the Matrix protocol**.
|
||||||
|
|
||||||
|
|
||||||
## 📌 Overview
|
## 📌 Overview
|
||||||
|
|
||||||
**Element Call** is a native Matrix video conferencing application developed by
|
**Element Call** is a native Matrix video conferencing application developed by
|
||||||
@@ -28,9 +27,8 @@ You can find the latest development version continuously deployed to
|
|||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> For prior version of the Element Call that relied solely on full-mesh logic,
|
> 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)
|
> check [`full-mesh`](https://github.com/element-hq/element-call/tree/full-mesh)
|
||||||
branch.
|
> branch.
|
||||||
|
|
||||||
|
|
||||||
## ✨ Key Features
|
## ✨ Key Features
|
||||||
|
|
||||||
@@ -47,7 +45,6 @@ organize the flow of the meeting.
|
|||||||
✅ **Emoji Reactions** – Users can react with emojis 👍️ 🎉 👏 🤘, adding
|
✅ **Emoji Reactions** – Users can react with emojis 👍️ 🎉 👏 🤘, adding
|
||||||
engagement and interactivity to the conversation.
|
engagement and interactivity to the conversation.
|
||||||
|
|
||||||
|
|
||||||
## 🚀 Deployment Options
|
## 🚀 Deployment Options
|
||||||
|
|
||||||
Element Call can be packaged in two ways:
|
Element Call can be packaged in two ways:
|
||||||
@@ -67,7 +64,6 @@ In Standalone mode Element Call operates as an independent, full-featured video
|
|||||||
conferencing web application, allowing users to join or host calls without
|
conferencing web application, allowing users to join or host calls without
|
||||||
requiring a separate Matrix client.
|
requiring a separate Matrix client.
|
||||||
|
|
||||||
|
|
||||||
### Widget mode embedded in Messenger Apps
|
### Widget mode embedded in Messenger Apps
|
||||||
|
|
||||||

|

|
||||||
@@ -82,13 +78,11 @@ and voice calls within Matrix rooms.
|
|||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
> Embedded packaging is recommended for Element Call in widget mode!
|
> Embedded packaging is recommended for Element Call in widget mode!
|
||||||
|
|
||||||
|
|
||||||
## 🛠️ Self-Hosting
|
## 🛠️ Self-Hosting
|
||||||
|
|
||||||
For operating and deploying Element Call on your own server, refer to the
|
For operating and deploying Element Call on your own server, refer to the
|
||||||
[**Self-Hosting Guide**](./docs/self-hosting.md).
|
[**Self-Hosting Guide**](./docs/self-hosting.md).
|
||||||
|
|
||||||
|
|
||||||
## 🧭 MatrixRTC Backend Discovery and Selection
|
## 🧭 MatrixRTC Backend Discovery and Selection
|
||||||
|
|
||||||
For proper Element Call operation each site deployment needs a MatrixRTC backend
|
For proper Element Call operation each site deployment needs a MatrixRTC backend
|
||||||
@@ -103,6 +97,7 @@ MatrixRTC backend (according to
|
|||||||
[MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143))
|
[MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143))
|
||||||
is announced by the homeserver's `.well-known/matrix/client` file and discovered
|
is announced by the homeserver's `.well-known/matrix/client` file and discovered
|
||||||
via the `org.matrix.msc4143.rtc_foci` key, e.g.:
|
via the `org.matrix.msc4143.rtc_foci` key, e.g.:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
"org.matrix.msc4143.rtc_foci": [
|
"org.matrix.msc4143.rtc_foci": [
|
||||||
{
|
{
|
||||||
@@ -111,6 +106,7 @@ via the `org.matrix.msc4143.rtc_foci` key, e.g.:
|
|||||||
},
|
},
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
where the format for MatrixRTC using LiveKit backend is defined in
|
where the format for MatrixRTC using LiveKit backend is defined in
|
||||||
[MSC4195](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
|
[MSC4195](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
|
||||||
In the example above Matrix clients do discover a focus of type `livekit` which
|
In the example above Matrix clients do discover a focus of type `livekit` which
|
||||||
@@ -135,7 +131,6 @@ selection for **Matrix rooms 123 and 456**, which include users from different
|
|||||||
homeservers.
|
homeservers.
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## 🌍 Translation
|
## 🌍 Translation
|
||||||
|
|
||||||
If you'd like to help translate Element Call, head over to
|
If you'd like to help translate Element Call, head over to
|
||||||
@@ -143,7 +138,6 @@ If you'd like to help translate Element Call, head over to
|
|||||||
the [Element Translators](https://matrix.to/#/#translators:element.io) space to
|
the [Element Translators](https://matrix.to/#/#translators:element.io) space to
|
||||||
discuss and coordinate translation efforts.
|
discuss and coordinate translation efforts.
|
||||||
|
|
||||||
|
|
||||||
## 🛠️ Development
|
## 🛠️ Development
|
||||||
|
|
||||||
### Frontend
|
### Frontend
|
||||||
@@ -163,8 +157,8 @@ environment as outlined in the next section out of box.
|
|||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> Be aware, that this `config.devenv.json` is exposing a deprecated fallback
|
> Be aware, that this `config.devenv.json` is exposing a deprecated fallback
|
||||||
LiveKit config key. If the homeserver advertises SFU backend via
|
> LiveKit config key. If the homeserver advertises SFU backend via
|
||||||
`.well-known/matrix/client` this has precedence.
|
> `.well-known/matrix/client` this has precedence.
|
||||||
|
|
||||||
You're now ready to launch the development server:
|
You're now ready to launch the development server:
|
||||||
|
|
||||||
@@ -199,7 +193,6 @@ yarn backend
|
|||||||
|
|
||||||
<img src="https://codecov.io/github/element-hq/element-call/graphs/tree.svg?token=O6CFVKK6I1"></img>
|
<img src="https://codecov.io/github/element-hq/element-call/graphs/tree.svg?token=O6CFVKK6I1"></img>
|
||||||
|
|
||||||
|
|
||||||
### Add a new translation key
|
### Add a new translation key
|
||||||
|
|
||||||
To add a new translation key you can do these steps:
|
To add a new translation key you can do these steps:
|
||||||
@@ -228,14 +221,12 @@ To add a new translation key you can do these steps:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## 📖 Documentation
|
## 📖 Documentation
|
||||||
|
|
||||||
Usage and other technical details about the project can be found here:
|
Usage and other technical details about the project can be found here:
|
||||||
|
|
||||||
[**Docs**](./docs/README.md)
|
[**Docs**](./docs/README.md)
|
||||||
|
|
||||||
|
|
||||||
## 📝 Copyright & License
|
## 📝 Copyright & License
|
||||||
|
|
||||||
Copyright 2021-2025 New Vector Ltd
|
Copyright 2021-2025 New Vector Ltd
|
||||||
|
|||||||
@@ -12,8 +12,7 @@
|
|||||||
The following [MSCs](https://github.com/matrix-org/matrix-spec-proposals) are
|
The following [MSCs](https://github.com/matrix-org/matrix-spec-proposals) are
|
||||||
required for Element Call to work properly:
|
required for Element Call to work properly:
|
||||||
|
|
||||||
-
|
- **[MSC3266](https://github.com/deepbluev7/matrix-doc/blob/room-summaries/proposals/3266-room-summary.md):
|
||||||
**[MSC3266](https://github.com/deepbluev7/matrix-doc/blob/room-summaries/proposals/3266-room-summary.md):
|
|
||||||
Room Summary API**: In Standalone mode Element Call is able to join rooms
|
Room Summary API**: In Standalone mode Element Call is able to join rooms
|
||||||
over federation using knocking. In this context MSC3266 is required as it
|
over federation using knocking. In this context MSC3266 is required as it
|
||||||
allows to request a room summary of rooms you are not joined. The summary
|
allows to request a room summary of rooms you are not joined. The summary
|
||||||
@@ -21,19 +20,16 @@ required for Element Call to work properly:
|
|||||||
gets prompted with the option to knock ("Request to join call"), a "cannot
|
gets prompted with the option to knock ("Request to join call"), a "cannot
|
||||||
join error" or "the join view".
|
join error" or "the join view".
|
||||||
|
|
||||||
-
|
- **[MSC4140](https://github.com/matrix-org/matrix-spec-proposals/blob/toger5/expiring-events-keep-alive/proposals/4140-delayed-events-futures.md)
|
||||||
**[MSC4140](https://github.com/matrix-org/matrix-spec-proposals/blob/toger5/expiring-events-keep-alive/proposals/4140-delayed-events-futures.md)
|
|
||||||
Delayed Events**: Delayed events are required for proper call participation
|
Delayed Events**: Delayed events are required for proper call participation
|
||||||
signalling. If disabled it is very likely that you end up with stuck calls in
|
signalling. If disabled it is very likely that you end up with stuck calls in
|
||||||
Matrix rooms.
|
Matrix rooms.
|
||||||
|
|
||||||
-
|
- **[MSC4222](https://github.com/matrix-org/matrix-spec-proposals/blob/erikj/sync_v2_state_after/proposals/4222-sync-v2-state-after.md)
|
||||||
**[MSC4222](https://github.com/matrix-org/matrix-spec-proposals/blob/erikj/sync_v2_state_after/proposals/4222-sync-v2-state-after.md)
|
|
||||||
Adding `state_after` to sync v2**: Allow clients to opt-in to a change of the
|
Adding `state_after` to sync v2**: Allow clients to opt-in to a change of the
|
||||||
sync v2 API that allows them to correctly track the state of the room. This is
|
sync v2 API that allows them to correctly track the state of the room. This is
|
||||||
required by Element Call to track room state reliably.
|
required by Element Call to track room state reliably.
|
||||||
|
|
||||||
|
|
||||||
If you're using [Synapse](https://github.com/element-hq/synapse/) as your homeserver, you'll need
|
If you're using [Synapse](https://github.com/element-hq/synapse/) as your homeserver, you'll need
|
||||||
to additionally add the following config items to `homeserver.yaml` to comply with Element Call:
|
to additionally add the following config items to `homeserver.yaml` to comply with Element Call:
|
||||||
|
|
||||||
@@ -74,6 +70,7 @@ to implement
|
|||||||
> [MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143)
|
> [MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143)
|
||||||
> MatrixRTC backend must be announced to the client via your **homeserver's
|
> MatrixRTC backend must be announced to the client via your **homeserver's
|
||||||
> `.well-known/matrix/client`**. The configuration is a list of Foci configs:
|
> `.well-known/matrix/client`**. The configuration is a list of Foci configs:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
"org.matrix.msc4143.rtc_foci": [
|
"org.matrix.msc4143.rtc_foci": [
|
||||||
{
|
{
|
||||||
@@ -91,7 +88,6 @@ to implement
|
|||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Building Element Call
|
## Building Element Call
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
@@ -136,7 +132,6 @@ server {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
There are currently two different config files. `.env` holds variables that are
|
There are currently two different config files. `.env` holds variables that are
|
||||||
@@ -149,7 +144,6 @@ in [ConfigOptions.ts](src/config/ConfigOptions.ts).
|
|||||||
> Element Call is only available for developing and debug purposes. Relying on
|
> Element Call is only available for developing and debug purposes. Relying on
|
||||||
> it might break Element Call going forward!
|
> it might break Element Call going forward!
|
||||||
|
|
||||||
|
|
||||||
## A Note on Standalone Mode of Element Call
|
## A Note on Standalone Mode of Element Call
|
||||||
|
|
||||||
Element Call in Standalone mode requires a homeserver with registration enabled
|
Element Call in Standalone mode requires a homeserver with registration enabled
|
||||||
|
|||||||
Reference in New Issue
Block a user