-
Notifications
You must be signed in to change notification settings - Fork 128
Improve the README #696
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Improve the README #696
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,79 @@ | ||
| # Element Call | ||
|
|
||
| Showcase for full mesh video chat powered by Matrix, implementing [MSC3401](https://github.com/matrix-org/matrix-spec-proposals/blob/matthew/group-voip/proposals/3401-group-voip.md). | ||
| [](https://matrix.to/#/#webrtc:matrix.org) | ||
| [](https://translate.element.io/engage/element-call/) | ||
|
|
||
| Discussion in [#webrtc:matrix.org: ](https://matrix.to/#/#webrtc:matrix.org) | ||
| Full mesh group calls powered by [Matrix](https://matrix.org), implementing [MatrixRTC](https://github.com/matrix-org/matrix-spec-proposals/blob/matthew/group-voip/proposals/3401-group-voip.md). | ||
|
|
||
| ## Getting Started | ||
| 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 [element-call.netlify.app](https://element-call.netlify.app). | ||
|
|
||
| `element-call` is built against the `robertlong/group-call` branch of [matrix-js-sdk](https://github.com/matrix-org/matrix-js-sdk/pull/1902). Because of how this package is configured and Vite's requirements, you will need to clone it locally and use `yarn link` to stich things together. | ||
| ## Host it yourself | ||
|
|
||
| First clone, install, and link `matrix-js-sdk` | ||
| Until prebuilt tarballs are available, you'll need to build Element Call from source. First, clone and install the package: | ||
|
|
||
| ``` | ||
| git clone https://github.com/vector-im/element-call.git | ||
| cd element-call | ||
| yarn | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| You can now edit the configuration in `.env` to your liking. The most important thing is to set `VITE_DEFAULT_HOMESERVER` to the homeserver that the app should use, such as `https://call.ems.host`. | ||
|
|
||
| Next, build the project: | ||
|
|
||
| ``` | ||
| yarn build | ||
| ``` | ||
|
|
||
| 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 of your choice. | ||
|
|
||
| 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: | ||
|
|
||
| ``` | ||
| server { | ||
| ... | ||
| location / { | ||
| ... | ||
| try_files $uri /$uri /index.html; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| Element Call is built against the `robertlong/group-call` branch of [matrix-js-sdk](https://github.com/matrix-org/matrix-js-sdk/pull/2553). To get started, clone, install, and link the package: | ||
|
|
||
| ``` | ||
| git clone https://github.com/matrix-org/matrix-js-sdk.git | ||
| cd matrix-js-sdk | ||
| git checkout robertlong/group-call | ||
| git switch robertlong/group-call | ||
| yarn | ||
| yarn link | ||
| ``` | ||
|
|
||
| Next you'll also need [Synapse](https://matrix-org.github.io/synapse/latest/setup/installation.html) installed locally and running on port 8008. | ||
|
|
||
| Finally we can set up this project. | ||
| Next, we can set up this project: | ||
|
|
||
| ``` | ||
| git clone https://github.com/vector-im/element-call.git | ||
| cd element-call | ||
| yarn | ||
| yarn link matrix-js-sdk | ||
| cp .env.example .env | ||
| yarn dev | ||
| ``` | ||
|
|
||
| ## Config | ||
|
|
||
| Configuration options are documented in the `.env` file. | ||
| By default, the app expects you to have [Synapse](https://matrix-org.github.io/synapse/latest/setup/installation.html) installed locally and running on port 8008. If you wish to use another homeserver, you can set it in your `.env` file. | ||
|
|
||
| ## License | ||
| You're now ready to launch the development server: | ||
|
|
||
| All files in this project are: | ||
| ``` | ||
| yarn dev | ||
| ``` | ||
|
|
||
| Copyright 2021-2022 New Vector Ltd | ||
| ## Config | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| Configuration options are documented in the `.env` file. | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| ## Translation | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| If you'd like to help translate Element Call, head over to [translate.element.io](https://translate.element.io/engage/element-call/). You're also encouraged to join the [Element Translators](https://matrix.to/#/#translators:element.io) space to discuss and coordinate translation efforts. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the MSC now being split into multiple we should probably figure out something bettter
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, perhaps we should link to the other proposals from matrix-org/matrix-spec-proposals#3401? And then in the long term we could link to the actual spec here