mirror of github.com/vector-im/element-call with some private sauce
Find a file
2022-12-20 17:30:47 +00:00
.github Apply Prettier to the entire project 2022-12-09 14:34:25 -05:00
.storybook Remove dependency on matrix-react-sdk 2022-04-07 14:22:36 -07:00
.vscode Apply Prettier to the entire project 2022-12-09 14:34:25 -05:00
config Add config file for CD version 2022-11-03 19:01:13 +00:00
public i18n 2022-12-16 17:22:38 +00:00
scripts Don't check out group-call branch in build script 2022-11-07 17:37:40 +00:00
src Don't touch the product name option for now 2022-12-20 17:30:47 +00:00
test Merge pull request #783 from robintown/font-params 2022-12-10 18:55:35 -05:00
.dockerignore Add CI 2021-12-20 16:59:39 +00:00
.env.example Remove unused variables from .env.example 2022-11-09 10:53:00 -05:00
.eslintrc.cjs Apply Prettier to the entire project 2022-12-09 14:34:25 -05:00
.gitignore Add instructions to put config.json inside public/ 2022-11-09 10:55:21 -05:00
.postcssrc.json Add automatic css prefixing 2021-10-14 17:41:59 -07:00
.prettierignore Add prettier support 2022-05-03 14:24:04 +01:00
.prettierrc.json Add prettier support 2022-05-03 14:24:04 +01:00
babel.config.cjs Add jest 2022-10-26 13:21:06 +02:00
CONTRIBUTING.md Apply Prettier to the entire project 2022-12-09 14:34:25 -05:00
Dockerfile Add arm64 Docker image 2022-05-31 10:14:42 -07:00
i18next-parser.config.js Apply Prettier to the entire project 2022-12-09 14:34:25 -05:00
LICENSE Add LICENSE 2021-07-16 14:31:42 -07:00
package.json Apply Prettier to the entire project 2022-12-09 14:34:25 -05:00
README.md Add instructions to put config.json inside public/ 2022-11-09 10:55:21 -05:00
sample.config.json Make the sample config usable without any edits 2022-11-09 10:54:13 -05:00
tsconfig.json Apply Prettier to the entire project 2022-12-09 14:34:25 -05:00
vite.config.js Don't touch the product name option for now 2022-12-20 17:30:47 +00:00
yarn.lock Save lockfile 2022-12-09 08:40:58 -05:00

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
cp sample.config.json public/config.json

You can now edit the configuration in .env and public/config.json to your liking. (See the configuration section for details.) 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
cp sample.config.json public/config.json

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

Configuration

There are currently two different config files. .env holds variables that are used at build time, while public/config.json holds variables that are used at runtime. Documentation and default values for public/config.json can be found in ConfigOptions.ts.

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.