element-call/README.md
2022-11-07 12:50:59 -05:00

2.7 KiB

Element Call

Chat Translate

Full mesh group calls powered by Matrix, implementing MatrixRTC.

To try it out, visit our hosted version at call.element.io. You can also find the latest development version continuously deployed to element-call.netlify.app.

Host it yourself

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 matrix-js-sdk. To get started, clone, install, and link the package:

git clone https://github.com/matrix-org/matrix-js-sdk.git
cd matrix-js-sdk
yarn
yarn link

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

By default, the app expects you to have Synapse installed locally and running on port 8008. If you wish to use another homeserver, you can set it in your .env file.

You're now ready to launch the development server:

yarn dev

Config

Configuration options are documented in the .env file.

Translation

If you'd like to help translate Element Call, head over to translate.element.io. You're also encouraged to join the Element Translators space to discuss and coordinate translation efforts.