93aafb1415
Co-authored-by: Robin <robin@robin.town> |
||
---|---|---|
.github | ||
.storybook | ||
.vscode | ||
config | ||
public | ||
scripts | ||
src | ||
test | ||
.dockerignore | ||
.env.example | ||
.eslintrc.cjs | ||
.gitignore | ||
.postcssrc.json | ||
.prettierignore | ||
.prettierrc.json | ||
babel.config.cjs | ||
CONTRIBUTING.md | ||
Dockerfile | ||
i18next-parser.config.js | ||
LICENSE | ||
package.json | ||
README.md | ||
sample.config.json | ||
tsconfig.json | ||
vite.config.js | ||
yarn.lock |
Element Call
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.