ci: GitLab-Pipeline - build_embedded + manueller npm-Publish nach rohana (threadnet-call#1)
Registry-Entscheidung evidenzbasiert: das Package ist pnpm-Dependency von ThreadNet-Webs apps/web, der Lockfile pinnt die Tarball-URL auf rohana - Registry bleibt dort. Publish-Auth ueber CI-Variable GITEA_NPM_TOKEN statt lokaler Klartext-.npmrc. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Thore Cimbal
Claude Fable 5
@@ -0,0 +1 @@
|
|||||||
|
node_modules
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
####
|
||||||
|
# Build-time app config
|
||||||
|
# Environment files are documented here:
|
||||||
|
# https://vitejs.dev/guide/env-and-mode.html#env-files
|
||||||
|
####
|
||||||
|
# Develop backend settings:
|
||||||
|
LIVEKIT_KEY="devkey"
|
||||||
|
LIVEKIT_SECRET="secret"
|
||||||
|
|
||||||
|
# Used for determining the homeserver to use for short urls etc.
|
||||||
|
# VITE_FALLBACK_STUN_ALLOWED=false
|
||||||
|
|
||||||
|
# CSS to be injected into the page for the purpose of custom theming.
|
||||||
|
# Generally, writing a custom theme involves overriding Compound design tokens,
|
||||||
|
# which are documented here:
|
||||||
|
# https://compound.element.io/?path=/docs/foundations-design-tokens--docs
|
||||||
|
# https://compound.element.io/?path=/docs/tokens-color-palettes--docs
|
||||||
|
# https://compound.element.io/?path=/docs/tokens-semantic-colors--docs
|
||||||
|
# VITE_CUSTOM_CSS=".cpd-theme-dark.cpd-theme-dark { --cpd-color-theme-bg: #101317; }"
|
||||||
+116
@@ -0,0 +1,116 @@
|
|||||||
|
const COPYRIGHT_HEADER = `/*
|
||||||
|
Copyright %%CURRENT_YEAR%% New Vector Ltd.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
||||||
|
Please see LICENSE in the repository root for full details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
`;
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
plugins: ["matrix-org", "rxjs", "jsdoc"],
|
||||||
|
extends: [
|
||||||
|
"plugin:matrix-org/react",
|
||||||
|
"plugin:matrix-org/a11y",
|
||||||
|
"plugin:matrix-org/typescript",
|
||||||
|
"prettier",
|
||||||
|
"plugin:rxjs/recommended",
|
||||||
|
"plugin:storybook/recommended",
|
||||||
|
],
|
||||||
|
parserOptions: {
|
||||||
|
ecmaVersion: "latest",
|
||||||
|
sourceType: "module",
|
||||||
|
project: ["./tsconfig.json"],
|
||||||
|
},
|
||||||
|
env: {
|
||||||
|
browser: true,
|
||||||
|
node: true,
|
||||||
|
},
|
||||||
|
rules: {
|
||||||
|
"jsdoc/no-types": "error",
|
||||||
|
"jsdoc/empty-tags": "error",
|
||||||
|
"jsdoc/check-property-names": "error",
|
||||||
|
"jsdoc/check-values": "error",
|
||||||
|
"jsdoc/check-param-names": "warn",
|
||||||
|
// "jsdoc/require-param": "warn",
|
||||||
|
"jsdoc/require-param-description": "warn",
|
||||||
|
"matrix-org/require-copyright-header": ["error", COPYRIGHT_HEADER],
|
||||||
|
"jsx-a11y/media-has-caption": "off",
|
||||||
|
"react/display-name": "error",
|
||||||
|
// Encourage proper usage of Promises:
|
||||||
|
"@typescript-eslint/no-floating-promises": "error",
|
||||||
|
"@typescript-eslint/no-misused-promises": "error",
|
||||||
|
"@typescript-eslint/promise-function-async": "error",
|
||||||
|
"@typescript-eslint/require-await": "error",
|
||||||
|
"@typescript-eslint/await-thenable": "error",
|
||||||
|
// To help ensure that we get proper vite/rollup lazy loading (e.g. for matrix-js-sdk):
|
||||||
|
"@typescript-eslint/consistent-type-imports": [
|
||||||
|
"error",
|
||||||
|
{ fixStyle: "inline-type-imports" },
|
||||||
|
],
|
||||||
|
// To encourage good usage of RxJS:
|
||||||
|
"rxjs/no-exposed-subjects": "error",
|
||||||
|
"rxjs/finnish": ["error", { names: { "^this$": false } }],
|
||||||
|
"no-restricted-imports": [
|
||||||
|
"error",
|
||||||
|
{
|
||||||
|
paths: ["matrix-widget-api", "matrix-js-sdk"].flatMap((lib) =>
|
||||||
|
["src", "src/", "src/index", "lib", "lib/", "lib/index"]
|
||||||
|
.map((path) => `${lib}/${path}`)
|
||||||
|
.map((name) => ({ name, message: `Please use ${lib} instead` })),
|
||||||
|
),
|
||||||
|
patterns: [
|
||||||
|
...["matrix-widget-api"].map((lib) => ({
|
||||||
|
group: ["src", "src/", "src/**", "lib", "lib/", "lib/**"].map(
|
||||||
|
(path) => `${lib}/${path}`,
|
||||||
|
),
|
||||||
|
message: `Please use ${lib} instead`,
|
||||||
|
})),
|
||||||
|
// XXX: We use /lib in lots of places, so allow for now.
|
||||||
|
...["matrix-js-sdk"].map((lib) => ({
|
||||||
|
group: ["src", "src/", "src/**"].map((path) => `${lib}/${path}`),
|
||||||
|
message: `Please use ${lib} instead`,
|
||||||
|
})),
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
overrides: [
|
||||||
|
{
|
||||||
|
files: ["src/*/**"],
|
||||||
|
rules: {
|
||||||
|
// In application code we should use the js-sdk logger, never console directly.
|
||||||
|
"no-console": ["error"],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: [
|
||||||
|
"**/*.test.ts",
|
||||||
|
"**/*.test.tsx",
|
||||||
|
"**/test.ts",
|
||||||
|
"**/test.tsx",
|
||||||
|
"**/test-**",
|
||||||
|
],
|
||||||
|
rules: {
|
||||||
|
"jsdoc/no-types": "off",
|
||||||
|
"jsdoc/empty-tags": "off",
|
||||||
|
"jsdoc/check-property-names": "off",
|
||||||
|
"jsdoc/check-values": "off",
|
||||||
|
"jsdoc/check-param-names": "off",
|
||||||
|
"jsdoc/require-param-description": "off",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: ["playwright/**"],
|
||||||
|
rules: {
|
||||||
|
// Playwright as a `use` function that has nothing to do with React hooks.
|
||||||
|
"react-hooks/rules-of-hooks": "off",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
settings: {
|
||||||
|
react: {
|
||||||
|
version: "detect",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
Executable
+9
@@ -0,0 +1,9 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# Checks if there currently is linking configured. Informs the user to disable linking before committing.
|
||||||
|
|
||||||
|
PNPMFILE=.pnpmfile.cjs
|
||||||
|
if test -f "$PNPMFILE"; then
|
||||||
|
echo "[pnpm-linker] The pre-commit hook detected $PNPMFILE which implies you have linked packages in your pnpm-lock.yaml. Run pnpm links:off and commit again. See also linking.md."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
* @element-hq/element-call-reviewers
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
name: Bug report
|
||||||
|
description: Create a report to help us improve
|
||||||
|
labels: [T-Defect]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this bug report!
|
||||||
|
|
||||||
|
Please report security issues by email to security@matrix.org
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction-steps
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Please attach screenshots, videos or logs if you can.
|
||||||
|
placeholder: Tell us what you see!
|
||||||
|
value: |
|
||||||
|
1. Where are you starting? What can you see?
|
||||||
|
2. What do you click?
|
||||||
|
3. More steps…
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: result
|
||||||
|
attributes:
|
||||||
|
label: Outcome
|
||||||
|
placeholder: Tell us what went wrong
|
||||||
|
value: |
|
||||||
|
#### What did you expect?
|
||||||
|
|
||||||
|
#### What happened instead?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: Operating system
|
||||||
|
placeholder: Windows, macOS, Ubuntu, Android…
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: browser
|
||||||
|
attributes:
|
||||||
|
label: Browser information
|
||||||
|
description: Which browser are you using? Which version?
|
||||||
|
placeholder: e.g. Chromium Version 92.0.4515.131
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: webapp-url
|
||||||
|
attributes:
|
||||||
|
label: URL for webapp
|
||||||
|
description: Which URL are you using to access the webapp? If a private server, tell us what version of Element Call you are using.
|
||||||
|
placeholder: e.g. call.element.io
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: dropdown
|
||||||
|
id: rageshake
|
||||||
|
attributes:
|
||||||
|
label: Will you send logs?
|
||||||
|
description: |
|
||||||
|
To send them, press the 'Submit Feedback' button and check 'Include Debug Logs'. Please link to this issue in the description field.
|
||||||
|
options:
|
||||||
|
- "Yes"
|
||||||
|
- "No"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Questions & support
|
||||||
|
url: https://matrix.to/#/#webrtc:matrix.org
|
||||||
|
about: Please ask and answer questions here.
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
name: Enhancement request
|
||||||
|
description: Do you have a suggestion or feature request?
|
||||||
|
labels: [T-Enhancement]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thank you for taking the time to propose a new feature or make a suggestion.
|
||||||
|
- type: textarea
|
||||||
|
id: usecase
|
||||||
|
attributes:
|
||||||
|
label: Your use case
|
||||||
|
description: What would you like to be able to do? Please feel welcome to include screenshots or mock ups.
|
||||||
|
placeholder: Tell us what you would like to do!
|
||||||
|
value: |
|
||||||
|
#### What would you like to do?
|
||||||
|
|
||||||
|
#### Why would you like to do it?
|
||||||
|
|
||||||
|
#### How would you like to achieve it?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: alternative
|
||||||
|
attributes:
|
||||||
|
label: Have you considered any alternatives?
|
||||||
|
placeholder: A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: additional-context
|
||||||
|
attributes:
|
||||||
|
label: Additional context
|
||||||
|
placeholder: Is there anything else you'd like to add?
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<!-- Thanks for submitting a PR! Please read CONTRIBUTING.md before you start. -->
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> **Features and UI changes require a pre-approved issue.**
|
||||||
|
> Every PR must have a linked issue
|
||||||
|
> that a maintainer has reviewed and approved **before you started writing code**.
|
||||||
|
> PRs that don't meet this requirement will not be reviewed.
|
||||||
|
> See [CONTRIBUTING.md](https://github.com/element-hq/element-call/blob/livekit/CONTRIBUTING.md) for ElementCall decided for this approach.
|
||||||
|
|
||||||
|
## Content
|
||||||
|
|
||||||
|
<!-- Describe shortly what has been changed -->
|
||||||
|
|
||||||
|
## Motivation and context
|
||||||
|
|
||||||
|
<!-- Provide a link to the pre-approved issue, or explain the context for a bug fix -->
|
||||||
|
|
||||||
|
## Screenshots / GIFs
|
||||||
|
|
||||||
|
<!--
|
||||||
|
|
||||||
|
You can use a table like this to show a before/after comparison.
|
||||||
|
Uncomment the markdown table below and fill in the last line:
|
||||||
|
|
||||||
|
|Before|After|
|
||||||
|
|-|-|
|
||||||
|
|||
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
<!-- Explain how you tested your changes -->
|
||||||
|
|
||||||
|
- Step 1
|
||||||
|
- Step 2
|
||||||
|
- Step ...
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] A linked, pre-approved issue exists for this feature or UI change.
|
||||||
|
- [ ] I have read [CONTRIBUTING.md](https://github.com/element-hq/element-call/blob/livekit/CONTRIBUTING.md) in full.
|
||||||
|
- [ ] Pull request includes screenshots or videos for any UI changes.
|
||||||
|
- [ ] Tests written for new code (and existing touched code where feasible).
|
||||||
|
- [ ] Linter and other CI checks pass.
|
||||||
|
- [ ] I have licensed the changes to Element by completing the [Contributor License Agreement (CLA)](https://cla-assistant.io/element-hq/element-call)
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
changelog:
|
||||||
|
categories:
|
||||||
|
- title: 🛠 Breaking Changes
|
||||||
|
labels:
|
||||||
|
- PR-Breaking-Change
|
||||||
|
- title: ✨ Features
|
||||||
|
labels:
|
||||||
|
- PR-Feature
|
||||||
|
- title: 🙌 Improvements
|
||||||
|
labels:
|
||||||
|
- PR-Improvement
|
||||||
|
- title: 📄 Documentation
|
||||||
|
labels:
|
||||||
|
- PR-Documentation
|
||||||
|
- title: 🐛 Bugfixes
|
||||||
|
labels:
|
||||||
|
- PR-Bug-Fix
|
||||||
|
- title: 💾 Developer Experience
|
||||||
|
labels:
|
||||||
|
- PR-Developer-Experience
|
||||||
|
- title: Others
|
||||||
|
labels:
|
||||||
|
- "*"
|
||||||
|
exclude:
|
||||||
|
labels:
|
||||||
|
- PR-Task
|
||||||
|
- dependencies
|
||||||
|
- title: 👒 Dependencies
|
||||||
|
labels:
|
||||||
|
- dependencies
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
name: Prevent blocked
|
||||||
|
on:
|
||||||
|
# zizmor: ignore[dangerous-triggers]
|
||||||
|
# Reason: This workflow does not checkout code or use secrets.
|
||||||
|
# It only reads labels to set a failure status on the PR.
|
||||||
|
pull_request_target:
|
||||||
|
types: [opened, labeled, unlabeled, synchronize]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
pull-requests: read
|
||||||
|
# Required to fail the check on the PR
|
||||||
|
statuses: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
prevent-blocked:
|
||||||
|
name: Prevent blocked
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
pull-requests: read
|
||||||
|
steps:
|
||||||
|
- name: Add notice
|
||||||
|
uses: actions/github-script@f28e40c7f34bde8b3046d885e986cb6290c5673b # v7
|
||||||
|
if: contains(github.event.pull_request.labels.*.name, 'X-Blocked')
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
core.setFailed("PR has been labeled with X-Blocked; it cannot be merged.");
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
name: Build and publish docker image
|
||||||
|
on:
|
||||||
|
workflow_call:
|
||||||
|
inputs:
|
||||||
|
docker_tags:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
artifact_run_id:
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
default: ${{ github.run_id }}
|
||||||
|
|
||||||
|
env:
|
||||||
|
REGISTRY: ghcr.io
|
||||||
|
IMAGE_NAME: ${{ github.repository }}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build_and_deploy:
|
||||||
|
name: Build & publish docker
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write # required to upload release asset
|
||||||
|
packages: write # needed for publishing packages to GHCR
|
||||||
|
id-token: write # needed for login into tailscale with GitHub OIDC Token
|
||||||
|
steps:
|
||||||
|
- name: Check it out
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: 📥 Download artifact
|
||||||
|
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run-id: ${{ inputs.artifact_run_id }}
|
||||||
|
name: build-output-full
|
||||||
|
path: dist
|
||||||
|
|
||||||
|
- name: Log in to container registry
|
||||||
|
uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0
|
||||||
|
with:
|
||||||
|
registry: ${{ env.REGISTRY }}
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Connect to Tailscale
|
||||||
|
uses: tailscale/github-action@306e68a486fd2350f2bfc3b19fcd143891a4a2d8 # v4
|
||||||
|
if: github.event_name != 'pull_request'
|
||||||
|
with:
|
||||||
|
oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }}
|
||||||
|
audience: ${{ secrets.TS_AUDIENCE }}
|
||||||
|
tags: tag:github-actions
|
||||||
|
|
||||||
|
- name: Compute vault jwt role name
|
||||||
|
id: vault-jwt-role
|
||||||
|
if: github.event_name != 'pull_request'
|
||||||
|
run: |
|
||||||
|
echo "role_name=github_service_management_$( echo "${{ github.repository }}" | sed -r 's|[/-]|_|g')" | tee -a "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Get team registry token
|
||||||
|
id: import-secrets
|
||||||
|
uses: hashicorp/vault-action@4c06c5ccf5c0761b6029f56cfb1dcf5565918a3b # v3
|
||||||
|
if: github.event_name != 'pull_request'
|
||||||
|
with:
|
||||||
|
url: https://vault.infra.ci.i.element.dev
|
||||||
|
role: ${{ steps.vault-jwt-role.outputs.role_name }}
|
||||||
|
path: service-management/github-actions
|
||||||
|
jwtGithubAudience: https://vault.infra.ci.i.element.dev
|
||||||
|
method: jwt
|
||||||
|
secrets: |
|
||||||
|
services/voip-repositories/secret/data/oci.element.io username | OCI_USERNAME ;
|
||||||
|
services/voip-repositories/secret/data/oci.element.io password | OCI_PASSWORD ;
|
||||||
|
|
||||||
|
- name: Login to oci.element.io Registry
|
||||||
|
uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3
|
||||||
|
if: github.event_name != 'pull_request'
|
||||||
|
with:
|
||||||
|
registry: oci-push.vpn.infra.element.io
|
||||||
|
username: ${{ steps.import-secrets.outputs.OCI_USERNAME }}
|
||||||
|
password: ${{ steps.import-secrets.outputs.OCI_PASSWORD }}
|
||||||
|
|
||||||
|
- name: Extract metadata (tags, labels) for Docker
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5.10.0
|
||||||
|
with:
|
||||||
|
images: |
|
||||||
|
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||||
|
oci-push.vpn.infra.element.io/element-call
|
||||||
|
tags: ${{ inputs.docker_tags }}
|
||||||
|
labels: |
|
||||||
|
org.opencontainers.image.licenses=AGPL-3.0-only OR LicenseRef-Element-Commercial
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
|
||||||
|
|
||||||
|
- name: Build and push Docker image
|
||||||
|
uses: docker/build-push-action@10e90e3645eae34f1e60eeb005ba3a3d33f178e8 # v6.19.2
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
name: Build Element Call
|
||||||
|
on:
|
||||||
|
workflow_call:
|
||||||
|
inputs:
|
||||||
|
vite_app_version:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
package:
|
||||||
|
type: string # This would ideally be a `choice` type, but that isn't supported yet
|
||||||
|
description: The package type to be built. Must be one of 'full', 'embedded', or 'sdk'
|
||||||
|
required: true
|
||||||
|
build_mode:
|
||||||
|
type: string # This would ideally be a `choice` type, but that isn't supported yet
|
||||||
|
description: The build mode for vite. Must be either 'development' or 'production'
|
||||||
|
required: false
|
||||||
|
default: production
|
||||||
|
secrets:
|
||||||
|
SENTRY_ORG:
|
||||||
|
required: true
|
||||||
|
SENTRY_PROJECT:
|
||||||
|
required: true
|
||||||
|
SENTRY_URL:
|
||||||
|
required: true
|
||||||
|
SENTRY_AUTH_TOKEN:
|
||||||
|
required: true
|
||||||
|
CODECOV_TOKEN:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build Element Call
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
- name: Enable Corepack
|
||||||
|
run: corepack enable
|
||||||
|
- name: pnpm cache
|
||||||
|
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
|
||||||
|
with:
|
||||||
|
cache: "pnpm"
|
||||||
|
node-version-file: ".node-version"
|
||||||
|
- name: Install dependencies
|
||||||
|
# ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present)
|
||||||
|
run: "pnpm install --frozen-lockfile --ignore-pnpmfile"
|
||||||
|
- name: Build Element Call
|
||||||
|
run: pnpm run build:"$PACKAGE":"$BUILD_MODE"
|
||||||
|
env:
|
||||||
|
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
|
||||||
|
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
|
||||||
|
SENTRY_URL: ${{ secrets.SENTRY_URL }}
|
||||||
|
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||||
|
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
VITE_APP_VERSION: ${{ inputs.vite_app_version }}
|
||||||
|
NODE_OPTIONS: "--max-old-space-size=4096"
|
||||||
|
PACKAGE: ${{ inputs.package }}
|
||||||
|
BUILD_MODE: ${{ inputs.build_mode }}
|
||||||
|
- name: Upload Artifact
|
||||||
|
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
|
||||||
|
with:
|
||||||
|
name: build-output-${{ inputs.package }}
|
||||||
|
path: dist
|
||||||
|
# We'll only use this in a triggered job, then we're done with it
|
||||||
|
retention-days: 1
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
name: Build
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types:
|
||||||
|
- synchronize
|
||||||
|
- opened
|
||||||
|
- labeled
|
||||||
|
push:
|
||||||
|
branches: [livekit, full-mesh]
|
||||||
|
jobs:
|
||||||
|
build_full_element_call:
|
||||||
|
# Use the full package vite build
|
||||||
|
uses: ./.github/workflows/build-element-call.yaml
|
||||||
|
with:
|
||||||
|
package: full
|
||||||
|
vite_app_version: ${{ github.event.release.tag_name || github.sha }}
|
||||||
|
build_mode: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'development build') && 'development' || 'production' }}
|
||||||
|
secrets:
|
||||||
|
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
|
||||||
|
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
|
||||||
|
SENTRY_URL: ${{ secrets.SENTRY_URL }}
|
||||||
|
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||||
|
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
deploy_develop:
|
||||||
|
# Deploy livekit branch to call.element.dev after build completes
|
||||||
|
if: github.ref == 'refs/heads/livekit'
|
||||||
|
needs: build_full_element_call
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Deploy to call.element.dev
|
||||||
|
uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.DEVELOP_DEPLOYMENT_TOKEN }}
|
||||||
|
script: |
|
||||||
|
await github.rest.actions.createWorkflowDispatch({
|
||||||
|
owner: 'element-hq',
|
||||||
|
repo: 'element-call-webapp-deployments',
|
||||||
|
workflow_id: 'deploy.yml',
|
||||||
|
ref: 'main',
|
||||||
|
inputs: {
|
||||||
|
target: 'call.element.dev',
|
||||||
|
version: '${{ github.sha }}'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
docker_for_develop:
|
||||||
|
# Build docker and publish docker for livekit branch after build completes
|
||||||
|
if: github.ref == 'refs/heads/livekit'
|
||||||
|
needs: build_full_element_call
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
packages: write
|
||||||
|
id-token: write
|
||||||
|
uses: ./.github/workflows/build-and-publish-docker.yaml
|
||||||
|
secrets: inherit
|
||||||
|
with:
|
||||||
|
artifact_run_id: ${{ github.run_id }}
|
||||||
|
docker_tags: |
|
||||||
|
type=sha,format=short,event=branch
|
||||||
|
type=raw,value=latest-ci
|
||||||
|
type=raw,value=latest-ci_{{date 'X' }}
|
||||||
|
build_embedded_element_call:
|
||||||
|
# Use the embedded package vite build
|
||||||
|
uses: ./.github/workflows/build-element-call.yaml
|
||||||
|
with:
|
||||||
|
package: embedded
|
||||||
|
vite_app_version: ${{ github.event.release.tag_name || github.sha }}
|
||||||
|
build_mode: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'development build') && 'development' || 'production' }}
|
||||||
|
secrets:
|
||||||
|
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
|
||||||
|
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
|
||||||
|
SENTRY_URL: ${{ secrets.SENTRY_URL }}
|
||||||
|
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||||
|
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
|
||||||
|
build_sdk_element_call:
|
||||||
|
# Use the embedded package vite build
|
||||||
|
uses: ./.github/workflows/build-element-call.yaml
|
||||||
|
with:
|
||||||
|
package: sdk
|
||||||
|
vite_app_version: ${{ github.event.release.tag_name || github.sha }}
|
||||||
|
build_mode: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'development build') && 'development' || 'production' }}
|
||||||
|
secrets:
|
||||||
|
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
|
||||||
|
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
|
||||||
|
SENTRY_URL: ${{ secrets.SENTRY_URL }}
|
||||||
|
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||||
|
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
|
||||||
|
build_storybook:
|
||||||
|
name: Build Storybook
|
||||||
|
if: contains(github.event.pull_request.labels.*.name, 'storybook build')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
- name: Enable Corepack
|
||||||
|
run: corepack enable
|
||||||
|
- name: pnpm cache
|
||||||
|
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
|
||||||
|
with:
|
||||||
|
cache: "pnpm"
|
||||||
|
node-version-file: ".node-version"
|
||||||
|
- name: Install dependencies
|
||||||
|
run: "pnpm install --frozen-lockfile --ignore-pnpmfile"
|
||||||
|
- name: Build Storybook
|
||||||
|
run: pnpm run build-storybook
|
||||||
|
- name: Upload Artifact
|
||||||
|
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
|
||||||
|
with:
|
||||||
|
name: build-output-storybook
|
||||||
|
path: storybook-static
|
||||||
|
# We'll only use this in a triggered job, then we're done with it
|
||||||
|
retention-days: 1
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
name: PR changelog label
|
||||||
|
|
||||||
|
on:
|
||||||
|
# zizmor: ignore[dangerous-triggers]
|
||||||
|
# This is safe because we do not use actions/checkout or execute untrusted code.
|
||||||
|
# Using pull_request_target is necessary to allow status writes for PRs from forks.
|
||||||
|
pull_request_target:
|
||||||
|
types: [labeled, unlabeled, opened, synchronize]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
pull-requests: read
|
||||||
|
statuses: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
pr-changelog-label:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: yogevbd/enforce-label-action@a3c219da6b8fa73f6ba62b68ff09c469b3a1c024 # 2.2.2
|
||||||
|
with:
|
||||||
|
REQUIRED_LABELS_ANY: "PR-Bug-Fix,PR-Documentation,PR-Task,PR-Feature,PR-Improvement,PR-Developer-Experience,dependencies,PR-Breaking-Change"
|
||||||
|
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one 'PR-' label"
|
||||||
|
BANNED_LABELS: "banned"
|
||||||
@@ -0,0 +1,104 @@
|
|||||||
|
name: Deploy to Netlify
|
||||||
|
on:
|
||||||
|
workflow_call:
|
||||||
|
inputs:
|
||||||
|
pr_number:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
pr_head_full_name:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
pr_head_ref:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
deployment_ref:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
package:
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
description: Which package to deploy - 'full', 'embedded', 'sdk', or 'storybook'
|
||||||
|
artifact_run_id:
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
default: ${{ github.run_id }}
|
||||||
|
secrets:
|
||||||
|
ELEMENT_BOT_TOKEN:
|
||||||
|
required: true
|
||||||
|
NETLIFY_AUTH_TOKEN:
|
||||||
|
required: true
|
||||||
|
NETLIFY_SITE_ID:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
deployments: write
|
||||||
|
environment: Netlify
|
||||||
|
steps:
|
||||||
|
- name: 📝 Create Deployment
|
||||||
|
uses: bobheadxi/deployments@648679e8e4915b27893bd7dbc35cb504dc915bc8 # v1
|
||||||
|
id: deployment
|
||||||
|
with:
|
||||||
|
step: start
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
env: ${{ inputs.package}}
|
||||||
|
ref: ${{ inputs.deployment_ref }}
|
||||||
|
desc: |
|
||||||
|
Do you trust the author of this PR? Maybe this build will steal your keys or give you malware.
|
||||||
|
Exercise caution. Use test accounts.
|
||||||
|
|
||||||
|
- name: 📥 Download artifact
|
||||||
|
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
||||||
|
run-id: ${{ inputs.artifact_run_id }}
|
||||||
|
name: build-output-${{ inputs.package }}
|
||||||
|
path: webapp
|
||||||
|
|
||||||
|
- name: Add redirects file
|
||||||
|
# We fetch from github directly as we don't bother checking out the repo
|
||||||
|
# Not needed for storybook deployments
|
||||||
|
if: inputs.package != 'storybook'
|
||||||
|
run: curl -s https://raw.githubusercontent.com/element-hq/element-call/main/config/netlify_redirects > webapp/_redirects
|
||||||
|
|
||||||
|
- name: Add config file
|
||||||
|
# Not needed for storybook deployments
|
||||||
|
if: inputs.package != 'storybook'
|
||||||
|
run: |
|
||||||
|
if [ "${INPUTS_PACKAGE}" = "full" ]; then
|
||||||
|
curl -s "https://raw.githubusercontent.com/${INPUTS_PR_HEAD_FULL_NAME}/${INPUTS_PR_HEAD_REF}/config/config_netlify_preview.json" > webapp/config.json
|
||||||
|
else
|
||||||
|
curl -s "https://raw.githubusercontent.com/${INPUTS_PR_HEAD_FULL_NAME}/${INPUTS_PR_HEAD_REF}/config/config_netlify_preview_sdk.json" > webapp/config.json
|
||||||
|
fi
|
||||||
|
env:
|
||||||
|
INPUTS_PACKAGE: ${{ inputs.package }}
|
||||||
|
INPUTS_PR_HEAD_FULL_NAME: ${{ inputs.pr_head_full_name }}
|
||||||
|
INPUTS_PR_HEAD_REF: ${{ inputs.pr_head_ref }}
|
||||||
|
- name: ☁️ Deploy to Netlify
|
||||||
|
id: netlify
|
||||||
|
uses: nwtgck/actions-netlify@4cbaf4c08f1a7bfa537d6113472ef4424e4eb654 # v3.0
|
||||||
|
with:
|
||||||
|
publish-dir: webapp
|
||||||
|
deploy-message: "Deploy from GitHub Actions"
|
||||||
|
alias: ${{ inputs.package == 'sdk' && format('pr{0}-sdk', inputs.pr_number) || inputs.package == 'storybook' && format('pr{0}-storybook', inputs.pr_number) || format('pr{0}', inputs.pr_number) }}
|
||||||
|
env:
|
||||||
|
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||||
|
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
|
||||||
|
timeout-minutes: 1
|
||||||
|
|
||||||
|
- name: 🚦 Update deployment status
|
||||||
|
uses: bobheadxi/deployments@648679e8e4915b27893bd7dbc35cb504dc915bc8 # v1
|
||||||
|
if: always()
|
||||||
|
with:
|
||||||
|
step: finish
|
||||||
|
override: false
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
status: ${{ job.status }}
|
||||||
|
env: ${{ steps.deployment.outputs.env }}
|
||||||
|
deployment_id: ${{ steps.deployment.outputs.deployment_id }}
|
||||||
|
env_url: ${{ steps.netlify.outputs.deploy-url }}
|
||||||
|
desc: |
|
||||||
|
Do you trust the author of this PR? Maybe this build will steal your keys or give you malware.
|
||||||
|
Exercise caution. Use test accounts.
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
name: Lint, format & type check
|
||||||
|
on:
|
||||||
|
pull_request: {}
|
||||||
|
jobs:
|
||||||
|
prettier:
|
||||||
|
name: Lint, format & type check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
- name: Enable Corepack
|
||||||
|
run: corepack enable
|
||||||
|
- name: pnpm cache
|
||||||
|
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
|
||||||
|
with:
|
||||||
|
cache: "pnpm"
|
||||||
|
node-version-file: ".node-version"
|
||||||
|
- name: Install dependencies
|
||||||
|
# ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present)
|
||||||
|
run: "pnpm install --frozen-lockfile --ignore-pnpmfile"
|
||||||
|
- name: Prettier
|
||||||
|
run: "pnpm run prettier:check"
|
||||||
|
- name: i18n
|
||||||
|
run: "pnpm run i18n:check"
|
||||||
|
- name: ESLint
|
||||||
|
run: "pnpm run lint:eslint"
|
||||||
|
- name: Type check
|
||||||
|
run: "pnpm run lint:types"
|
||||||
|
- name: Dead code analysis
|
||||||
|
run: "pnpm run lint:knip"
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
name: Deploy previews for PRs
|
||||||
|
on:
|
||||||
|
# zizmor: ignore[dangerous-triggers]
|
||||||
|
# Reason: This is now restricted to internal PRs only using the 'if' condition below.
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["Build"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
prdetails:
|
||||||
|
# Logic:
|
||||||
|
# 1. Build must be successful
|
||||||
|
# 2. Event must be a pull_request
|
||||||
|
# 3. Head repository must be the SAME as the base repository (No Forks!)
|
||||||
|
if: >
|
||||||
|
github.event.workflow_run.conclusion == 'success' &&
|
||||||
|
github.event.workflow_run.event == 'pull_request' &&
|
||||||
|
github.event.workflow_run.head_repository.full_name == github.repository
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
pr_number: ${{ steps.prdetails.outputs.pr_id }}
|
||||||
|
pr_data_json: ${{ steps.prdetails.outputs.data }}
|
||||||
|
steps:
|
||||||
|
- id: prdetails
|
||||||
|
uses: matrix-org/pr-details-action@15bde5285d7850ba276cc3bd8a03733e3f24622a # v1.3
|
||||||
|
continue-on-error: true
|
||||||
|
with:
|
||||||
|
owner: ${{ github.event.workflow_run.head_repository.owner.login }}
|
||||||
|
branch: ${{ github.event.workflow_run.head_branch }}
|
||||||
|
|
||||||
|
netlify-full:
|
||||||
|
needs: prdetails
|
||||||
|
permissions:
|
||||||
|
deployments: write
|
||||||
|
uses: ./.github/workflows/deploy-to-netlify.yaml
|
||||||
|
with:
|
||||||
|
artifact_run_id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
pr_number: ${{ needs.prdetails.outputs.pr_number }}
|
||||||
|
pr_head_full_name: ${{ github.event.workflow_run.head_repository.full_name }}
|
||||||
|
pr_head_ref: ${{ needs.prdetails.outputs.pr_data_json && fromJSON(needs.prdetails.outputs.pr_data_json).head.ref }}
|
||||||
|
deployment_ref: ${{ needs.prdetails.outputs.pr_data_json && fromJSON(needs.prdetails.outputs.pr_data_json).head.sha || github.ref || github.head_ref }}
|
||||||
|
package: full
|
||||||
|
secrets:
|
||||||
|
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
||||||
|
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||||
|
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
|
||||||
|
|
||||||
|
netlify-sdk:
|
||||||
|
needs: prdetails
|
||||||
|
permissions:
|
||||||
|
deployments: write
|
||||||
|
uses: ./.github/workflows/deploy-to-netlify.yaml
|
||||||
|
with:
|
||||||
|
artifact_run_id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
pr_number: ${{ needs.prdetails.outputs.pr_number }}
|
||||||
|
pr_head_full_name: ${{ github.event.workflow_run.head_repository.full_name }}
|
||||||
|
pr_head_ref: ${{ needs.prdetails.outputs.pr_data_json && fromJSON(needs.prdetails.outputs.pr_data_json).head.ref }}
|
||||||
|
deployment_ref: ${{ needs.prdetails.outputs.pr_data_json && fromJSON(needs.prdetails.outputs.pr_data_json).head.sha || github.ref || github.head_ref }}
|
||||||
|
package: sdk
|
||||||
|
secrets:
|
||||||
|
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
||||||
|
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||||
|
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
|
||||||
|
|
||||||
|
netlify-storybook:
|
||||||
|
needs: prdetails
|
||||||
|
if: ${{ needs.prdetails.outputs.pr_data_json && contains(fromJSON(needs.prdetails.outputs.pr_data_json).labels.*.name, 'storybook build') }}
|
||||||
|
permissions:
|
||||||
|
deployments: write
|
||||||
|
uses: ./.github/workflows/deploy-to-netlify.yaml
|
||||||
|
with:
|
||||||
|
artifact_run_id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
pr_number: ${{ needs.prdetails.outputs.pr_number }}
|
||||||
|
pr_head_full_name: ${{ github.event.workflow_run.head_repository.full_name }}
|
||||||
|
pr_head_ref: ${{ needs.prdetails.outputs.pr_data_json && fromJSON(needs.prdetails.outputs.pr_data_json).head.ref }}
|
||||||
|
deployment_ref: ${{ needs.prdetails.outputs.pr_data_json && fromJSON(needs.prdetails.outputs.pr_data_json).head.sha || github.ref || github.head_ref }}
|
||||||
|
package: storybook
|
||||||
|
secrets:
|
||||||
|
ELEMENT_BOT_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
||||||
|
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||||
|
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
|
||||||
|
|
||||||
|
docker:
|
||||||
|
if: ${{ needs.prdetails.outputs.pr_data_json && contains(fromJSON(needs.prdetails.outputs.pr_data_json).labels.*.name, 'docker build') }}
|
||||||
|
needs: prdetails
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
packages: write
|
||||||
|
id-token: write
|
||||||
|
uses: ./.github/workflows/build-and-publish-docker.yaml
|
||||||
|
secrets: inherit
|
||||||
|
with:
|
||||||
|
artifact_run_id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
docker_tags: |
|
||||||
|
type=sha,format=short,event=branch
|
||||||
|
type=raw,value=pr_${{ needs.prdetails.outputs.pr_number }}
|
||||||
@@ -0,0 +1,328 @@
|
|||||||
|
name: Build & publish embedded packages for releases
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
pull_request:
|
||||||
|
types:
|
||||||
|
- synchronize
|
||||||
|
- opened
|
||||||
|
- labeled
|
||||||
|
push:
|
||||||
|
branches: [livekit]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
versioning:
|
||||||
|
name: Versioning
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
DRY_RUN: ${{ steps.dry_run.outputs.DRY_RUN }}
|
||||||
|
PREFIXED_VERSION: ${{ steps.prefixed_version.outputs.PREFIXED_VERSION }}
|
||||||
|
UNPREFIXED_VERSION: ${{ steps.unprefixed_version.outputs.UNPREFIXED_VERSION }}
|
||||||
|
TAG: ${{ steps.tag.outputs.TAG }}
|
||||||
|
steps:
|
||||||
|
- name: Calculate VERSION
|
||||||
|
# Safely store dynamic values in environment variables
|
||||||
|
# to prevent shell injection (template-injection)
|
||||||
|
run: |
|
||||||
|
# The logic is executed within the shell using the env variables
|
||||||
|
if [ "$EVENT_NAME" = "release" ]; then
|
||||||
|
echo "VERSION=$RELEASE_TAG" >> "$GITHUB_ENV"
|
||||||
|
else
|
||||||
|
echo "VERSION=v0.0.0-pre.0" >> "$GITHUB_ENV"
|
||||||
|
fi
|
||||||
|
env:
|
||||||
|
RELEASE_TAG: ${{ github.event.release.tag_name }}
|
||||||
|
EVENT_NAME: ${{ github.event_name }}
|
||||||
|
- id: dry_run
|
||||||
|
name: Set DRY_RUN
|
||||||
|
# We perform a dry run for all events except releases.
|
||||||
|
# This is to help make sure that we notice if the packaging process has become
|
||||||
|
# broken ahead of a release.
|
||||||
|
run: echo "DRY_RUN=${{ github.event_name != 'release' }}" >> "$GITHUB_OUTPUT"
|
||||||
|
- id: prefixed_version
|
||||||
|
name: Set PREFIXED_VERSION
|
||||||
|
run: echo "PREFIXED_VERSION=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
|
- id: unprefixed_version
|
||||||
|
name: Set UNPREFIXED_VERSION
|
||||||
|
# This just strips the leading character
|
||||||
|
run: echo "UNPREFIXED_VERSION=${VERSION:1}" >> "$GITHUB_OUTPUT"
|
||||||
|
- id: tag
|
||||||
|
# latest = a proper release
|
||||||
|
# other = anything else
|
||||||
|
name: Set tag
|
||||||
|
run: |
|
||||||
|
if [[ "${VERSION}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
||||||
|
echo "TAG=latest" >> "$GITHUB_OUTPUT"
|
||||||
|
elif [[ "${VERSION}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+\-rc\.[0-9]+$ ]]; then
|
||||||
|
echo "TAG=rc" >> "$GITHUB_OUTPUT"
|
||||||
|
else
|
||||||
|
echo "TAG=other" >> "$GITHUB_OUTPUT"
|
||||||
|
fi
|
||||||
|
|
||||||
|
build_element_call:
|
||||||
|
needs: versioning
|
||||||
|
uses: ./.github/workflows/build-element-call.yaml
|
||||||
|
with:
|
||||||
|
vite_app_version: embedded-${{ needs.versioning.outputs.PREFIXED_VERSION }}
|
||||||
|
package: embedded
|
||||||
|
secrets:
|
||||||
|
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
|
||||||
|
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
|
||||||
|
SENTRY_URL: ${{ secrets.SENTRY_URL }}
|
||||||
|
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||||
|
|
||||||
|
publish_tarball:
|
||||||
|
needs: [build_element_call, versioning]
|
||||||
|
if: always()
|
||||||
|
name: Publish tarball
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write # required to upload release asset
|
||||||
|
steps:
|
||||||
|
- name: Determine filename
|
||||||
|
run: echo "FILENAME_PREFIX=element-call-embedded-${NEEDS_VERSIONING_OUTPUTS_UNPREFIXED_VERSION}" >> "$GITHUB_ENV"
|
||||||
|
env:
|
||||||
|
NEEDS_VERSIONING_OUTPUTS_UNPREFIXED_VERSION: ${{ needs.versioning.outputs.UNPREFIXED_VERSION }}
|
||||||
|
- name: 📥 Download built element-call artifact
|
||||||
|
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run-id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
name: build-output-embedded
|
||||||
|
path: ${{ env.FILENAME_PREFIX}}
|
||||||
|
- name: Create Tarball
|
||||||
|
run: tar --numeric-owner -cvzf ${FILENAME_PREFIX}.tar.gz ${FILENAME_PREFIX}
|
||||||
|
- name: Create Checksum
|
||||||
|
run: find ${FILENAME_PREFIX} -type f -print0 | sort -z | xargs -0 sha256sum | tee ${FILENAME_PREFIX}.sha256
|
||||||
|
- name: Upload
|
||||||
|
if: ${{ needs.versioning.outputs.DRY_RUN == 'false' }}
|
||||||
|
uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
|
||||||
|
with:
|
||||||
|
files: |
|
||||||
|
${{ env.FILENAME_PREFIX }}.tar.gz
|
||||||
|
${{ env.FILENAME_PREFIX }}.sha256
|
||||||
|
|
||||||
|
publish_npm:
|
||||||
|
needs: [build_element_call, versioning]
|
||||||
|
if: always()
|
||||||
|
name: Publish NPM
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
ARTIFACT_VERSION: ${{ steps.artifact_version.outputs.ARTIFACT_VERSION }}
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
id-token: write # Allow npm to authenticate as a trusted publisher
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: 📥 Download built element-call artifact
|
||||||
|
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run-id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
name: build-output-embedded
|
||||||
|
path: embedded/web/dist
|
||||||
|
|
||||||
|
# n.b. We don't enable corepack here because we are using plain npm
|
||||||
|
- name: Setup node
|
||||||
|
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
|
||||||
|
with:
|
||||||
|
node-version-file: .node-version
|
||||||
|
registry-url: "https://registry.npmjs.org"
|
||||||
|
|
||||||
|
- name: Publish npm
|
||||||
|
working-directory: embedded/web
|
||||||
|
run: |
|
||||||
|
npm version ${NEEDS_VERSIONING_OUTPUTS_PREFIXED_VERSION} --no-git-tag-version
|
||||||
|
echo "ARTIFACT_VERSION=$(jq '.version' --raw-output package.json)" >> "$GITHUB_ENV"
|
||||||
|
npm publish --provenance --access public --tag ${NEEDS_VERSIONING_OUTPUTS_TAG} ${{ needs.versioning.outputs.DRY_RUN == 'true' && '--dry-run' || '' }}
|
||||||
|
env:
|
||||||
|
NEEDS_VERSIONING_OUTPUTS_PREFIXED_VERSION: ${{ needs.versioning.outputs.PREFIXED_VERSION }}
|
||||||
|
NEEDS_VERSIONING_OUTPUTS_TAG: ${{ needs.versioning.outputs.TAG }}
|
||||||
|
|
||||||
|
- id: artifact_version
|
||||||
|
name: Output artifact version
|
||||||
|
run: echo "ARTIFACT_VERSION=${ARTIFACT_VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
publish_android:
|
||||||
|
needs: [build_element_call, versioning]
|
||||||
|
if: always()
|
||||||
|
name: Publish Android AAR
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
ARTIFACT_VERSION: ${{ steps.artifact_version.outputs.ARTIFACT_VERSION }}
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: 📥 Download built element-call artifact
|
||||||
|
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run-id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
name: build-output-embedded
|
||||||
|
path: embedded/android/lib/src/main/assets/element-call
|
||||||
|
|
||||||
|
- name: ☕️ Setup Java
|
||||||
|
uses: actions/setup-java@c1e323688fd81a25caa38c78aa6df2d33d3e20d9 # v4
|
||||||
|
with:
|
||||||
|
distribution: "temurin"
|
||||||
|
java-version: "17"
|
||||||
|
|
||||||
|
- name: Get artifact version
|
||||||
|
# Anything that is not a final release will be tagged as a snapshot
|
||||||
|
run: |
|
||||||
|
if [[ "${NEEDS_VERSIONING_OUTPUTS_TAG}" == "latest" ]]; then
|
||||||
|
echo "ARTIFACT_VERSION=${NEEDS_VERSIONING_OUTPUTS_UNPREFIXED_VERSION}" >> "$GITHUB_ENV"
|
||||||
|
elif [[ "${NEEDS_VERSIONING_OUTPUTS_TAG}" == "rc" ]]; then
|
||||||
|
echo "ARTIFACT_VERSION=${NEEDS_VERSIONING_OUTPUTS_UNPREFIXED_VERSION}" >> "$GITHUB_ENV"
|
||||||
|
else
|
||||||
|
echo "ARTIFACT_VERSION=${NEEDS_VERSIONING_OUTPUTS_UNPREFIXED_VERSION}-SNAPSHOT" >> "$GITHUB_ENV"
|
||||||
|
fi
|
||||||
|
env:
|
||||||
|
NEEDS_VERSIONING_OUTPUTS_TAG: ${{ needs.versioning.outputs.TAG }}
|
||||||
|
NEEDS_VERSIONING_OUTPUTS_UNPREFIXED_VERSION: ${{ needs.versioning.outputs.UNPREFIXED_VERSION }}
|
||||||
|
|
||||||
|
- name: Set version string
|
||||||
|
run: sed -i "s/0.0.0/${ARTIFACT_VERSION}/g" embedded/android/lib/src/main/kotlin/io/element/android/call/embedded/Version.kt
|
||||||
|
|
||||||
|
- name: Publish AAR
|
||||||
|
working-directory: embedded/android
|
||||||
|
env:
|
||||||
|
EC_VERSION: ${{ env.ARTIFACT_VERSION }}
|
||||||
|
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_RELEASE_USERNAME }}
|
||||||
|
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_RELEASE_PASSWORD }}
|
||||||
|
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_SIGNING_KEY }}
|
||||||
|
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.GPG_SIGNING_KEY_PASSWORD }}
|
||||||
|
run: ./gradlew publishToMavenCentral --no-daemon ${{ needs.versioning.outputs.DRY_RUN == 'true' && '--dry-run' || '' }}
|
||||||
|
|
||||||
|
- id: artifact_version
|
||||||
|
name: Output artifact version
|
||||||
|
run: echo "ARTIFACT_VERSION=${ARTIFACT_VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
publish_ios:
|
||||||
|
needs: [build_element_call, versioning]
|
||||||
|
if: always()
|
||||||
|
name: Publish SwiftPM Library
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
ARTIFACT_VERSION: ${{ steps.artifact_version.outputs.ARTIFACT_VERSION }}
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
path: element-call
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: 📥 Download built element-call artifact
|
||||||
|
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run-id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
name: build-output-embedded
|
||||||
|
path: element-call/embedded/ios/Sources/dist
|
||||||
|
|
||||||
|
- name: Checkout element-call-swift
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
repository: element-hq/element-call-swift
|
||||||
|
path: element-call-swift
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Copy files
|
||||||
|
run: rsync -a --delete --exclude .git element-call/embedded/ios/ element-call-swift
|
||||||
|
|
||||||
|
- name: Get artifact version
|
||||||
|
run: echo "ARTIFACT_VERSION=${NEEDS_VERSIONING_OUTPUTS_UNPREFIXED_VERSION}" >> "$GITHUB_ENV"
|
||||||
|
env:
|
||||||
|
NEEDS_VERSIONING_OUTPUTS_UNPREFIXED_VERSION: ${{ needs.versioning.outputs.UNPREFIXED_VERSION }}
|
||||||
|
|
||||||
|
- name: Set version string
|
||||||
|
run: sed -i "s/0.0.0/${ARTIFACT_VERSION}/g" element-call-swift/Sources/EmbeddedElementCall/EmbeddedElementCall.swift
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
working-directory: element-call-swift
|
||||||
|
run: swift build
|
||||||
|
|
||||||
|
- name: Commit and tag
|
||||||
|
working-directory: element-call-swift
|
||||||
|
run: |
|
||||||
|
git config --global user.email "ci@element.io"
|
||||||
|
git config --global user.name "Element CI"
|
||||||
|
git add -A
|
||||||
|
git commit -am "Release ${NEEDS_VERSIONING_OUTPUTS_PREFIXED_VERSION}"
|
||||||
|
git tag -a ${ARTIFACT_VERSION} -m "${GITHUB_EVENT_RELEASE_HTML_URL}"
|
||||||
|
env:
|
||||||
|
NEEDS_VERSIONING_OUTPUTS_PREFIXED_VERSION: ${{ needs.versioning.outputs.PREFIXED_VERSION }}
|
||||||
|
GITHUB_EVENT_RELEASE_HTML_URL: ${{ github.event.release.html_url }}
|
||||||
|
|
||||||
|
- name: Push
|
||||||
|
if: ${{ needs.versioning.outputs.DRY_RUN == 'false' }}
|
||||||
|
working-directory: element-call-swift
|
||||||
|
run: |
|
||||||
|
git push "https://x-access-token:${SWIFT_RELEASE_TOKEN}@github.com/element-hq/element-call-swift.git" --tags
|
||||||
|
env:
|
||||||
|
SWIFT_RELEASE_TOKEN: ${{ secrets.SWIFT_RELEASE_TOKEN }}
|
||||||
|
|
||||||
|
- id: artifact_version
|
||||||
|
name: Output artifact version
|
||||||
|
run: echo "ARTIFACT_VERSION=${ARTIFACT_VERSION}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
release_notes:
|
||||||
|
needs: [versioning, publish_npm, publish_android, publish_ios]
|
||||||
|
if: always()
|
||||||
|
name: Update release notes
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write # to update release notes
|
||||||
|
steps:
|
||||||
|
- name: Log versions
|
||||||
|
run: |
|
||||||
|
echo "NPM: ${NEEDS_PUBLISH_NPM_OUTPUTS_ARTIFACT_VERSION}"
|
||||||
|
echo "Android: ${NEEDS_PUBLISH_ANDROID_OUTPUTS_ARTIFACT_VERSION}"
|
||||||
|
echo "iOS: ${NEEDS_PUBLISH_IOS_OUTPUTS_ARTIFACT_VERSION}"
|
||||||
|
env:
|
||||||
|
NEEDS_PUBLISH_NPM_OUTPUTS_ARTIFACT_VERSION: ${{ needs.publish_npm.outputs.ARTIFACT_VERSION }}
|
||||||
|
NEEDS_PUBLISH_ANDROID_OUTPUTS_ARTIFACT_VERSION: ${{ needs.publish_android.outputs.ARTIFACT_VERSION }}
|
||||||
|
NEEDS_PUBLISH_IOS_OUTPUTS_ARTIFACT_VERSION: ${{ needs.publish_ios.outputs.ARTIFACT_VERSION }}
|
||||||
|
- name: Add release notes
|
||||||
|
if: ${{ needs.versioning.outputs.DRY_RUN == 'false' }}
|
||||||
|
uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
|
||||||
|
with:
|
||||||
|
append_body: true
|
||||||
|
body: |
|
||||||
|
|
||||||
|
## Embedded packages
|
||||||
|
|
||||||
|
This release includes the following embedded packages that allow Element Call to be used as an embedded widget
|
||||||
|
within another application.
|
||||||
|
|
||||||
|
### NPM
|
||||||
|
|
||||||
|
```
|
||||||
|
npm install @element-hq/element-call-embedded@${{ needs.publish_npm.outputs.ARTIFACT_VERSION }}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Android AAR
|
||||||
|
|
||||||
|
```
|
||||||
|
dependencies {
|
||||||
|
implementation 'io.element.android:element-call-embedded:${{ needs.publish_android.outputs.ARTIFACT_VERSION }}'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### SwiftPM
|
||||||
|
|
||||||
|
```
|
||||||
|
.package(url: "https://github.com/element-hq/element-call-swift.git", from: "${{ needs.publish_ios.outputs.ARTIFACT_VERSION }}")
|
||||||
|
```
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
name: Build & publish full packages for releases
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
|
||||||
|
env:
|
||||||
|
VERSION: ${{ github.event.release.tag_name }}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build_element_call:
|
||||||
|
uses: ./.github/workflows/build-element-call.yaml
|
||||||
|
with:
|
||||||
|
package: full
|
||||||
|
vite_app_version: ${{ github.event.release.tag_name }} # Using ${{ env.VERSION }} here doesn't work
|
||||||
|
secrets:
|
||||||
|
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
|
||||||
|
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
|
||||||
|
SENTRY_URL: ${{ secrets.SENTRY_URL }}
|
||||||
|
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||||
|
|
||||||
|
publish_tarball:
|
||||||
|
needs: build_element_call
|
||||||
|
if: always()
|
||||||
|
name: Publish tarball
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write # required to upload release asset
|
||||||
|
packages: write
|
||||||
|
steps:
|
||||||
|
- name: Determine filename
|
||||||
|
run: echo "FILENAME_PREFIX=element-call-${VERSION:1}" >> "$GITHUB_ENV"
|
||||||
|
- name: 📥 Download built element-call artifact
|
||||||
|
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run-id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
name: build-output-full
|
||||||
|
path: ${{ env.FILENAME_PREFIX }}
|
||||||
|
- name: Create Tarball
|
||||||
|
run: tar --numeric-owner --transform "s/dist/${FILENAME_PREFIX}/" -cvzf ${FILENAME_PREFIX}.tar.gz ${FILENAME_PREFIX}
|
||||||
|
- name: Create Checksum
|
||||||
|
run: find ${FILENAME_PREFIX} -type f -print0 | sort -z | xargs -0 sha256sum | tee ${FILENAME_PREFIX}.sha256
|
||||||
|
- name: Upload
|
||||||
|
uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
|
||||||
|
with:
|
||||||
|
files: |
|
||||||
|
${{ env.FILENAME_PREFIX }}.tar.gz
|
||||||
|
${{ env.FILENAME_PREFIX }}.sha256
|
||||||
|
|
||||||
|
publish_docker:
|
||||||
|
needs: build_element_call
|
||||||
|
if: always()
|
||||||
|
name: Publish docker
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
packages: write
|
||||||
|
id-token: write
|
||||||
|
uses: ./.github/workflows/build-and-publish-docker.yaml
|
||||||
|
secrets: inherit
|
||||||
|
with:
|
||||||
|
artifact_run_id: ${{ github.event.workflow_run.id || github.run_id }}
|
||||||
|
docker_tags: |
|
||||||
|
type=sha,format=short,event=branch
|
||||||
|
type=raw,value=${{ github.event.release.tag_name }}
|
||||||
|
type=raw,value=latest
|
||||||
|
# Like before, using ${{ env.VERSION }} above doesn't work
|
||||||
|
add_docker_release_note:
|
||||||
|
needs: publish_docker
|
||||||
|
name: Add docker release note
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Add release note
|
||||||
|
uses: softprops/action-gh-release@3bb12739c298aeb8a4eeaf626c5b8d85266b0e65 # v2
|
||||||
|
with:
|
||||||
|
append_body: true
|
||||||
|
body: |
|
||||||
|
## Docker full package
|
||||||
|
Element Call is available as a Docker image from the [GitHub Container Registry](https://github.com/element-hq/element-call/pkgs/container/element-call).
|
||||||
|
|
||||||
|
The image provides a full build of Element Call that can be used both in standalone and as a widget (on a remote URL).
|
||||||
|
|
||||||
|
```
|
||||||
|
docker pull ghcr.io/element-hq/element-call:${{ env.VERSION }}
|
||||||
|
```
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
# Triggers after the playwright tests have finished,
|
||||||
|
# taking the artifact and uploading it to Netlify for easier viewing
|
||||||
|
name: Upload End to End Test report to Netlify
|
||||||
|
on:
|
||||||
|
# Privilege escalation necessary to publish to Netlify
|
||||||
|
# 🚨 We must not execute any checked out code here.
|
||||||
|
workflow_run: # zizmor: ignore[dangerous-triggers]
|
||||||
|
workflows: ["Test"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.event.workflow_run.head_branch || github.run_id }}
|
||||||
|
cancel-in-progress: ${{ github.event.workflow_run.event == 'pull_request' }}
|
||||||
|
|
||||||
|
permissions: {}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
report:
|
||||||
|
if: github.event.workflow_run.conclusion != 'cancelled'
|
||||||
|
name: Report results
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
environment: Netlify
|
||||||
|
permissions:
|
||||||
|
statuses: write
|
||||||
|
deployments: write
|
||||||
|
actions: read
|
||||||
|
steps:
|
||||||
|
- name: Download HTML report
|
||||||
|
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run-id: ${{ github.event.workflow_run.id }}
|
||||||
|
name: html-report
|
||||||
|
path: playwright-report
|
||||||
|
|
||||||
|
- name: 📤 Deploy to Netlify
|
||||||
|
uses: matrix-org/netlify-pr-preview@9805cd123fc9a7e421e35340a05e1ebc5dee46b5 # v3
|
||||||
|
with:
|
||||||
|
path: playwright-report
|
||||||
|
owner: ${{ github.event.workflow_run.head_repository.owner.login }}
|
||||||
|
branch: ${{ github.event.workflow_run.head_branch }}
|
||||||
|
revision: ${{ github.event.workflow_run.head_sha }}
|
||||||
|
token: ${{ secrets.NETLIFY_AUTH_TOKEN }}
|
||||||
|
site_id: ${{ secrets.NETLIFY_SITE_ID }}
|
||||||
|
desc: Playwright Report
|
||||||
|
deployment_env: EndToEndTests
|
||||||
|
prefix: "e2e-"
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
name: Test
|
||||||
|
on:
|
||||||
|
pull_request: {}
|
||||||
|
push:
|
||||||
|
branches: [livekit]
|
||||||
|
jobs:
|
||||||
|
vitest:
|
||||||
|
name: Run unit tests
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
# Make sure to grab the latest version of the Playwright image
|
||||||
|
# https://playwright.dev/docs/docker#pull-the-image
|
||||||
|
image: mcr.microsoft.com/playwright:v1.60.0-noble
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
- name: Enable Corepack
|
||||||
|
run: corepack enable
|
||||||
|
- name: pnpm cache
|
||||||
|
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
|
||||||
|
with:
|
||||||
|
cache: "pnpm"
|
||||||
|
node-version-file: ".node-version"
|
||||||
|
- name: Install dependencies
|
||||||
|
# ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present)
|
||||||
|
run: "pnpm install --frozen-lockfile --ignore-pnpmfile"
|
||||||
|
- name: Vitest
|
||||||
|
run: "pnpm run test:coverage"
|
||||||
|
- name: Upload to codecov
|
||||||
|
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7
|
||||||
|
env:
|
||||||
|
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
||||||
|
with:
|
||||||
|
flags: unittests
|
||||||
|
fail_ci_if_error: true
|
||||||
|
playwright:
|
||||||
|
name: Run end-to-end tests
|
||||||
|
timeout-minutes: 60
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
- name: Enable Corepack
|
||||||
|
run: corepack enable
|
||||||
|
- uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
|
||||||
|
with:
|
||||||
|
cache: "pnpm"
|
||||||
|
node-version-file: ".node-version"
|
||||||
|
- name: Install dependencies
|
||||||
|
# ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present)
|
||||||
|
run: pnpm install --frozen-lockfile --ignore-pnpmfile
|
||||||
|
- name: Install Playwright Browsers
|
||||||
|
run: pnpm exec playwright install --with-deps
|
||||||
|
- name: Run backend components
|
||||||
|
run: |
|
||||||
|
docker compose -f playwright-backend-docker-compose.yml -f playwright-backend-docker-compose.override.yml pull
|
||||||
|
docker compose -f playwright-backend-docker-compose.yml -f playwright-backend-docker-compose.override.yml up -d
|
||||||
|
docker ps
|
||||||
|
- name: Run Playwright tests
|
||||||
|
env:
|
||||||
|
USE_DOCKER: 1
|
||||||
|
run: pnpm exec playwright test
|
||||||
|
- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||||
|
if: ${{ !cancelled() }}
|
||||||
|
with:
|
||||||
|
name: html-report
|
||||||
|
path: playwright-report
|
||||||
|
if-no-files-found: error
|
||||||
|
retention-days: 4
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
name: Download translation files from Localazy
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
secrets:
|
||||||
|
ELEMENT_BOT_TOKEN:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
download:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout the code
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Enable Corepack
|
||||||
|
run: corepack enable
|
||||||
|
|
||||||
|
- uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
|
||||||
|
with:
|
||||||
|
cache: "pnpm"
|
||||||
|
node-version-file: ".node-version"
|
||||||
|
|
||||||
|
- name: Install Deps
|
||||||
|
# ignore-pnpmfile should never be commited. Make CI crash if it happened (`pnpmfileChecksum` is present)
|
||||||
|
run: "pnpm install --frozen-lockfile --ignore-pnpmfile"
|
||||||
|
|
||||||
|
- name: Prune i18n
|
||||||
|
run: "rm -R locales"
|
||||||
|
|
||||||
|
- name: Download translation files
|
||||||
|
uses: localazy/download@0a79880fb66150601e3b43606fab69c88123c087 # v1.1.0
|
||||||
|
with:
|
||||||
|
groups: "-p includeSourceLang:true"
|
||||||
|
|
||||||
|
- name: Fix the owner of the downloaded files
|
||||||
|
run: "sudo chown runner:docker -R locales"
|
||||||
|
|
||||||
|
- name: Prettier
|
||||||
|
run: pnpm prettier:format
|
||||||
|
|
||||||
|
- name: Create Pull Request
|
||||||
|
id: cpr
|
||||||
|
uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676 # v7.0.11
|
||||||
|
with:
|
||||||
|
token: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
||||||
|
branch: actions/localazy-download
|
||||||
|
delete-branch: true
|
||||||
|
title: Localazy Download
|
||||||
|
commit-message: Translations updates
|
||||||
|
labels: |
|
||||||
|
T-Task
|
||||||
|
|
||||||
|
- name: Enable automerge
|
||||||
|
run: gh pr merge --merge --auto "$PR_NUMBER"
|
||||||
|
if: steps.cpr.outputs.pull-request-operation == 'created'
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.ELEMENT_BOT_TOKEN }}
|
||||||
|
PR_NUMBER: ${{ steps.cpr.outputs.pull-request-number }}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
name: Upload translation files to Localazy
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- livekit
|
||||||
|
paths-ignore:
|
||||||
|
- ".github/**"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
upload:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout the code
|
||||||
|
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Upload
|
||||||
|
uses: localazy/upload@27e6b5c0fddf4551596b42226b1c24124335d24a # v1
|
||||||
|
with:
|
||||||
|
write_key: ${{ secrets.LOCALAZY_WRITE_KEY }}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
name: GitHub Actions Security Analysis with zizmor 🌈
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: ["livekit", "full-mesh"]
|
||||||
|
pull_request: {}
|
||||||
|
|
||||||
|
permissions: {}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
zizmor:
|
||||||
|
name: Run zizmor 🌈
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
security-events: write # Required for upload-sarif (used by zizmor-action) to upload SARIF files.
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Run zizmor 🌈
|
||||||
|
uses: zizmorcore/zizmor-action@b1d7e1fb5de872772f31590499237e7cce841e8e # v0.5.3
|
||||||
+40
@@ -0,0 +1,40 @@
|
|||||||
|
node_modules
|
||||||
|
.DS_Store
|
||||||
|
.env
|
||||||
|
dist
|
||||||
|
dist-ssr
|
||||||
|
*.local
|
||||||
|
*.bkp
|
||||||
|
.idea/
|
||||||
|
public/config.json
|
||||||
|
backend/synapse_tmp/*
|
||||||
|
backend/synapse_tmp_othersite/*
|
||||||
|
/coverage
|
||||||
|
config.json
|
||||||
|
|
||||||
|
# Yarn
|
||||||
|
yarn-error.log
|
||||||
|
/.pnp.*
|
||||||
|
/.yarn/*
|
||||||
|
!/.yarn/patches
|
||||||
|
!/.yarn/plugins
|
||||||
|
!/.yarn/releases
|
||||||
|
!/.yarn/sdks
|
||||||
|
!/.yarn/versions
|
||||||
|
# old yarn based linking
|
||||||
|
/.links.yaml
|
||||||
|
/.links.disabled.yaml
|
||||||
|
/.links.temp-disabled.yaml
|
||||||
|
# pnpm based linking
|
||||||
|
/.links.cjs
|
||||||
|
/.links.disabled.cjs
|
||||||
|
/.links.temp-disabled.cjs
|
||||||
|
|
||||||
|
# Playwright
|
||||||
|
/test-results/
|
||||||
|
/playwright-report/
|
||||||
|
/blob-report/
|
||||||
|
/playwright/.cache/
|
||||||
|
|
||||||
|
*storybook.log
|
||||||
|
storybook-static
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
# GitLab-CI fuer den threadnet-call-Fork (Lab-GitLab; siehe docs/axion1337-fork.md).
|
||||||
|
# Ersetzt die geerbten, hier nie lauffaehigen Upstream-Workflows (threadnet-call#1).
|
||||||
|
# Trigger-Schema wie ThreadNet-Web: Pushes pruefen nur bei relevanten Pfaden,
|
||||||
|
# Veroeffentlichen ist ein bewusster manueller Akt.
|
||||||
|
|
||||||
|
stages:
|
||||||
|
- build
|
||||||
|
- publish
|
||||||
|
|
||||||
|
build_embedded:
|
||||||
|
stage: build
|
||||||
|
image: node:24-bullseye
|
||||||
|
rules:
|
||||||
|
- if: $CI_COMMIT_TAG =~ /^v/
|
||||||
|
- if: $CI_COMMIT_BRANCH
|
||||||
|
changes:
|
||||||
|
- src/**/*
|
||||||
|
- embedded/**/*
|
||||||
|
- public/**/*
|
||||||
|
- package.json
|
||||||
|
- pnpm-lock.yaml
|
||||||
|
- vite*.config.*
|
||||||
|
- .gitlab-ci.yml
|
||||||
|
before_script:
|
||||||
|
- corepack enable
|
||||||
|
script:
|
||||||
|
- pnpm install --frozen-lockfile
|
||||||
|
# baut mit der media_quality-Konfiguration aus vite-embedded.config.ts
|
||||||
|
# (1440p-Defaults, h264 - siehe docs/axion1337-fork.md)
|
||||||
|
- pnpm build:embedded
|
||||||
|
artifacts:
|
||||||
|
paths:
|
||||||
|
- embedded/web/dist
|
||||||
|
expire_in: 1 week
|
||||||
|
|
||||||
|
# Publisht das Embedded-Package in die Gitea-npm-Registry auf rohana - dort MUSS es
|
||||||
|
# bleiben, solange ThreadNet-Webs pnpm-lock.yaml die Tarball-URL darauf pinnt
|
||||||
|
# (Konsument: apps/web-Dependency @sorb/threadnet-call-embedded).
|
||||||
|
# Versionierung: package.json-Version in embedded/web VOR dem Publish per Commit bumpen.
|
||||||
|
# Auth: CI-Variable GITEA_NPM_TOKEN (Gitea-Token, Scope write:package) - ersetzt die
|
||||||
|
# fruehere lokale, untracked .npmrc mit Klartext-Token (Rotationsliste CFGMON-11).
|
||||||
|
publish_npm:
|
||||||
|
stage: publish
|
||||||
|
image: node:24-bullseye
|
||||||
|
needs:
|
||||||
|
- job: build_embedded
|
||||||
|
artifacts: true
|
||||||
|
rules:
|
||||||
|
- if: $CI_COMMIT_TAG =~ /^v/
|
||||||
|
when: manual
|
||||||
|
allow_failure: true
|
||||||
|
- if: $CI_COMMIT_BRANCH == "main"
|
||||||
|
when: manual
|
||||||
|
allow_failure: true
|
||||||
|
script:
|
||||||
|
- test -n "$GITEA_NPM_TOKEN" || { echo "CI-Variable GITEA_NPM_TOKEN fehlt (Gitea-Token mit write:package)"; exit 1; }
|
||||||
|
- |
|
||||||
|
cat > embedded/web/.npmrc <<EOF
|
||||||
|
@sorb:registry=https://rohana.axion1337.de/api/packages/sorb/npm/
|
||||||
|
//rohana.axion1337.de/api/packages/sorb/npm/:_authToken=${GITEA_NPM_TOKEN}
|
||||||
|
EOF
|
||||||
|
- cd embedded/web
|
||||||
|
- npm publish --access public
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
24
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"plugins": {
|
||||||
|
"postcss-preset-env": {
|
||||||
|
"stage": 3,
|
||||||
|
"browsers": "last 2 versions"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
pnpm-lock.yaml
|
||||||
|
node_modules
|
||||||
|
dist
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2026 Element Creations Ltd.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
||||||
|
Please see LICENSE in the repository root for full details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { StorybookConfig } from "@storybook/react-vite";
|
||||||
|
|
||||||
|
const config: StorybookConfig = {
|
||||||
|
stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
|
||||||
|
addons: ["@storybook/addon-docs", "@storybook/addon-vitest"],
|
||||||
|
framework: "@storybook/react-vite",
|
||||||
|
// THIS IS IMPORTANT
|
||||||
|
// vitest runs without Vite's normal dependency optimization, so we need to manually include the polyfills for the stories to work.
|
||||||
|
// otherwise we will get: new dependencies optimized: ...
|
||||||
|
// and
|
||||||
|
// ```
|
||||||
|
// [vitest] Vite unexpectedly reloaded a test. This may cause tests to fail, lead to flaky behaviour or duplicated test runs.
|
||||||
|
// For a stable experience, please add mentioned dependencies to your config's `optimizeDeps.include` field manually.
|
||||||
|
// ```
|
||||||
|
// which breaks the storybook ci on the first and only run.
|
||||||
|
viteFinal(config) {
|
||||||
|
config.optimizeDeps = {
|
||||||
|
...config.optimizeDeps,
|
||||||
|
include: [
|
||||||
|
...(config.optimizeDeps?.include ?? []),
|
||||||
|
"vite-plugin-node-polyfills/shims/buffer",
|
||||||
|
"vite-plugin-node-polyfills/shims/global",
|
||||||
|
"vite-plugin-node-polyfills/shims/process",
|
||||||
|
],
|
||||||
|
};
|
||||||
|
return config;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
export default config;
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2026 Element Creations Ltd.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
||||||
|
Please see LICENSE in the repository root for full details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { create } from "storybook/theming";
|
||||||
|
import { addons } from "storybook/manager-api";
|
||||||
|
|
||||||
|
addons.setConfig({
|
||||||
|
theme: create({
|
||||||
|
base: "light",
|
||||||
|
colorPrimary: "#1b1d22",
|
||||||
|
colorSecondary: "#0467dd",
|
||||||
|
|
||||||
|
// Typography
|
||||||
|
fontBase: '"Inter", sans-serif',
|
||||||
|
fontCode: '"Inconsolata", monospace',
|
||||||
|
|
||||||
|
// Text colors
|
||||||
|
textColor: "#1b1d22",
|
||||||
|
appBg: "#ffffff",
|
||||||
|
barBg: "#ffffff",
|
||||||
|
|
||||||
|
brandTitle: "Element Call",
|
||||||
|
brandUrl: "https://element.io/",
|
||||||
|
brandImage: "/src/icons/Logo.svg",
|
||||||
|
brandTarget: "_self",
|
||||||
|
}),
|
||||||
|
});
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2026 Element Creations Ltd.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
||||||
|
Please see LICENSE in the repository root for full details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { Preview } from "@storybook/react-vite";
|
||||||
|
import { TooltipProvider } from "@vector-im/compound-web";
|
||||||
|
import i18n from "i18next";
|
||||||
|
import { logger } from "matrix-js-sdk/lib/logger";
|
||||||
|
|
||||||
|
import EN from "../locales/en/app.json";
|
||||||
|
import { initReactI18next } from "react-i18next";
|
||||||
|
import "../src/index.css";
|
||||||
|
|
||||||
|
// Bare-minimum i18n config
|
||||||
|
i18n
|
||||||
|
.use(initReactI18next)
|
||||||
|
.init({
|
||||||
|
lng: "en",
|
||||||
|
fallbackLng: "en",
|
||||||
|
supportedLngs: ["en"],
|
||||||
|
// We embed the translations, so that it never needs to fetch
|
||||||
|
resources: {
|
||||||
|
en: {
|
||||||
|
translation: EN,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
interpolation: {
|
||||||
|
escapeValue: false, // React has built-in XSS protections
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.catch((e) => logger.warn("Failed to init i18n for stories", e));
|
||||||
|
|
||||||
|
const preview: Preview = {
|
||||||
|
parameters: {
|
||||||
|
layout: "centered",
|
||||||
|
controls: {
|
||||||
|
matchers: {
|
||||||
|
color: /(background|color)$/i,
|
||||||
|
date: /Date$/i,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
tags: ["autodocs"],
|
||||||
|
decorators: [
|
||||||
|
(Story) => (
|
||||||
|
<TooltipProvider>
|
||||||
|
<Story />
|
||||||
|
</TooltipProvider>
|
||||||
|
),
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
export default preview;
|
||||||
Vendored
+22
@@ -0,0 +1,22 @@
|
|||||||
|
{
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||||
|
"editor.insertSpaces": true,
|
||||||
|
"editor.tabSize": 2,
|
||||||
|
"[typescriptreact]": {
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||||
|
},
|
||||||
|
"[javascriptreact]": {
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||||
|
},
|
||||||
|
"[typescript]": {
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||||
|
},
|
||||||
|
"[javascript]": {
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
# Contributing code to Element
|
||||||
|
|
||||||
|
Element follows the same pattern as the [matrix-js-sdk](https://github.com/matrix-org/matrix-js-sdk/blob/develop/CONTRIBUTING.md).
|
||||||
|
|
||||||
|
# Contributing to Element Call
|
||||||
|
|
||||||
|
Element Call is a native Matrix video conferencing application built on
|
||||||
|
[MatrixRTC (MSC4143)](https://github.com/matrix-org/matrix-spec-proposals/pull/4143)
|
||||||
|
and [LiveKit](https://livekit.io/). It runs in multiple deployment contexts — as a
|
||||||
|
standalone web app and as a widget embedded in Element Web, Element X iOS, and
|
||||||
|
Element X Android. It is also the primary R&D foundation for MatrixRTC, which means
|
||||||
|
its architecture, maintainability, and flexibility are held to a high standard.
|
||||||
|
|
||||||
|
We welcome contributions from the community. This document explains how to
|
||||||
|
contribute effectively so that both you and the maintainers get the best outcome.
|
||||||
|
|
||||||
|
## Issue First Policy
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> Before writing a single line of code for a new feature or UI change, you **must**
|
||||||
|
> open an issue and have the approach agreed with the maintainers.
|
||||||
|
>
|
||||||
|
> **We will not review or merge feature or UI pull requests that arrive without a
|
||||||
|
> corresponding, pre-approved issue.**
|
||||||
|
|
||||||
|
This is not gatekeeping — it's how we prevent wasted effort on both sides. Element
|
||||||
|
Call must work correctly across multiple deployment contexts and meet specific product
|
||||||
|
and design requirements. It is also a fast-moving codebase that underpins ongoing
|
||||||
|
MatrixRTC development. A PR that looks reasonable in isolation can easily conflict
|
||||||
|
with in-progress work, planned architecture changes, or design decisions that haven't
|
||||||
|
been publicly documented yet.
|
||||||
|
|
||||||
|
The issue is where we resolve all of that **before** anyone writes code.
|
||||||
|
|
||||||
|
**Bug fixes** are no exception — most confirmed bugs should already have an issue anyways, existing issues that are marked as bugs have an implicit maintainer approval. If the solution for the bug is controversial it is highly recommended to discuss the approach in the issue before opening a PR.
|
||||||
|
|
||||||
|
## Contribution Workflow
|
||||||
|
|
||||||
|
1. **Open an issue** using the [Enhancement request](https://github.com/element-hq/element-call/issues/new?template=enhancement.yml) template.
|
||||||
|
2. **Wait for feedback.** A maintainer will comment on the issue **within two weeks**. The use case and approach will get dicussed.
|
||||||
|
This may involve questions, suggestions, or a request to adjust scope.
|
||||||
|
This also allows to bring design and product into the loop before code gets created.
|
||||||
|
3. **Get a green light.** Wait for explicit approval from a maintainer before starting
|
||||||
|
implementation.
|
||||||
|
4. **Implement.** Write the code against the agreed approach.
|
||||||
|
5. **Open a PR.** Link to the issue in your PR description and satisfy the checklist
|
||||||
|
in the PR template.
|
||||||
|
|
||||||
|
## Code Quality
|
||||||
|
|
||||||
|
Element Call moves fast and the codebase must stay clean and maintainable.
|
||||||
|
|
||||||
|
- **Take responsibility for AI-generated code.** AI tools can be a useful aid, but we expect all the generated code to be understood and reasoned about by the contributor. Questions by the maintainers should be answered without just forwarding them to AI. The maintainers also have access to AI tools. If your contribution is just transporting messages between LLM <-> maintaines all our time is better used if the maintainers decide to interact with AI for this specific problem by themselves.
|
||||||
|
- **Think across deployment contexts.** Changes must work correctly in both standalone
|
||||||
|
and widget modes. Consider how your change interacts with Element Web, Element X
|
||||||
|
iOS, and Element X Android.
|
||||||
|
- **Write tests.** New functionality should be covered by tests. Where it is feasible,
|
||||||
|
existing uncovered code touched by your PR should also gain tests.
|
||||||
|
|
||||||
|
## Contributor License Agreement
|
||||||
|
|
||||||
|
All contributors must sign the
|
||||||
|
[Element Contributor License Agreement](https://cla-assistant.io/element-hq/element-call)
|
||||||
|
before their contribution can be merged. The CLA assistant bot will prompt you
|
||||||
|
automatically when you open a PR.
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
The best place to ask questions about Element Call development is the MatrixRTC room:
|
||||||
|
|
||||||
|
**[#matrixRtc:matrix.org](https://matrix.to/#/#matrixrtc:matrix.org)**
|
||||||
+13
@@ -0,0 +1,13 @@
|
|||||||
|
FROM alpine AS builder
|
||||||
|
|
||||||
|
COPY ./dist /dist
|
||||||
|
|
||||||
|
# Compress assets to work with nginx-gzip-static-module
|
||||||
|
WORKDIR /dist/assets
|
||||||
|
RUN gzip -k ../index.html *.js *.map *.css *.wasm *-app-*.json
|
||||||
|
|
||||||
|
FROM nginxinc/nginx-unprivileged:alpine-slim
|
||||||
|
|
||||||
|
COPY --from=builder ./dist /app
|
||||||
|
|
||||||
|
COPY config/nginx.conf /etc/nginx/conf.d/default.conf
|
||||||
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
Licensees holding a valid commercial license with Element may use this
|
||||||
|
software in accordance with the terms contained in a written agreement
|
||||||
|
between you and Element.
|
||||||
|
|
||||||
|
To purchase a commercial license please contact our sales team at
|
||||||
|
licensing@element.io
|
||||||
@@ -0,0 +1,386 @@
|
|||||||
|
# Element Call
|
||||||
|
|
||||||
|
> **threadnet-call**: this is a fork of Element Call (based on `emmick4/element-call`'s
|
||||||
|
> `livekit` branch), customized for the self-hosted
|
||||||
|
> [axion1337.chat](https://axion1337.chat) Matrix homeserver. See
|
||||||
|
> [docs/axion1337-fork.md](docs/axion1337-fork.md) for everything this fork changes versus
|
||||||
|
> upstream (media_quality defaults, the VP9 incident, npm publish process). The rest of this
|
||||||
|
> README describes upstream Element Call and is intentionally left as-is.
|
||||||
|
|
||||||
|
[](https://matrix.to/#/#webrtc:matrix.org)
|
||||||
|
[](https://localazy.com/p/element-call)
|
||||||
|
[](LICENSE-AGPL-3.0)
|
||||||
|
[](https://app.codecov.io/gh/element-hq/element-call)
|
||||||
|
|
||||||
|
[🎬 Live Demo 🎬](https://call.element.io)
|
||||||
|
|
||||||
|
The world's first 🌐 decentralized and 🤝 federated video conferencing solution
|
||||||
|
powered by **the Matrix protocol**.
|
||||||
|
|
||||||
|
## 📌 Overview
|
||||||
|
|
||||||
|
**Element Call** is a native Matrix video conferencing application developed by
|
||||||
|
[Element](https://element.io/), designed for **secure**, **scalable**,
|
||||||
|
**privacy-respecting**, and **decentralized** video and voice calls over the
|
||||||
|
Matrix protocol. Built on **MatrixRTC**
|
||||||
|
([MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143)), it
|
||||||
|
utilizes
|
||||||
|
**[MSC4195](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md)**
|
||||||
|
with **[LiveKit](https://livekit.io/)** as its backend.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
You can find the latest development version continuously deployed to
|
||||||
|
[call.element.dev](https://call.element.dev/).
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> 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)
|
||||||
|
> branch.
|
||||||
|
|
||||||
|
## ✨ Key Features
|
||||||
|
|
||||||
|
✅ **Decentralized & Federated** – No central authority; works across Matrix
|
||||||
|
homeservers.
|
||||||
|
✅ **End-to-End Encrypted** – Secure and private calls.
|
||||||
|
✅ **Standalone & Widget Mode** – Use as an independent app or embed in Matrix
|
||||||
|
clients.
|
||||||
|
✅ **WebRTC-based** – No additional software required.
|
||||||
|
✅ **Scalable with LiveKit** – Supports large meetings via SFU
|
||||||
|
([MSC4195: MatrixRTC using LiveKit backend](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md)).
|
||||||
|
✅ **Raise Hand** – Participants can signal when they want to speak, helping to
|
||||||
|
organize the flow of the meeting.
|
||||||
|
✅ **Emoji Reactions** – Users can react with emojis 👍️ 🎉 👏 🤘, adding
|
||||||
|
engagement and interactivity to the conversation.
|
||||||
|
|
||||||
|
## 🚀 Deployment & Packaging Options
|
||||||
|
|
||||||
|
Element Call is developed using the
|
||||||
|
[Matrix js-sdk](https://github.com/matrix-org/matrix-js-sdk) with Matroska mode.
|
||||||
|
This allows the app to run either as a Standalone App directly connected to a
|
||||||
|
homeserver with login interfaces or it can be used as a widget within a Matrix
|
||||||
|
client.
|
||||||
|
|
||||||
|
### 🖥️ Standalone Mode
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="./docs/element_call_standalone.drawio.png" alt="Element Call in Standalone Mode">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
In Standalone mode, Element Call operates as an independent, full-featured video
|
||||||
|
conferencing web application, enabling users to join or host calls without
|
||||||
|
requiring a separate Matrix client.
|
||||||
|
|
||||||
|
### 📲 In-App Calling (Widget Mode in Messenger Apps)
|
||||||
|
|
||||||
|
When used as a widget 🧩, Element Call is solely responsible for the core calling
|
||||||
|
functionality (MatrixRTC). Authentication, event handling, and room state
|
||||||
|
updates (via the Client-Server API) are handled by the hosting client.
|
||||||
|
Communication between Element Call and the client is managed through the widget
|
||||||
|
API.
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="./docs/element_call_widget.drawio.png" alt="Element Call in Widget Mode">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
Element Call can be embedded as a widget inside apps like
|
||||||
|
[**Element Web**](https://github.com/element-hq/element-web) or **Element X
|
||||||
|
([iOS](https://github.com/element-hq/element-x-ios),
|
||||||
|
[Android](https://github.com/element-hq/element-x-android))**, bringing
|
||||||
|
**MatrixRTC** capabilities to messenger apps for seamless decentralized video
|
||||||
|
and voice calls within Matrix rooms.
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> Embedded packaging is recommended for Element Call in widget mode!
|
||||||
|
|
||||||
|
### 📦 Element Call Packaging
|
||||||
|
|
||||||
|
Element Call offers two packaging options: one for standalone or widget
|
||||||
|
deployment, and another for seamless widget-based integration into messenger
|
||||||
|
apps. Below is an overview of each option.
|
||||||
|
|
||||||
|
**Full Package** – Supports both **Standalone** and **Widget** mode. It is
|
||||||
|
hosted as a static web page and can be accessed via a URL when used as a widget.
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="./docs/full_package.drawio.png" alt="Element Call Full Package">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
**Embedded Package** – Designed specifically for **Widget mode** only. It is
|
||||||
|
bundled with a messenger app for seamless integration and this is the
|
||||||
|
recommended method for embedding Element Call.
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="./docs/embedded_package.drawio.png" alt="Element Call Embedded Package">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
For more details on the packages, see the
|
||||||
|
[Embedded vs. Standalone Guide](./docs/embedded_standalone.md).
|
||||||
|
|
||||||
|
## 🛠️ Self-Hosting
|
||||||
|
|
||||||
|
For operating and deploying Element Call on your own server, refer to the
|
||||||
|
[**Self-Hosting Guide**](./docs/self_hosting.md).
|
||||||
|
|
||||||
|
## 🧭 MatrixRTC Backend Discovery and Selection
|
||||||
|
|
||||||
|
For proper Element Call operation each site deployment needs a MatrixRTC backend
|
||||||
|
setup as outlined in the [Self-Hosting Guide](./docs/self_hosting.md). A typical
|
||||||
|
federated site deployment for three different sites A, B and C is depicted below.
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="./docs/Federated_Setup.drawio.png" alt="Element Call federated setup">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
### Backend Discovery
|
||||||
|
|
||||||
|
The MatrixRTC backend (according to
|
||||||
|
[MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143)) is
|
||||||
|
announced by the Matrix site's `.well-known/matrix/client` file and discovered
|
||||||
|
via the `org.matrix.msc4143.rtc_foci` key, e.g.:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"org.matrix.msc4143.rtc_foci": [
|
||||||
|
{
|
||||||
|
"type": "livekit",
|
||||||
|
"livekit_service_url": "https://matrix-rtc.example.com/livekit/jwt"
|
||||||
|
},
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
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).
|
||||||
|
In the example above Matrix clients do discover a focus of type `livekit` which
|
||||||
|
points them to a [MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
|
||||||
|
via `livekit_service_url`.
|
||||||
|
|
||||||
|
### Backend Selection
|
||||||
|
|
||||||
|
- Each call participant proposes their discovered MatrixRTC backend from
|
||||||
|
`org.matrix.msc4143.rtc_foci` in their `org.matrix.msc3401.call.member` state event.
|
||||||
|
- For the **LiveKit** MatrixRTC backend
|
||||||
|
([MSC4195](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md)),
|
||||||
|
the **first participant who joined the call** defines which backend will be used for this call via
|
||||||
|
the `foci_preferred` key in their `org.matrix.msc3401.call.member` state event.
|
||||||
|
- During the actual call join flow, the **[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)**
|
||||||
|
provides the client with the **LiveKit SFU WebSocket URL** and an
|
||||||
|
**access JWT token** in order to exchange media via WebRTC.
|
||||||
|
|
||||||
|
The example below illustrates how backend selection works across **Matrix
|
||||||
|
federation**, using the setup from sites A, B, and C. It demonstrates backend
|
||||||
|
selection for **Matrix rooms 123 and 456**, which include users from different
|
||||||
|
homeservers.
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="./docs/SFU_selection.drawio.png" alt="Element Call SFU selection over Matrix federation">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## 🌍 Translation
|
||||||
|
|
||||||
|
If you'd like to help translate Element Call, head over to
|
||||||
|
[Localazy](https://localazy.com/p/element-call). You're also encouraged to join
|
||||||
|
the [Element Translators](https://matrix.to/#/#translators:element.io) space to
|
||||||
|
discuss and coordinate translation efforts.
|
||||||
|
|
||||||
|
## 🛠️ Development
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
- Node.js (e.g. via [nvm](https://github.com/nvm-sh/nvm))
|
||||||
|
- [Corepack](https://github.com/nodejs/corepack) (not bundled with Node.js anymore starting from 25.0.0)
|
||||||
|
- Docker client and runtime + Docker Compose (for the backend)
|
||||||
|
- On macOS you can install everything with `brew install colima docker docker-compose`
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
|
||||||
|
To get started clone and set up this project:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/element-hq/element-call.git
|
||||||
|
cd element-call
|
||||||
|
corepack enable
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
To use it, create a local config by, e.g.,
|
||||||
|
`cp ./config/config.devenv.json ./public/config.json` and adapt it if necessary.
|
||||||
|
The `config.devenv.json` config should work with the backend development
|
||||||
|
environment as outlined in the next section out of box.
|
||||||
|
|
||||||
|
You're now ready to launch the development server:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
|
See also:
|
||||||
|
|
||||||
|
- [Developing with linked packages](./docs/linking.md)
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
|
||||||
|
A docker compose file `dev-backend-docker-compose.yml` is provided to start the
|
||||||
|
whole stack of components which is required for a local development environment
|
||||||
|
including federation:
|
||||||
|
|
||||||
|
- Minimum Synapse Setup (servernames: `synapse.m.localhost`, `synapse.othersite.m.localhost`)
|
||||||
|
- MatrixRTC Authorization Service (Note: requires Federation API and hence a TLS reverse proxy)
|
||||||
|
- Minimum LiveKit SFU setup using dev defaults for config
|
||||||
|
- Minimum `localhost` Certificate Authority (CA) for Transport Layer Security (TLS)
|
||||||
|
- Hostnames: `m.localhost`, `*.m.localhost`, `*.othersite.m.localhost`
|
||||||
|
- Add [./backend/dev_tls_local-ca.crt](./backend/dev_tls_local-ca.crt) to your web browser's trusted
|
||||||
|
certificates
|
||||||
|
- Minimum TLS reverse proxy for
|
||||||
|
- Synapse homeserver: `synapse.m.localhost` and `synapse.othersite.m.localhost`
|
||||||
|
- MatrixRTC backend: `matrix-rtc.m.localhost` and `matrix-rtc.othersite.m.localhost`
|
||||||
|
- Local Element Call development `call.m.localhost` via `pnpm dev --host `
|
||||||
|
- Element Web `app.m.localhost` and `app.othersite.m.localhost`
|
||||||
|
- Note certificates will expire on Thr, 20 September 2035 14:27:35 CEST
|
||||||
|
|
||||||
|
These use a test 'secret' published in this repository, so this must be used
|
||||||
|
only for local development and **_never be exposed to the public Internet._**
|
||||||
|
|
||||||
|
Make sure your Docker runtime is running (e.g. via `colima start`) and then start
|
||||||
|
the backend components:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pnpm backend
|
||||||
|
# or for podman-compose:
|
||||||
|
# podman-compose -f dev-backend-docker-compose.yml up
|
||||||
|
```
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> To ensure your local development frontend functions properly, you’ll need to
|
||||||
|
> add certificate exceptions in your browser for `https://localhost:3000`,
|
||||||
|
> `https://matrix-rtc.m.localhost/livekit/jwt/healthz` and
|
||||||
|
> `https://synapse.m.localhost/.well-known/matrix/client`. This can be either
|
||||||
|
> done by adding the minimum localhost CA
|
||||||
|
> ([./backend/dev_tls_local-ca.crt](./backend/dev_tls_local-ca.crt)) to your web
|
||||||
|
> browser's trusted certificates or by simply copying and pasting each URL into
|
||||||
|
> your browser’s address bar and follow the prompts to add the exception.
|
||||||
|
|
||||||
|
### Updating snapshots
|
||||||
|
|
||||||
|
To update snapshots used in tests, use Vitest's `-u` flag, e.g.:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pnpm test DeveloperSettingsTab -u
|
||||||
|
```
|
||||||
|
|
||||||
|
### Playwright tests
|
||||||
|
|
||||||
|
Our Playwright tests run automatically as part of our CI along with our other
|
||||||
|
tests, on every pull request.
|
||||||
|
|
||||||
|
You may need to follow instructions to set up your development environment for
|
||||||
|
running Playwright by following
|
||||||
|
<https://playwright.dev/docs/browsers#install-browsers> and
|
||||||
|
<https://playwright.dev/docs/browsers#install-system-dependencies>.
|
||||||
|
|
||||||
|
However the Playwright tests are run, an element-call instance must be running
|
||||||
|
on https://localhost:3000 (this is configured in `playwright.config.ts`) - this
|
||||||
|
is what will be tested.
|
||||||
|
|
||||||
|
The local backend environment should be running for the test to work:
|
||||||
|
`pnpm backend`
|
||||||
|
|
||||||
|
There are a few different ways to run the tests yourself. The simplest is to
|
||||||
|
run:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pnpm run test:playwright
|
||||||
|
```
|
||||||
|
|
||||||
|
This will run the Playwright tests once, non-interactively.
|
||||||
|
|
||||||
|
There is a more user-friendly way to run the tests in interactive mode:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pnpm run test:playwright:open
|
||||||
|
```
|
||||||
|
|
||||||
|
The easiest way to develop new test is to use the codegen feature of Playwright:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
npx playwright codegen
|
||||||
|
```
|
||||||
|
|
||||||
|
This will record your action and write the test code for you. Use the tool bar
|
||||||
|
to test visibility, text content and clicking.
|
||||||
|
|
||||||
|
##### Investigate a failed test from the CI
|
||||||
|
|
||||||
|
In the failed action page, click on the failed job, then scroll down to the
|
||||||
|
`upload-artifact` step. You will find a link to download the zip report, as per:
|
||||||
|
|
||||||
|
```
|
||||||
|
Artifact playwright-report has been successfully uploaded! Final size is 1360358 bytes. Artifact ID is 2746265841
|
||||||
|
Artifact download URL: https://github.com/element-hq/element-call/actions/runs/13837660687/artifacts/2746265841
|
||||||
|
```
|
||||||
|
|
||||||
|
Unzip the report then use this command to open the report in your browser:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
npx playwright show-report ~/Downloads/playwright-report/
|
||||||
|
```
|
||||||
|
|
||||||
|
Under the failed test there is a small icon looking like "3 columns" (next to
|
||||||
|
the test name file name), click on it to see the live screenshots/console
|
||||||
|
output.
|
||||||
|
|
||||||
|
### Test Coverage
|
||||||
|
|
||||||
|
<img src="https://codecov.io/github/element-hq/element-call/graphs/tree.svg?token=O6CFVKK6I1"></img>
|
||||||
|
|
||||||
|
### Add a new translation key
|
||||||
|
|
||||||
|
To add a new translation key you can do these steps:
|
||||||
|
|
||||||
|
1. Add the new key entry to the code where the new key is used:
|
||||||
|
`t("some_new_key")`
|
||||||
|
1. Run `pnpm i18n` to extract the new key and update the translation files. This
|
||||||
|
will add a skeleton entry to the `locales/en/app.json` file:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
...
|
||||||
|
"some_new_key": "",
|
||||||
|
...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Update the skeleton entry in the `locales/en/app.json` file with the English
|
||||||
|
translation:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
...
|
||||||
|
"some_new_key": "Some new key",
|
||||||
|
...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📖 Documentation
|
||||||
|
|
||||||
|
Usage and other technical details about the project can be found here:
|
||||||
|
|
||||||
|
[**Docs**](./docs/README.md)
|
||||||
|
|
||||||
|
## 📝 Copyright & License
|
||||||
|
|
||||||
|
Copyright 2021-2025 New Vector Ltd
|
||||||
|
|
||||||
|
This software is dual-licensed by New Vector Ltd (Element). It can be used
|
||||||
|
either:
|
||||||
|
|
||||||
|
(1) for free under the terms of the GNU Affero General Public License (as
|
||||||
|
published by the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version); OR
|
||||||
|
|
||||||
|
(2) under the terms of a paid-for Element Commercial License agreement between
|
||||||
|
you and Element (the terms of which may vary depending on what you and Element
|
||||||
|
have agreed to). Unless required by applicable law or agreed to in writing,
|
||||||
|
software distributed under the Licenses is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
Licenses for the specific language governing permissions and limitations under
|
||||||
|
the Licenses.
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# Testing Element-Call in widget mode
|
||||||
|
|
||||||
|
When running `pnpm backend` the latest element-web develop will be deployed and served on `http://localhost:8081`.
|
||||||
|
In a development environment, you might prefer to just use the `element-web` repo directly, but this setup is useful for CI/CD testing.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
The element-web configuration is modified to:
|
||||||
|
|
||||||
|
- Enable to use the local widget instance (`element_call.url` https://localhost:3000).
|
||||||
|
- Enable the labs features (`feature_group_calls`, `feature_element_call_video_rooms`).
|
||||||
|
|
||||||
|
The default configuration used by docker-compose is in `test-container/config.json`. There is a fixture for playwright
|
||||||
|
that uses
|
||||||
|
|
||||||
|
## Running the element-web instance
|
||||||
|
|
||||||
|
It is part of the existing backend setup. To start the backend, run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pnpm backend
|
||||||
|
```
|
||||||
|
|
||||||
|
Then open `http://localhost:8081` in your browser.
|
||||||
|
|
||||||
|
## Basic fixture
|
||||||
|
|
||||||
|
A base fixture is provided in `/playwright/fixtures/widget-user.ts` that will register two users that shares a room.
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
module.exports = {
|
||||||
|
presets: [
|
||||||
|
[
|
||||||
|
"@babel/preset-env",
|
||||||
|
{
|
||||||
|
targets: {
|
||||||
|
node: "current",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"@babel/preset-react",
|
||||||
|
{
|
||||||
|
runtime: "automatic",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"@babel/preset-typescript",
|
||||||
|
],
|
||||||
|
plugins: ["babel-plugin-transform-vite-meta-env"],
|
||||||
|
};
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
server_name: "synapse.othersite.m.localhost"
|
||||||
|
public_baseurl: https://synapse.othersite.m.localhost/
|
||||||
|
|
||||||
|
pid_file: /data/homeserver.pid
|
||||||
|
|
||||||
|
listeners:
|
||||||
|
- port: 18008
|
||||||
|
tls: false
|
||||||
|
type: http
|
||||||
|
x_forwarded: true
|
||||||
|
resources:
|
||||||
|
- names: [client, federation, openid]
|
||||||
|
compress: false
|
||||||
|
|
||||||
|
database:
|
||||||
|
name: sqlite3
|
||||||
|
args:
|
||||||
|
database: /data/homeserver.db
|
||||||
|
|
||||||
|
media_store_path: /data/media_store
|
||||||
|
signing_key_path: "/data/SERVERNAME.signing.key"
|
||||||
|
|
||||||
|
# Due to custom TLS certificate with domains
|
||||||
|
# - m.localhost, localhost
|
||||||
|
# - *.m.localhost
|
||||||
|
# - *.othersite.m.localhost
|
||||||
|
# we disable certificate verification to allow for federation
|
||||||
|
# WARNING: DO NOT USE IN PRODUCTION!!!
|
||||||
|
federation_verify_certificates: false
|
||||||
|
ip_range_blacklist: []
|
||||||
|
trusted_key_servers:
|
||||||
|
- server_name: "synapse.m.localhost"
|
||||||
|
accept_keys_insecurely: true
|
||||||
|
|
||||||
|
experimental_features:
|
||||||
|
# MSC3266: Room summary API. Used for knocking over federation
|
||||||
|
msc3266_enabled: true
|
||||||
|
# MSC4222 needed for syncv2 state_after. This allow clients to
|
||||||
|
# correctly track the state of the room.
|
||||||
|
msc4222_enabled: true
|
||||||
|
# sticky events for MatrixRTC user state
|
||||||
|
msc4354_enabled: true
|
||||||
|
|
||||||
|
# The maximum allowed duration by which sent events can be delayed, as
|
||||||
|
# per MSC4140. Must be a positive value if set. Defaults to no
|
||||||
|
# duration (null), which disallows sending delayed events.
|
||||||
|
max_event_delay_duration: 24h
|
||||||
|
|
||||||
|
# Required for Element Call in Single Page Mode due to on-the-fly user registration
|
||||||
|
enable_registration: true
|
||||||
|
enable_registration_without_verification: true
|
||||||
|
|
||||||
|
# Shared secret for admin user registration via API (for testing only!)
|
||||||
|
registration_shared_secret: "test_shared_secret_for_local_dev_only"
|
||||||
|
|
||||||
|
report_stats: false
|
||||||
|
serve_server_wellknown: true
|
||||||
|
|
||||||
|
# Ratelimiting settings for client actions (registration, login, messaging).
|
||||||
|
#
|
||||||
|
# Each ratelimiting configuration is made of two parameters:
|
||||||
|
# - per_second: number of requests a client can send per second.
|
||||||
|
# - burst_count: number of requests a client can send before being throttled.
|
||||||
|
|
||||||
|
rc_message:
|
||||||
|
# This needs to match at least the heart-beat frequency plus a bit of headroom
|
||||||
|
# Currently the heart-beat is every 5 seconds which translates into a rate of 0.2s
|
||||||
|
per_second: 0.5
|
||||||
|
burst_count: 30
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
server_name: "synapse.m.localhost"
|
||||||
|
public_baseurl: https://synapse.m.localhost/
|
||||||
|
|
||||||
|
pid_file: /data/homeserver.pid
|
||||||
|
|
||||||
|
listeners:
|
||||||
|
- port: 8008
|
||||||
|
tls: false
|
||||||
|
type: http
|
||||||
|
x_forwarded: true
|
||||||
|
resources:
|
||||||
|
- names: [client, federation, openid]
|
||||||
|
compress: false
|
||||||
|
|
||||||
|
database:
|
||||||
|
name: sqlite3
|
||||||
|
args:
|
||||||
|
database: /data/homeserver.db
|
||||||
|
|
||||||
|
media_store_path: /data/media_store
|
||||||
|
signing_key_path: "/data/SERVERNAME.signing.key"
|
||||||
|
|
||||||
|
# Due to custom TLS certificate with domains
|
||||||
|
# - m.localhost, localhost
|
||||||
|
# - *.m.localhost
|
||||||
|
# - *.othersite.m.localhost
|
||||||
|
# we disable certificate verification to allow for federation.
|
||||||
|
# WARNING: DO NOT USE IN PRODUCTION!!!
|
||||||
|
federation_verify_certificates: false
|
||||||
|
ip_range_blacklist: []
|
||||||
|
trusted_key_servers:
|
||||||
|
- server_name: "synapse.othersite.m.localhost"
|
||||||
|
accept_keys_insecurely: true
|
||||||
|
|
||||||
|
experimental_features:
|
||||||
|
# MSC3266: Room summary API. Used for knocking over federation
|
||||||
|
msc3266_enabled: true
|
||||||
|
# MSC4222 needed for syncv2 state_after. This allow clients to
|
||||||
|
# correctly track the state of the room.
|
||||||
|
msc4222_enabled: true
|
||||||
|
# sticky events for MatrixRTC user state
|
||||||
|
msc4354_enabled: true
|
||||||
|
|
||||||
|
# The maximum allowed duration by which sent events can be delayed, as
|
||||||
|
# per MSC4140. Must be a positive value if set. Defaults to no
|
||||||
|
# duration (null), which disallows sending delayed events.
|
||||||
|
max_event_delay_duration: 24h
|
||||||
|
|
||||||
|
# Required for Element Call in Single Page Mode due to on-the-fly user registration
|
||||||
|
enable_registration: true
|
||||||
|
enable_registration_without_verification: true
|
||||||
|
|
||||||
|
# Shared secret for admin user registration via API (for testing only!)
|
||||||
|
registration_shared_secret: "test_shared_secret_for_local_dev_only"
|
||||||
|
|
||||||
|
report_stats: false
|
||||||
|
serve_server_wellknown: true
|
||||||
|
|
||||||
|
# Ratelimiting settings for client actions (registration, login, messaging).
|
||||||
|
#
|
||||||
|
# Each ratelimiting configuration is made of two parameters:
|
||||||
|
# - per_second: number of requests a client can send per second.
|
||||||
|
# - burst_count: number of requests a client can send before being throttled.
|
||||||
|
|
||||||
|
rc_message:
|
||||||
|
# This needs to match at least the heart-beat frequency plus a bit of headroom
|
||||||
|
# Currently the heart-beat is every 5 seconds which translates into a rate of 0.2s
|
||||||
|
per_second: 0.5
|
||||||
|
burst_count: 30
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
port: 17880
|
||||||
|
bind_addresses:
|
||||||
|
- "0.0.0.0"
|
||||||
|
rtc:
|
||||||
|
tcp_port: 17881
|
||||||
|
port_range_start: 50300
|
||||||
|
port_range_end: 50400
|
||||||
|
use_external_ip: false
|
||||||
|
turn:
|
||||||
|
enabled: false
|
||||||
|
domain: localhost
|
||||||
|
cert_file: ""
|
||||||
|
key_file: ""
|
||||||
|
tls_port: 5349
|
||||||
|
udp_port: 443
|
||||||
|
external_tls: true
|
||||||
|
keys:
|
||||||
|
devkey: secret
|
||||||
|
room:
|
||||||
|
auto_create: false
|
||||||
|
webhook:
|
||||||
|
api_key: devkey
|
||||||
|
urls:
|
||||||
|
- https://matrix-rtc.othersite.m.localhost/livekit/jwt/sfu_webhook
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
port: 7880
|
||||||
|
bind_addresses:
|
||||||
|
- "0.0.0.0"
|
||||||
|
rtc:
|
||||||
|
tcp_port: 7881
|
||||||
|
port_range_start: 50100
|
||||||
|
port_range_end: 50200
|
||||||
|
use_external_ip: false
|
||||||
|
turn:
|
||||||
|
enabled: false
|
||||||
|
domain: localhost
|
||||||
|
cert_file: ""
|
||||||
|
key_file: ""
|
||||||
|
tls_port: 5349
|
||||||
|
udp_port: 443
|
||||||
|
external_tls: true
|
||||||
|
keys:
|
||||||
|
devkey: secret
|
||||||
|
room:
|
||||||
|
auto_create: false
|
||||||
|
webhook:
|
||||||
|
api_key: devkey
|
||||||
|
urls:
|
||||||
|
- https://matrix-rtc.m.localhost/livekit/jwt/sfu_webhook
|
||||||
@@ -0,0 +1,301 @@
|
|||||||
|
# Synapse reverse proxy including .well-known/matrix/client
|
||||||
|
# domain synapse.m.localhost
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
listen [::]:80;
|
||||||
|
listen 443 ssl;
|
||||||
|
listen 8448 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
listen [::]:8448 ssl;
|
||||||
|
server_name synapse.m.localhost;
|
||||||
|
ssl_certificate /root/ssl/cert.pem;
|
||||||
|
ssl_certificate_key /root/ssl/key.pem;
|
||||||
|
|
||||||
|
# well-known config adding rtc_foci backend
|
||||||
|
# Note well-known is currently not effective due to:
|
||||||
|
# https://spec.matrix.org/v1.12/client-server-api/#well-known-uri the spec
|
||||||
|
# says it must be at https://$server_name/... (implied port 443) Hence, we
|
||||||
|
# currently rely for local development environment on deprecated config.json
|
||||||
|
# setting for livekit_service_url
|
||||||
|
location /.well-known/matrix/client {
|
||||||
|
add_header Access-Control-Allow-Origin *;
|
||||||
|
return 200 '{"m.homeserver": {"base_url": "https://synapse.m.localhost"}, "org.matrix.msc4143.rtc_foci": [{"type": "livekit", "livekit_service_url": "https://matrix-rtc.m.localhost/livekit/jwt"}]}';
|
||||||
|
default_type application/json;
|
||||||
|
}
|
||||||
|
|
||||||
|
# Reverse proxy for Matrix Synapse Homeserver
|
||||||
|
# This is also required for development environment.
|
||||||
|
# Reason: the lk-jwt-service uses the federation API for the openid token
|
||||||
|
# verification, which requires TLS
|
||||||
|
location ~ ^(/_matrix|/_synapse/client) {
|
||||||
|
proxy_pass "http://homeserver:8008";
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header X-Forwarded-For $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
}
|
||||||
|
location ~ ^(/_matrix|/_synapse/admin) {
|
||||||
|
proxy_pass "http://homeserver:8008";
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header X-Forwarded-For $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# Synapse reverse proxy including .well-known/matrix/client
|
||||||
|
# domain synapse.othersite.m.localhost
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
listen [::]:80;
|
||||||
|
listen 443 ssl;
|
||||||
|
listen 8448 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
listen [::]:8448 ssl;
|
||||||
|
server_name synapse.othersite.m.localhost;
|
||||||
|
ssl_certificate /root/ssl/cert.pem;
|
||||||
|
ssl_certificate_key /root/ssl/key.pem;
|
||||||
|
|
||||||
|
# well-known config adding rtc_foci backend
|
||||||
|
# Note well-known is currently not effective due to:
|
||||||
|
# https://spec.matrix.org/v1.12/client-server-api/#well-known-uri the spec
|
||||||
|
# says it must be at https://$server_name/... (implied port 443) Hence, we
|
||||||
|
# currently rely for local development environment on deprecated config.json
|
||||||
|
# setting for livekit_service_url
|
||||||
|
location /.well-known/matrix/client {
|
||||||
|
add_header Access-Control-Allow-Origin *;
|
||||||
|
return 200 '{"m.homeserver": {"base_url": "https://synapse.othersite.m.localhost"}, "org.matrix.msc4143.rtc_foci": [{"type": "livekit", "livekit_service_url": "https://matrix-rtc.othersite.m.localhost/livekit/jwt"}]}';
|
||||||
|
default_type application/json;
|
||||||
|
}
|
||||||
|
|
||||||
|
# Reverse proxy for Matrix Synapse Homeserver
|
||||||
|
# This is also required for development environment.
|
||||||
|
# Reason: the lk-jwt-service uses the federation API for the openid token
|
||||||
|
# verification, which requires TLS
|
||||||
|
location ~ ^(/_matrix|/_synapse/client) {
|
||||||
|
proxy_pass "http://homeserver-1:18008";
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header X-Forwarded-For $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~ ^(/_matrix|/_synapse/admin) {
|
||||||
|
proxy_pass "http://homeserver-1:18008";
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header X-Forwarded-For $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# MatrixRTC reverse proxy
|
||||||
|
# domain matrix-rtc.m.localhost
|
||||||
|
# - MatrixRTC Authorization Service
|
||||||
|
# - LiveKit SFU websocket signaling connection
|
||||||
|
upstream jwt-auth-services {
|
||||||
|
server auth-server:6080;
|
||||||
|
server host.docker.internal:6080;
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
server_name matrix-rtc.m.localhost;
|
||||||
|
ssl_certificate /root/ssl/cert.pem;
|
||||||
|
ssl_certificate_key /root/ssl/key.pem;
|
||||||
|
|
||||||
|
http2 on;
|
||||||
|
|
||||||
|
|
||||||
|
location ^~ /livekit/jwt/ {
|
||||||
|
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
# JWT Service running at port 6080
|
||||||
|
proxy_pass http://jwt-auth-services/;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
location ^~ /livekit/sfu/ {
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
proxy_send_timeout 120;
|
||||||
|
proxy_read_timeout 120;
|
||||||
|
proxy_buffering off;
|
||||||
|
|
||||||
|
proxy_set_header Accept-Encoding gzip;
|
||||||
|
proxy_set_header Upgrade $http_upgrade;
|
||||||
|
proxy_set_header Connection "upgrade";
|
||||||
|
|
||||||
|
# LiveKit SFU websocket connection running at port 7880
|
||||||
|
proxy_pass http://livekit-sfu:7880/;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# MatrixRTC reverse proxy
|
||||||
|
# domain matrix-rtc.othersite.m.localhost
|
||||||
|
# - MatrixRTC Authorization Service
|
||||||
|
# - LiveKit SFU websocket signaling connection
|
||||||
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
server_name matrix-rtc.othersite.m.localhost;
|
||||||
|
ssl_certificate /root/ssl/cert.pem;
|
||||||
|
ssl_certificate_key /root/ssl/key.pem;
|
||||||
|
|
||||||
|
http2 on;
|
||||||
|
|
||||||
|
|
||||||
|
location ^~ /livekit/jwt/ {
|
||||||
|
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
# JWT Service running at port 16080
|
||||||
|
proxy_pass http://auth-service-1:16080/;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
location ^~ /livekit/sfu/ {
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
proxy_send_timeout 120;
|
||||||
|
proxy_read_timeout 120;
|
||||||
|
proxy_buffering off;
|
||||||
|
|
||||||
|
proxy_set_header Accept-Encoding gzip;
|
||||||
|
proxy_set_header Upgrade $http_upgrade;
|
||||||
|
proxy_set_header Connection "upgrade";
|
||||||
|
|
||||||
|
# LiveKit SFU websocket connection running at port 17880
|
||||||
|
proxy_pass http://livekit-sfu-1:17880/;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# Convenience reverse proxy for the call.m.localhost domain to element call
|
||||||
|
# running on the host either via
|
||||||
|
# - pnpm dev --host or
|
||||||
|
# - falling back to http (the element call docker container)
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
listen [::]:80;
|
||||||
|
server_name call.m.localhost;
|
||||||
|
|
||||||
|
return 301 https://$host$request_uri;
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
server_name call.m.localhost;
|
||||||
|
ssl_certificate /root/ssl/cert.pem;
|
||||||
|
ssl_certificate_key /root/ssl/key.pem;
|
||||||
|
|
||||||
|
# 1. Attempt HTTPS first
|
||||||
|
location ^~ / {
|
||||||
|
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
proxy_pass https://host.docker.internal:3000;
|
||||||
|
proxy_ssl_verify off;
|
||||||
|
|
||||||
|
# 2. Redirect specific errors (e.g., 502 Bad Gateway or 504 Timeout)
|
||||||
|
# to the named fallback location
|
||||||
|
error_page 502 503 504 = @http_fallback;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# 3. Fallback location using HTTP
|
||||||
|
location @http_fallback {
|
||||||
|
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
proxy_pass http://host.docker.internal:8080;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# Convenience reverse proxy app.m.localhost for element web
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
listen [::]:80;
|
||||||
|
server_name app.m.localhost;
|
||||||
|
|
||||||
|
return 301 https://$host$request_uri;
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
server_name app.m.localhost;
|
||||||
|
ssl_certificate /root/ssl/cert.pem;
|
||||||
|
ssl_certificate_key /root/ssl/key.pem;
|
||||||
|
|
||||||
|
|
||||||
|
location ^~ / {
|
||||||
|
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
proxy_pass http://element-web:8081;
|
||||||
|
proxy_ssl_verify off;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# Convenience reverse proxy app.othersite.m.localhost for element web
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
listen [::]:80;
|
||||||
|
server_name app.othersite.m.localhost;
|
||||||
|
|
||||||
|
return 301 https://$host$request_uri;
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl;
|
||||||
|
listen [::]:443 ssl;
|
||||||
|
server_name app.othersite.m.localhost;
|
||||||
|
ssl_certificate /root/ssl/cert.pem;
|
||||||
|
ssl_certificate_key /root/ssl/key.pem;
|
||||||
|
|
||||||
|
|
||||||
|
location ^~ / {
|
||||||
|
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
proxy_pass http://element-web-1:18081;
|
||||||
|
proxy_ssl_verify off;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
-----BEGIN CERTIFICATE-----
|
||||||
|
MIIDGjCCAgKgAwIBAgIUOlA2wgQUGZkKqNDvvifFWEsJfvYwDQYJKoZIhvcNAQEL
|
||||||
|
BQAwHjEcMBoGA1UEAwwTRWxlbWVudCBDYWxsIERldiBDQTAeFw0yNjA1MTgwOTM0
|
||||||
|
MzFaFw0yODA3MjYwOTM0MzFaMB4xHDAaBgNVBAMME0VsZW1lbnQgQ2FsbCBEZXYg
|
||||||
|
Q0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCcImv3pStfIUo7PbOO
|
||||||
|
XRVUXuDlApBOrg2dCnvZQ1Jfaf4MftGHj/pURkF4eoBuyH4k4+NLzWD0VcU1cM74
|
||||||
|
RnxowJt4AceCGe5RK/rqal5fapXc2vYMM8P6xaQR86gkxohpufsLgTnSweh74yqN
|
||||||
|
B5WHUnCX00/X0bh1ho2BMUvGM9+dI4MdgKdaQDgWK4zg9hwp2Z6Yq7SkJ/D8+sGW
|
||||||
|
WGpn3osDakL8HTBqop+YVJgF40db50yFurfcfQ0gjVtT4JW8ejO9j8PS/S2oQ/s5
|
||||||
|
mA1B470XhLtT5qTjGm2bp3WpYkTi5widps8PDzBp5eNr0HrvJqcw7BGpbvBlLa+3
|
||||||
|
7dhLAgMBAAGjUDBOMB0GA1UdDgQWBBRDfyRM4yKUqW6vu/2KUSXGb8vswDAfBgNV
|
||||||
|
HSMEGDAWgBRDfyRM4yKUqW6vu/2KUSXGb8vswDAMBgNVHRMEBTADAQH/MA0GCSqG
|
||||||
|
SIb3DQEBCwUAA4IBAQBoAhD4W4Yi/VJ2pTKrzhstn1UF1rgQnRddnn97v5BaEV/X
|
||||||
|
uuBXbSO+/ewjQUupRjePZFp9FFe9co1OiduKcDExlvPU1eIqkWAwDWjMDpI+Lw5q
|
||||||
|
KI5yHzplmMrT/7jn9Tepl9atrIcfDeFkP1dGtdRPyU6ARJEEWJSKeH9ftmImAsbM
|
||||||
|
ykXAqSyRl8+bPx1ISG4cNihOxFd38VPDHIW53umaRBgRcN4GcvloKBGrVtRFNM//
|
||||||
|
H+md8HmNQMP+e7FamETxs28DxjsdpygxjiFNY/T2eD67dH50ZxC3qCxEG6TJsoAg
|
||||||
|
TYJafnqEcGDfiWQyNZRBypuaRsRmmTR27hCPVgi8
|
||||||
|
-----END CERTIFICATE-----
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCcImv3pStfIUo7
|
||||||
|
PbOOXRVUXuDlApBOrg2dCnvZQ1Jfaf4MftGHj/pURkF4eoBuyH4k4+NLzWD0VcU1
|
||||||
|
cM74RnxowJt4AceCGe5RK/rqal5fapXc2vYMM8P6xaQR86gkxohpufsLgTnSweh7
|
||||||
|
4yqNB5WHUnCX00/X0bh1ho2BMUvGM9+dI4MdgKdaQDgWK4zg9hwp2Z6Yq7SkJ/D8
|
||||||
|
+sGWWGpn3osDakL8HTBqop+YVJgF40db50yFurfcfQ0gjVtT4JW8ejO9j8PS/S2o
|
||||||
|
Q/s5mA1B470XhLtT5qTjGm2bp3WpYkTi5widps8PDzBp5eNr0HrvJqcw7BGpbvBl
|
||||||
|
La+37dhLAgMBAAECggEAEsS4gc5jBk50I+bo3KYn2DqHgj/qpOqbTFNkS9uh3UJa
|
||||||
|
fZoJCeiuyM6hNCBVq/uB3mFeg1Au5XAiAqiK2KFwdw8gIS7lkqgXU76brO4YZhPj
|
||||||
|
6+aOSS03079KV7YYckNDRqJKoTlpgAI7Nhk6ljVhLiEk07tdD65wJACGpg8M8sg9
|
||||||
|
dyAz+ANs9gs65iF5LYjH61O/AFlLqCRQh5/z0mjGX6G9uN27nxeUY4+n4QMAcd9D
|
||||||
|
Gcygxjt+4nlQayNAlKMwVfps9bWNtI3Ye9knY4WGkrv5cJbW3bgjV6qrvQsbukbq
|
||||||
|
xEYzcIlUiWGO9Tv7MN6rk5uQOyoKT/KUnfRmdVd3YQKBgQDMhWm6Q+WuI7Pyn57R
|
||||||
|
tmY4rs+fSqTmv6xAOcozKJxffGaEwSUuNA15NvR/7iedcNqmH3XT9j90ZNVHe090
|
||||||
|
ocm1HDUvzC9G5GRrdO6JTTksRaIMZEhosWxqH3DIuBJPLGbF/4obGE7//PJtmDEp
|
||||||
|
QVL9Aa0WrcwAWhRzUdvCE+taMwKBgQDDbyZIvtlEr1w2V0bjXO536rRksBapc2ZJ
|
||||||
|
XRKtrXivuVtiZYNDB0I7CCJ52cka61n3kyZz2mhQmLq4cAZXyKYWE2i643O+kc3S
|
||||||
|
lpZEFSfDZ+3YlhxMxG9oEcgUSwVdbPlAhd/UR8V6n8o2Fm+gug9h6E2zY4fgHLJF
|
||||||
|
8hOWoD4hiQKBgA7YXD1F8mT6eHRS+78zIyZYIf/o9iE9pm4fA7tE5lzT9ckLD/zT
|
||||||
|
kGrM/2BN1BhMecJ3JCFXjXGQZB7FJ5ZKrA52VrH6ezAFIfjeyvWyYkUBZOrLWKoo
|
||||||
|
vrrRP2mCWuneSjNzAf5HfGx+WsZztpXNBQ4SUhMEWHtqDnP0bCQhOAMbAoGAPfLv
|
||||||
|
qcOFT3ZevoLv34ZHuQ9W20vOAyynUb4E+7SvOtSAmTIgZ5DXd6recs2MJ9JOlGG6
|
||||||
|
oKKsyk9/cJNiD1V1AC5q1kLfH5tMKOK/AxnJnvFEvZDnq5Xg0pZAW95j9vdiEwfc
|
||||||
|
qYeOm44nJPn7rHEOCzT93E1CdtHh2LYha2+kAjECgYEAh4qODleBi+2fnf2eq494
|
||||||
|
/tAot3szu2+gjyCN00vGjtzoAuDKTYgo0cbU1ILk0Pgpp1NcIvdHz/wQnG9RLX7e
|
||||||
|
Dfy1Q+UkyBK67SJUPvcYqBEaZ6ddyijJDunqh+U3nIBGP+IntKIKMIKiLF6wzTKz
|
||||||
|
NRpK1HNmllp+O692ZtxoNDU=
|
||||||
|
-----END PRIVATE KEY-----
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
-----BEGIN CERTIFICATE-----
|
||||||
|
MIIDijCCAnKgAwIBAgIUWkx2ad/F7QIj1JDaYfbLhiRV+EswDQYJKoZIhvcNAQEL
|
||||||
|
BQAwHjEcMBoGA1UEAwwTRWxlbWVudCBDYWxsIERldiBDQTAeFw0yNjA1MTgwOTM0
|
||||||
|
MzFaFw0yODA3MjYwOTM0MzFaMBgxFjAUBgNVBAMMDSoubS5sb2NhbGhvc3QwggEi
|
||||||
|
MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0hora/UCYMtrLJc6BOjonPUPi
|
||||||
|
bYpbNiZYnvnqI4doKbV0LBT2TfokT7tpgdPCtHKV0RknsVSL8vhlXpkRqIiWPml8
|
||||||
|
sZaa0+5NDGCQxexS2WVBlsoNCmAaqi/HNSFop6xaxGpQ3bu0iV3oIkUihveXAl6H
|
||||||
|
C0VYyGifQ8D5onzepW2ayhemu47YRNSo8wETY5vIi0i/iajTTaw6JvwS+8Kv5/QV
|
||||||
|
5prdvcFlG/oBs12p0+KoRyxskyzcdBdyIarvfY+9nDZwym5GfN32xO/iqtDuDQzw
|
||||||
|
Q09h2OsfHJCw70IpHcgXLlEQF2DsFbmbVpWSU6HcMm6B7Yw1YeE64W4PRJp3AgMB
|
||||||
|
AAGjgcUwgcIwHwYDVR0jBBgwFoAUQ38kTOMilKlur7v9ilElxm/L7MAwCQYDVR0T
|
||||||
|
BAIwADALBgNVHQ8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwUwYDVR0RBEww
|
||||||
|
SoIJbG9jYWxob3N0ggttLmxvY2FsaG9zdIINKi5tLmxvY2FsaG9zdIIXKi5vdGhl
|
||||||
|
cnNpdGUubS5sb2NhbGhvc3SCCCoubmlwLmlvMB0GA1UdDgQWBBSd0sKIKmZzTnxT
|
||||||
|
gNHHjsJNnFcYaTANBgkqhkiG9w0BAQsFAAOCAQEAeffRTrD9o9PVRIoul5r2chwP
|
||||||
|
WF7JtvPdC5xWy9rlCfmIKRNzNRnpVw/mDF/jdhlWcENt3psN8Vb1NM3SECKve9KL
|
||||||
|
8bDD2rJEoLBHIFQPS+XpEPqVGLHQcfBtGgs2XdILKvgXJyBHY/pgNZkQmXxYDVoc
|
||||||
|
bH9PjJJ4V3t6+tiVWZ792739EU/pHaSz7tab+ycTiggs7mo18E5jpYILhWsDqIVs
|
||||||
|
Kz3uczK2OR8537Ix64Z9kmKiklVAqE53odV7Qx2B+7DoOD/7KBN7SMy1KvR1ae6I
|
||||||
|
p1ivtDKpBZWbb1ccFxp2cQ30qRHLJrt2YRwz268gx/A6rGXuW6UQPYf4ISNR4Q==
|
||||||
|
-----END CERTIFICATE-----
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC0hora/UCYMtrL
|
||||||
|
Jc6BOjonPUPibYpbNiZYnvnqI4doKbV0LBT2TfokT7tpgdPCtHKV0RknsVSL8vhl
|
||||||
|
XpkRqIiWPml8sZaa0+5NDGCQxexS2WVBlsoNCmAaqi/HNSFop6xaxGpQ3bu0iV3o
|
||||||
|
IkUihveXAl6HC0VYyGifQ8D5onzepW2ayhemu47YRNSo8wETY5vIi0i/iajTTaw6
|
||||||
|
JvwS+8Kv5/QV5prdvcFlG/oBs12p0+KoRyxskyzcdBdyIarvfY+9nDZwym5GfN32
|
||||||
|
xO/iqtDuDQzwQ09h2OsfHJCw70IpHcgXLlEQF2DsFbmbVpWSU6HcMm6B7Yw1YeE6
|
||||||
|
4W4PRJp3AgMBAAECggEAIgdIbk4VmnrfjjKCsg5JPvNH9AsE7PuQj9zrq+xljkdq
|
||||||
|
aksS6ni5YZXb9F/iDE4aWU4waTB+iODUXLtPrCnyESwTk0sgYe/39/MQ0slUKivL
|
||||||
|
b+keDgY6JlyVI/5KXWFZ1kQ27CZXxwiruGGZWZBKZF8wdVE1Ea65Neg+HHA6DHee
|
||||||
|
Jck002gtgO/J1MMbB1MzdtGcsejYLrA+mO6YddQhA65xdQMljTEfyUwgTVv0pWde
|
||||||
|
biyKegGK77vlsOyoCkMpVYORG5NMV1Kxs+htA79yuIW71tWHqVbcRMyoM+BaHzPh
|
||||||
|
7uprs+8vYDFrO39LseczA8gURWwUsCgQ0yQ6Ix5W7QKBgQDnSK4AzjPpDEArdHuV
|
||||||
|
VGKyzrfPtzH0VV/yTH9hvByNG6i/x8sE/r2KPi5nRMi4PAjjqmxyO1G5qwDOfzvK
|
||||||
|
sBvwFrTRpmbnqGITVKPPivdoI9+RveN+FxhOXVA8NylAOv/dtSoakYwg3e507UsC
|
||||||
|
RuFW3Re0Oc+0XFq4C8rQyLkIOwKBgQDH0T9gww+XbwIGCtiNpnEziU9FXBKSVwXf
|
||||||
|
dCxYcTLPATq3BqHmP4OUA0v+sa3wPcnBkXF7q6eoB9+S6ZYQA/b2BXGU5/j9xYd4
|
||||||
|
29cF4DlPkhTwF9S8b+h1zhlGIn96Lw/vZuj7Bc3wuwxvB17d8dpyo8bZynIe7BvF
|
||||||
|
KSPJz+2O9QKBgFFyd8xS0VcFeGeVKpwozmUXhQWCBvZ7RkGGjOk3HHrYvbFjw2vr
|
||||||
|
5YWUZjT5tRGkGqFJ98y2dQ5EWRFfHwg+wmfnJyAZUG3OD1OtX86Lqpqi321siHtz
|
||||||
|
2JxoIgRCjKVQ4aAK11vp24YLgZjto5eWrG4xh9Jw9WMXjt73UCH8PaTXAoGBAIff
|
||||||
|
TY1qlmuO3H1nWqHXkBpPQEwVs7s22ZN817q8HqSMXXSfWe/LOJmpND/YakJ2gX7S
|
||||||
|
e6xwqOylje3EUHpLd98LDJUIuFM3wkr4klo4gkANQZeRXONV5WhV4PHD+5MF9XwB
|
||||||
|
KmOnKsaLKoVFKckZ8EUMAOePtdI5ExkaRG+yqAMRAoGAJyUFK+V9ST1N/6wYgqor
|
||||||
|
vywMSRE2cF2WvVIxdMvWffmpoj40bG6lAlaSWm29E2T8SVvAKsRid0wDgCQ4QTEn
|
||||||
|
ft7yUDjqVALCJVCrOFHDY0BPStkm6njMWagr/0lGr9zUWqbBOKJhNfDJlykv8gaF
|
||||||
|
8kWTgabrMCKmpTi7fBWbzZA=
|
||||||
|
-----END PRIVATE KEY-----
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Step 1: Create a Root CA key and cert
|
||||||
|
openssl genrsa -out dev_tls_local-ca.key 2048
|
||||||
|
openssl req -x509 -new -nodes \
|
||||||
|
-days 800 \
|
||||||
|
-subj "/CN=Element Call Dev CA" \
|
||||||
|
-key dev_tls_local-ca.key \
|
||||||
|
-out dev_tls_local-ca.crt \
|
||||||
|
-sha256 -addext "basicConstraints=CA:TRUE"
|
||||||
|
|
||||||
|
# Step 2: Create a private key and CSR for *.m.localhost
|
||||||
|
openssl req -new -nodes -newkey rsa:2048 \
|
||||||
|
-keyout dev_tls_m.localhost.key \
|
||||||
|
-out dev_tls_m.localhost.csr \
|
||||||
|
-subj "/CN=*.m.localhost"
|
||||||
|
|
||||||
|
# Step 3: Sign the CSR with your CA
|
||||||
|
openssl x509 \
|
||||||
|
-req -in dev_tls_m.localhost.csr \
|
||||||
|
-CA dev_tls_local-ca.crt -CAkey dev_tls_local-ca.key \
|
||||||
|
-CAcreateserial \
|
||||||
|
-out dev_tls_m.localhost.crt \
|
||||||
|
-days 800 \
|
||||||
|
-sha256 \
|
||||||
|
-extfile <( cat <<EOF
|
||||||
|
authorityKeyIdentifier=keyid,issuer
|
||||||
|
basicConstraints=CA:FALSE
|
||||||
|
keyUsage = digitalSignature, keyEncipherment
|
||||||
|
extendedKeyUsage = serverAuth
|
||||||
|
subjectAltName = @alt_names
|
||||||
|
|
||||||
|
[alt_names]
|
||||||
|
DNS.1 = localhost
|
||||||
|
DNS.2 = m.localhost
|
||||||
|
DNS.3 = *.m.localhost
|
||||||
|
DNS.4 = *.othersite.m.localhost
|
||||||
|
DNS.5 = *.nip.io
|
||||||
|
EOF
|
||||||
|
)
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
{
|
||||||
|
"default_server_config": {
|
||||||
|
"m.homeserver": {
|
||||||
|
"base_url": "https://synapse.m.localhost",
|
||||||
|
"server_name": "synapse.m.localhost"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"disable_custom_urls": false,
|
||||||
|
"disable_guests": false,
|
||||||
|
"disable_login_language_selector": false,
|
||||||
|
"disable_3pid_login": false,
|
||||||
|
"force_verification": false,
|
||||||
|
"brand": "Element",
|
||||||
|
"integrations_ui_url": "https://scalar.vector.im/",
|
||||||
|
"integrations_rest_url": "https://scalar.vector.im/api",
|
||||||
|
"integrations_widgets_urls": [
|
||||||
|
"https://scalar.vector.im/_matrix/integrations/v1",
|
||||||
|
"https://scalar.vector.im/api",
|
||||||
|
"https://scalar-staging.vector.im/_matrix/integrations/v1",
|
||||||
|
"https://scalar-staging.vector.im/api",
|
||||||
|
"https://scalar-staging.riot.im/scalar/api"
|
||||||
|
],
|
||||||
|
"default_widget_container_height": 280,
|
||||||
|
"default_country_code": "GB",
|
||||||
|
"show_labs_settings": false,
|
||||||
|
"features": {
|
||||||
|
"feature_element_call_video_rooms": true,
|
||||||
|
"feature_video_rooms": true,
|
||||||
|
"feature_group_calls": true,
|
||||||
|
"feature_release_announcement": false
|
||||||
|
},
|
||||||
|
"default_federate": true,
|
||||||
|
"default_theme": "light",
|
||||||
|
"room_directory": {
|
||||||
|
"servers": ["matrix.org"]
|
||||||
|
},
|
||||||
|
"enable_presence_by_hs_url": {
|
||||||
|
"https://matrix.org": false,
|
||||||
|
"https://matrix-client.matrix.org": false
|
||||||
|
},
|
||||||
|
"setting_defaults": {
|
||||||
|
"breadcrumbs": true,
|
||||||
|
"feature_group_calls": true
|
||||||
|
},
|
||||||
|
"jitsi": {
|
||||||
|
"preferred_domain": "meet.element.io"
|
||||||
|
},
|
||||||
|
"element_call": {
|
||||||
|
"participant_limit": 8,
|
||||||
|
"brand": "Element Call"
|
||||||
|
},
|
||||||
|
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx"
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
{
|
||||||
|
"default_server_config": {
|
||||||
|
"m.homeserver": {
|
||||||
|
"base_url": "https://synapse.othersite.m.localhost",
|
||||||
|
"server_name": "synapse.othersite.m.localhost"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"disable_custom_urls": false,
|
||||||
|
"disable_guests": false,
|
||||||
|
"disable_login_language_selector": false,
|
||||||
|
"disable_3pid_login": false,
|
||||||
|
"force_verification": false,
|
||||||
|
"brand": "Element",
|
||||||
|
"integrations_ui_url": "https://scalar.vector.im/",
|
||||||
|
"integrations_rest_url": "https://scalar.vector.im/api",
|
||||||
|
"integrations_widgets_urls": [
|
||||||
|
"https://scalar.vector.im/_matrix/integrations/v1",
|
||||||
|
"https://scalar.vector.im/api",
|
||||||
|
"https://scalar-staging.vector.im/_matrix/integrations/v1",
|
||||||
|
"https://scalar-staging.vector.im/api",
|
||||||
|
"https://scalar-staging.riot.im/scalar/api"
|
||||||
|
],
|
||||||
|
"default_widget_container_height": 280,
|
||||||
|
"default_country_code": "GB",
|
||||||
|
"show_labs_settings": false,
|
||||||
|
"features": {
|
||||||
|
"feature_element_call_video_rooms": true,
|
||||||
|
"feature_video_rooms": true,
|
||||||
|
"feature_group_calls": true,
|
||||||
|
"feature_release_announcement": false
|
||||||
|
},
|
||||||
|
"default_federate": true,
|
||||||
|
"default_theme": "light",
|
||||||
|
"room_directory": {
|
||||||
|
"servers": ["matrix.org"]
|
||||||
|
},
|
||||||
|
"enable_presence_by_hs_url": {
|
||||||
|
"https://matrix.org": false,
|
||||||
|
"https://matrix-client.matrix.org": false
|
||||||
|
},
|
||||||
|
"setting_defaults": {
|
||||||
|
"breadcrumbs": true,
|
||||||
|
"feature_group_calls": true
|
||||||
|
},
|
||||||
|
"jitsi": {
|
||||||
|
"preferred_domain": "meet.element.io"
|
||||||
|
},
|
||||||
|
"element_call": {
|
||||||
|
"participant_limit": 8,
|
||||||
|
"brand": "Element Call"
|
||||||
|
},
|
||||||
|
"map_style_url": "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx"
|
||||||
|
}
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
server_name: "synapse.othersite.m.localhost"
|
||||||
|
public_baseurl: https://synapse.othersite.m.localhost/
|
||||||
|
|
||||||
|
pid_file: /data/homeserver.pid
|
||||||
|
|
||||||
|
listeners:
|
||||||
|
- port: 18008
|
||||||
|
tls: false
|
||||||
|
type: http
|
||||||
|
x_forwarded: true
|
||||||
|
resources:
|
||||||
|
- names: [client, federation, openid]
|
||||||
|
compress: false
|
||||||
|
|
||||||
|
database:
|
||||||
|
name: sqlite3
|
||||||
|
args:
|
||||||
|
database: /data/homeserver.db
|
||||||
|
|
||||||
|
media_store_path: /data/media_store
|
||||||
|
signing_key_path: "/data/SERVERNAME.signing.key"
|
||||||
|
|
||||||
|
# Due to custom TLS certificate with domains
|
||||||
|
# - m.localhost, localhost
|
||||||
|
# - *.m.localhost
|
||||||
|
# - *.othersite.m.localhost
|
||||||
|
# we disable certificate verification to allow for federation.
|
||||||
|
# WARNING: DO NOT USE IN PRODUCTION!!!
|
||||||
|
federation_verify_certificates: false
|
||||||
|
ip_range_blacklist: []
|
||||||
|
trusted_key_servers:
|
||||||
|
- server_name: "synapse.m.localhost"
|
||||||
|
accept_keys_insecurely: true
|
||||||
|
|
||||||
|
experimental_features:
|
||||||
|
# MSC3266: Room summary API. Used for knocking over federation
|
||||||
|
msc3266_enabled: true
|
||||||
|
# MSC4222 needed for syncv2 state_after. This allow clients to
|
||||||
|
# correctly track the state of the room.
|
||||||
|
msc4222_enabled: true
|
||||||
|
# sticky events for MatrixRTC user state
|
||||||
|
msc4354_enabled: true
|
||||||
|
|
||||||
|
# The maximum allowed duration by which sent events can be delayed, as
|
||||||
|
# per MSC4140. Must be a positive value if set. Defaults to no
|
||||||
|
# duration (null), which disallows sending delayed events.
|
||||||
|
max_event_delay_duration: 24h
|
||||||
|
|
||||||
|
# Required for Element Call in Single Page Mode due to on-the-fly user registration
|
||||||
|
enable_registration: true
|
||||||
|
enable_registration_without_verification: true
|
||||||
|
|
||||||
|
# Shared secret for admin user registration via API (for testing only!)
|
||||||
|
registration_shared_secret: "test_shared_secret_for_local_dev_only"
|
||||||
|
|
||||||
|
report_stats: false
|
||||||
|
serve_server_wellknown: true
|
||||||
|
|
||||||
|
# Ratelimiting settings for client actions (registration, login, messaging).
|
||||||
|
#
|
||||||
|
# Each ratelimiting configuration is made of two parameters:
|
||||||
|
# - per_second: number of requests a client can send per second.
|
||||||
|
# - burst_count: number of requests a client can send before being throttled.
|
||||||
|
|
||||||
|
rc_message:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
|
||||||
|
rc_delayed_event_mgmt:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
|
||||||
|
rc_login:
|
||||||
|
address:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
account:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
failed_attempts:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
|
||||||
|
rc_registration:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
server_name: "synapse.m.localhost"
|
||||||
|
public_baseurl: https://synapse.m.localhost/
|
||||||
|
|
||||||
|
pid_file: /data/homeserver.pid
|
||||||
|
|
||||||
|
listeners:
|
||||||
|
- port: 8008
|
||||||
|
tls: false
|
||||||
|
type: http
|
||||||
|
x_forwarded: true
|
||||||
|
resources:
|
||||||
|
- names: [client, federation, openid]
|
||||||
|
compress: false
|
||||||
|
|
||||||
|
database:
|
||||||
|
name: sqlite3
|
||||||
|
args:
|
||||||
|
database: /data/homeserver.db
|
||||||
|
|
||||||
|
media_store_path: /data/media_store
|
||||||
|
signing_key_path: "/data/SERVERNAME.signing.key"
|
||||||
|
|
||||||
|
# Due to custom TLS certificate with domains
|
||||||
|
# - m.localhost, localhost
|
||||||
|
# - *.m.localhost
|
||||||
|
# - *.othersite.m.localhost
|
||||||
|
# we disable certificate verification to allow for federation.
|
||||||
|
# WARNING: DO NOT USE IN PRODUCTION!!!
|
||||||
|
federation_verify_certificates: false
|
||||||
|
ip_range_blacklist: []
|
||||||
|
trusted_key_servers:
|
||||||
|
- server_name: "synapse.othersite.m.localhost"
|
||||||
|
accept_keys_insecurely: true
|
||||||
|
|
||||||
|
experimental_features:
|
||||||
|
# MSC3266: Room summary API. Used for knocking over federation
|
||||||
|
msc3266_enabled: true
|
||||||
|
# MSC4222 needed for syncv2 state_after. This allow clients to
|
||||||
|
# correctly track the state of the room.
|
||||||
|
msc4222_enabled: true
|
||||||
|
# sticky events for MatrixRTC user state
|
||||||
|
msc4354_enabled: true
|
||||||
|
|
||||||
|
# The maximum allowed duration by which sent events can be delayed, as
|
||||||
|
# per MSC4140. Must be a positive value if set. Defaults to no
|
||||||
|
# duration (null), which disallows sending delayed events.
|
||||||
|
max_event_delay_duration: 24h
|
||||||
|
|
||||||
|
# Required for Element Call in Single Page Mode due to on-the-fly user registration
|
||||||
|
enable_registration: true
|
||||||
|
enable_registration_without_verification: true
|
||||||
|
|
||||||
|
# Shared secret for admin user registration via API (for testing only!)
|
||||||
|
registration_shared_secret: "test_shared_secret_for_local_dev_only"
|
||||||
|
|
||||||
|
report_stats: false
|
||||||
|
serve_server_wellknown: true
|
||||||
|
|
||||||
|
# Ratelimiting settings for client actions (registration, login, messaging).
|
||||||
|
#
|
||||||
|
# Each ratelimiting configuration is made of two parameters:
|
||||||
|
# - per_second: number of requests a client can send per second.
|
||||||
|
# - burst_count: number of requests a client can send before being throttled.
|
||||||
|
|
||||||
|
rc_message:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
|
||||||
|
rc_delayed_event_mgmt:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
|
||||||
|
rc_login:
|
||||||
|
address:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
account:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
failed_attempts:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
|
|
||||||
|
rc_registration:
|
||||||
|
per_second: 10000
|
||||||
|
burst_count: 10000
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# Don't post comments on PRs; they're noisy and the same information can be
|
||||||
|
# gotten through the checks section at the bottom of the PR anyways
|
||||||
|
comment: false
|
||||||
|
github_checks:
|
||||||
|
# Don't mark up the diffs on PRs with warnings about untested lines; we're not
|
||||||
|
# aiming for 100% test coverage and they just get in the way of reviewing
|
||||||
|
annotations: false
|
||||||
|
coverage:
|
||||||
|
status:
|
||||||
|
project:
|
||||||
|
default:
|
||||||
|
# Track the impact of changes on overall coverage without blocking PRs
|
||||||
|
informational: true
|
||||||
|
patch:
|
||||||
|
default:
|
||||||
|
# Enforce 80% coverage on all lines that a PR
|
||||||
|
# touches
|
||||||
|
target: 80%
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"default_server_config": {
|
||||||
|
"m.homeserver": {
|
||||||
|
"base_url": "https://synapse.m.localhost",
|
||||||
|
"server_name": "synapse.m.localhost"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"features": {
|
||||||
|
"feature_use_device_session_member_events": true
|
||||||
|
},
|
||||||
|
"ssla": "https://static.element.io/legal/element-software-and-services-license-agreement-uk-1.pdf",
|
||||||
|
"matrix_rtc_session": {
|
||||||
|
"wait_for_key_rotation_ms": 3000,
|
||||||
|
"membership_event_expiry_ms": 180000000,
|
||||||
|
"delayed_leave_event_delay_ms": 18000,
|
||||||
|
"delayed_leave_event_restart_ms": 4000,
|
||||||
|
"network_error_retry_ms": 100
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"default_server_config": {
|
||||||
|
"m.homeserver": {
|
||||||
|
"base_url": "https://mydomain.com",
|
||||||
|
"server_name": "mydomain.com"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"livekit": {
|
||||||
|
"livekit_service_url": "https://livekit-jwt.mydomain.com"
|
||||||
|
},
|
||||||
|
"features": {
|
||||||
|
"feature_use_device_session_member_events": true
|
||||||
|
},
|
||||||
|
"ssla": "https://static.element.io/legal/element-software-and-services-license-agreement-uk-1.pdf",
|
||||||
|
"matrix_rtc_mode": "legacy",
|
||||||
|
"matrix_rtc_session": {
|
||||||
|
"wait_for_key_rotation_ms": 3000,
|
||||||
|
"membership_event_expiry_ms": 180000000,
|
||||||
|
"delayed_leave_event_delay_ms": 18000,
|
||||||
|
"delayed_leave_event_restart_ms": 4000,
|
||||||
|
"network_error_retry_ms": 100
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"default_server_config": {
|
||||||
|
"m.homeserver": {
|
||||||
|
"base_url": "https://call-unstable.ems.host",
|
||||||
|
"server_name": "call-unstable.ems.host"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"ssla": "https://static.element.io/legal/element-software-and-services-license-agreement-uk-1.pdf",
|
||||||
|
"matrix_rtc_session": {
|
||||||
|
"wait_for_key_rotation_ms": 3000,
|
||||||
|
"membership_event_expiry_ms": 180000000,
|
||||||
|
"delayed_leave_event_delay_ms": 18000,
|
||||||
|
"delayed_leave_event_restart_ms": 4000,
|
||||||
|
"network_error_retry_ms": 100
|
||||||
|
},
|
||||||
|
"posthog": {
|
||||||
|
"api_key": "phc_rXGHx9vDmyEvyRxPziYtdVIv0ahEv8A9uLWFcCi1WcU",
|
||||||
|
"api_host": "https://posthog-element-call.element.io"
|
||||||
|
},
|
||||||
|
"rageshake": {
|
||||||
|
"submit_url": "https://rageshakes.element.io/api/submit"
|
||||||
|
},
|
||||||
|
"sentry": {
|
||||||
|
"environment": "netlify-pr-preview",
|
||||||
|
"DSN": "https://b1e328d49be3402ba96101338989fb35@sentry.tools.element.io/41"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"default_server_config": {
|
||||||
|
"m.homeserver": {
|
||||||
|
"base_url": "https://call-unstable.ems.host",
|
||||||
|
"server_name": "call-unstable.ems.host"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"ssla": "https://static.element.io/legal/element-software-and-services-license-agreement-uk-1.pdf",
|
||||||
|
"matrix_rtc_session": {
|
||||||
|
"wait_for_key_rotation_ms": 3000,
|
||||||
|
"membership_event_expiry_ms": 180000000,
|
||||||
|
"delayed_leave_event_delay_ms": 18000,
|
||||||
|
"delayed_leave_event_restart_ms": 4000,
|
||||||
|
"network_error_retry_ms": 100
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
<VirtualHost *:8080>
|
||||||
|
ServerName localhost
|
||||||
|
|
||||||
|
DocumentRoot "/app"
|
||||||
|
|
||||||
|
<Location "/">
|
||||||
|
# disable cache entriely by default (apart from Etag which is accurate enough)
|
||||||
|
Header add Cache-Control "private, no-store, no-cache, must-revalidate, proxy-revalidate, max-age=0"
|
||||||
|
CacheDisable on
|
||||||
|
ExpiresActive off
|
||||||
|
|
||||||
|
# also turn off last-modified since they are just the timestamps of the file in the docker image
|
||||||
|
# and may or may not bear any resemblance to when the resource changed
|
||||||
|
Header add Last-Modified ""
|
||||||
|
|
||||||
|
DirectoryIndex index.html
|
||||||
|
</Location>
|
||||||
|
|
||||||
|
# assets can be cached because they have hashed filenames
|
||||||
|
<Location "/assets">
|
||||||
|
ExpiresActive on
|
||||||
|
ExpiresDefault "access plus 1 week"
|
||||||
|
Header add Cache-Control "public, no-transform"
|
||||||
|
</Location>
|
||||||
|
|
||||||
|
<Location "/apple-app-site-association">
|
||||||
|
ForceType application/json
|
||||||
|
</Location>
|
||||||
|
</VirtualHost>
|
||||||
|
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# This file is copied to the netlify deploy dir in the upload stage
|
||||||
|
|
||||||
|
# Redirect any unknown path to index.html
|
||||||
|
/* /index.html 200
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
server {
|
||||||
|
listen 8080;
|
||||||
|
server_name localhost;
|
||||||
|
|
||||||
|
root /app;
|
||||||
|
gzip_static on;
|
||||||
|
gzip_vary on;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
try_files $uri $uri/ /index.html;
|
||||||
|
add_header Cache-Control "public, max-age=30, stale-while-revalidate=30";
|
||||||
|
}
|
||||||
|
|
||||||
|
# assets can be cached because they have hashed filenames
|
||||||
|
location /assets {
|
||||||
|
add_header Cache-Control "public, immutable, max-age=31536000";
|
||||||
|
}
|
||||||
|
|
||||||
|
location /apple-app-site-association {
|
||||||
|
default_type application/json;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
# OpenTelemetry Collector for development
|
||||||
|
|
||||||
|
## Edit:
|
||||||
|
|
||||||
|
Open telemetry has been removed in: https://github.com/element-hq/element-call/pull/3586
|
||||||
|
Check this PR to get back the implementation or to use it as reference to add it back.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
This directory contains a docker compose file that starts a jaeger all-in-one instance
|
||||||
|
with an in-memory database, along with a standalone OpenTelemetry collector that forwards
|
||||||
|
traces into the jaeger. Jaeger has a built-in OpenTelemetry collector, but it can't be
|
||||||
|
configured to send CORS headers so can't be used from a browser. This sets the config on
|
||||||
|
the collector to send CORS headers.
|
||||||
|
|
||||||
|
This also adds an nginx to add CORS headers to the jaeger query endpoint, such that it can
|
||||||
|
be used from webapps like stalk (https://deniz.co/stalk/). The CORS enabled endpoint is
|
||||||
|
exposed on port 16687. To use stalk, you should simply be able to navigate to it and add
|
||||||
|
http://127.0.0.1:16687/api as a data source.
|
||||||
|
|
||||||
|
(Yes, we could enable the OTLP collector in jaeger all-in-one and passed this through
|
||||||
|
the nginx to enable CORS too, rather than running a separate collector. There's no reason
|
||||||
|
it's done this way other than that I'd already set up the separate collector.)
|
||||||
|
|
||||||
|
Running `docker compose up` in this directory should be all you need.
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
receivers:
|
||||||
|
otlp:
|
||||||
|
protocols:
|
||||||
|
http:
|
||||||
|
endpoint: 0.0.0.0:4318
|
||||||
|
cors:
|
||||||
|
allowed_origins:
|
||||||
|
# This can't be '*' because opentelemetry-js uses sendBeacon which always operates
|
||||||
|
# in 'withCredentials' mode, which browsers don't allow with an allow-origin of '*'
|
||||||
|
#- "https://pr976--element-call.netlify.app"
|
||||||
|
- "http://*"
|
||||||
|
allowed_headers:
|
||||||
|
- "*"
|
||||||
|
processors:
|
||||||
|
batch:
|
||||||
|
timeout: 1s
|
||||||
|
resource:
|
||||||
|
attributes:
|
||||||
|
- key: test.key
|
||||||
|
value: "test-value"
|
||||||
|
action: insert
|
||||||
|
exporters:
|
||||||
|
logging:
|
||||||
|
loglevel: info
|
||||||
|
jaeger:
|
||||||
|
endpoint: jaeger-all-in-one:14250
|
||||||
|
tls:
|
||||||
|
insecure: true
|
||||||
|
extensions:
|
||||||
|
health_check:
|
||||||
|
pprof:
|
||||||
|
endpoint: :1888
|
||||||
|
zpages:
|
||||||
|
endpoint: :55679
|
||||||
|
service:
|
||||||
|
extensions: [pprof, zpages, health_check]
|
||||||
|
pipelines:
|
||||||
|
traces:
|
||||||
|
receivers: [otlp]
|
||||||
|
processors: [batch, resource]
|
||||||
|
exporters: [logging, jaeger]
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
version: "2"
|
||||||
|
services:
|
||||||
|
# Jaeger
|
||||||
|
jaeger-all-in-one:
|
||||||
|
image: jaegertracing/all-in-one:latest
|
||||||
|
ports:
|
||||||
|
- "16686:16686"
|
||||||
|
- "14268"
|
||||||
|
- "14250"
|
||||||
|
# Collector
|
||||||
|
collector-gateway:
|
||||||
|
image: otel/opentelemetry-collector:latest
|
||||||
|
volumes:
|
||||||
|
- ./collector-gateway.yaml:/etc/collector-gateway.yaml
|
||||||
|
command: ["--config=/etc/collector-gateway.yaml"]
|
||||||
|
ports:
|
||||||
|
- "1888:1888" # pprof extension
|
||||||
|
- "13133:13133" # health_check extension
|
||||||
|
- "4317:4317" # OTLP gRPC receiver
|
||||||
|
- "4318:4318" # OTLP HTTP receiver
|
||||||
|
- "55670:55679" # zpages extension
|
||||||
|
depends_on:
|
||||||
|
- jaeger-all-in-one
|
||||||
|
nginx:
|
||||||
|
image: nginxinc/nginx-unprivileged:latest
|
||||||
|
volumes:
|
||||||
|
- ./nginx_otel.conf:/etc/nginx/conf.d/default.conf:ro
|
||||||
|
ports:
|
||||||
|
- "16687:8080"
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
server {
|
||||||
|
listen 8080;
|
||||||
|
server_name localhost;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://jaeger-all-in-one:16686/;
|
||||||
|
add_header Access-Control-Allow-Origin *;
|
||||||
|
|
||||||
|
if ($request_method = OPTIONS) {
|
||||||
|
add_header Access-Control-Allow-Origin *;
|
||||||
|
add_header Content-Type text/plain;
|
||||||
|
add_header Content-Length 0;
|
||||||
|
return 204;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,183 @@
|
|||||||
|
networks:
|
||||||
|
ecbackend:
|
||||||
|
|
||||||
|
services:
|
||||||
|
auth-service:
|
||||||
|
image: ghcr.io/element-hq/lk-jwt-service:0.4.4
|
||||||
|
pull_policy: always
|
||||||
|
hostname: auth-server
|
||||||
|
environment:
|
||||||
|
- LIVEKIT_JWT_PORT=6080
|
||||||
|
- LIVEKIT_URL=wss://matrix-rtc.m.localhost/livekit/sfu
|
||||||
|
- LIVEKIT_KEY=devkey
|
||||||
|
- LIVEKIT_SECRET=secret
|
||||||
|
# If the configured homeserver runs on localhost, it'll probably be using
|
||||||
|
# a self-signed certificate
|
||||||
|
- LIVEKIT_INSECURE_SKIP_VERIFY_TLS=YES_I_KNOW_WHAT_I_AM_DOING
|
||||||
|
- LIVEKIT_FULL_ACCESS_HOMESERVERS=*
|
||||||
|
deploy:
|
||||||
|
restart_policy:
|
||||||
|
condition: on-failure
|
||||||
|
ports:
|
||||||
|
# HOST_PORT:CONTAINER_PORT
|
||||||
|
- 6080:6080
|
||||||
|
networks:
|
||||||
|
- ecbackend
|
||||||
|
|
||||||
|
auth-service-1:
|
||||||
|
image: ghcr.io/element-hq/lk-jwt-service:0.4.4
|
||||||
|
pull_policy: always
|
||||||
|
hostname: auth-server-1
|
||||||
|
environment:
|
||||||
|
- LIVEKIT_JWT_PORT=16080
|
||||||
|
- LIVEKIT_URL=wss://matrix-rtc.othersite.m.localhost/livekit/sfu
|
||||||
|
- LIVEKIT_KEY=devkey
|
||||||
|
- LIVEKIT_SECRET=secret
|
||||||
|
# If the configured homeserver runs on localhost, it'll probably be using
|
||||||
|
# a self-signed certificate
|
||||||
|
- LIVEKIT_INSECURE_SKIP_VERIFY_TLS=YES_I_KNOW_WHAT_I_AM_DOING
|
||||||
|
- LIVEKIT_FULL_ACCESS_HOMESERVERS=*
|
||||||
|
deploy:
|
||||||
|
restart_policy:
|
||||||
|
condition: on-failure
|
||||||
|
ports:
|
||||||
|
# HOST_PORT:CONTAINER_PORT
|
||||||
|
- 16080:16080
|
||||||
|
networks:
|
||||||
|
- ecbackend
|
||||||
|
|
||||||
|
livekit:
|
||||||
|
image: livekit/livekit-server:v1.10.1
|
||||||
|
pull_policy: always
|
||||||
|
hostname: livekit-sfu
|
||||||
|
command: --dev --config /etc/livekit.yaml
|
||||||
|
restart: unless-stopped
|
||||||
|
# The SFU seems to work far more reliably when we let it share the host
|
||||||
|
# network rather than opening specific ports (but why?? we're not missing
|
||||||
|
# any…)
|
||||||
|
ports:
|
||||||
|
# HOST_PORT:CONTAINER_PORT
|
||||||
|
- 7880:7880/tcp
|
||||||
|
- 7881:7881/tcp
|
||||||
|
- 7882:7882/tcp
|
||||||
|
- 50100-50200:50100-50200/udp
|
||||||
|
volumes:
|
||||||
|
- ./backend/dev_tls_m.localhost.crt:/local_cert.pem:Z
|
||||||
|
- ./backend/dev_livekit.yaml:/etc/livekit.yaml:Z
|
||||||
|
environment:
|
||||||
|
- SSL_CERT_FILE=/local_cert.pem
|
||||||
|
networks:
|
||||||
|
- ecbackend
|
||||||
|
|
||||||
|
livekit-1:
|
||||||
|
image: livekit/livekit-server:v1.10.1
|
||||||
|
pull_policy: always
|
||||||
|
hostname: livekit-sfu-1
|
||||||
|
command: --dev --config /etc/livekit.yaml
|
||||||
|
restart: unless-stopped
|
||||||
|
# The SFU seems to work far more reliably when we let it share the host
|
||||||
|
# network rather than opening specific ports (but why?? we're not missing
|
||||||
|
# any…)
|
||||||
|
ports:
|
||||||
|
# HOST_PORT:CONTAINER_PORT
|
||||||
|
- 17880:17880/tcp
|
||||||
|
- 17881:17881/tcp
|
||||||
|
- 17882:17882/tcp
|
||||||
|
- 50300-50400:50300-50400/udp
|
||||||
|
volumes:
|
||||||
|
- ./backend/dev_tls_m.localhost.crt:/local_cert.pem:Z
|
||||||
|
- ./backend/dev_livekit-othersite.yaml:/etc/livekit.yaml:Z
|
||||||
|
environment:
|
||||||
|
- SSL_CERT_FILE=/local_cert.pem
|
||||||
|
networks:
|
||||||
|
- ecbackend
|
||||||
|
|
||||||
|
synapse:
|
||||||
|
hostname: homeserver
|
||||||
|
image: ghcr.io/element-hq/synapse:latest
|
||||||
|
pull_policy: always
|
||||||
|
environment:
|
||||||
|
- SYNAPSE_CONFIG_PATH=/data/cfg/homeserver.yaml
|
||||||
|
# Needed for rootless podman-compose such that the uid/gid mapping does
|
||||||
|
# fit local user uid. If the container runs as root (uid 0) it is fine as
|
||||||
|
# it actually maps to your non-root user on the host (e.g. 1000).
|
||||||
|
# Otherwise uid mapping will not match your non-root user.
|
||||||
|
- UID=0
|
||||||
|
- GID=0
|
||||||
|
volumes:
|
||||||
|
- ./backend/synapse_tmp:/data:Z
|
||||||
|
- ./backend/dev_homeserver.yaml:/data/cfg/homeserver.yaml:Z
|
||||||
|
networks:
|
||||||
|
- ecbackend
|
||||||
|
|
||||||
|
synapse-1:
|
||||||
|
hostname: homeserver-1
|
||||||
|
image: ghcr.io/element-hq/synapse:latest
|
||||||
|
pull_policy: always
|
||||||
|
environment:
|
||||||
|
- SYNAPSE_CONFIG_PATH=/data/cfg/homeserver.yaml
|
||||||
|
# Needed for rootless podman-compose such that the uid/gid mapping does
|
||||||
|
# fit local user uid. If the container runs as root (uid 0) it is fine as
|
||||||
|
# it actually maps to your non-root user on the host (e.g. 1000).
|
||||||
|
# Otherwise uid mapping will not match your non-root user.
|
||||||
|
- UID=0
|
||||||
|
- GID=0
|
||||||
|
volumes:
|
||||||
|
- ./backend/synapse_tmp_othersite:/data:Z
|
||||||
|
- ./backend/dev_homeserver-othersite.yaml:/data/cfg/homeserver.yaml:Z
|
||||||
|
networks:
|
||||||
|
- ecbackend
|
||||||
|
|
||||||
|
element-web:
|
||||||
|
image: ghcr.io/element-hq/element-web:develop
|
||||||
|
pull_policy: always
|
||||||
|
volumes:
|
||||||
|
- ./backend/ew.test.config.json:/app/config.json:Z
|
||||||
|
environment:
|
||||||
|
ELEMENT_WEB_PORT: 8081
|
||||||
|
ports:
|
||||||
|
- "8081:8081"
|
||||||
|
networks:
|
||||||
|
- ecbackend
|
||||||
|
|
||||||
|
element-web-1:
|
||||||
|
image: ghcr.io/element-hq/element-web:develop
|
||||||
|
pull_policy: always
|
||||||
|
volumes:
|
||||||
|
- ./backend/ew.test.othersite.config.json:/app/config.json:Z
|
||||||
|
environment:
|
||||||
|
ELEMENT_WEB_PORT: 18081
|
||||||
|
ports:
|
||||||
|
# HOST_PORT:CONTAINER_PORT
|
||||||
|
- "18081:18081"
|
||||||
|
networks:
|
||||||
|
- ecbackend
|
||||||
|
|
||||||
|
nginx:
|
||||||
|
# see backend/dev_tls_setup for how to generate the tls certs
|
||||||
|
hostname: synapse.m.localhost
|
||||||
|
image: nginx:latest
|
||||||
|
pull_policy: always
|
||||||
|
volumes:
|
||||||
|
- ./backend/dev_nginx.conf:/etc/nginx/conf.d/default.conf:Z
|
||||||
|
- ./backend/dev_tls_m.localhost.key:/root/ssl/key.pem:Z
|
||||||
|
- ./backend/dev_tls_m.localhost.crt:/root/ssl/cert.pem:Z
|
||||||
|
ports:
|
||||||
|
# HOST_PORT:CONTAINER_PORT
|
||||||
|
- "443:443"
|
||||||
|
- "8008:80"
|
||||||
|
- "4443:443"
|
||||||
|
- "8448:8448"
|
||||||
|
extra_hosts:
|
||||||
|
- "host.docker.internal:host-gateway"
|
||||||
|
- "auth-server:127.0.0.1"
|
||||||
|
- "auth-server-1:127.0.0.1"
|
||||||
|
depends_on:
|
||||||
|
- synapse
|
||||||
|
networks:
|
||||||
|
ecbackend:
|
||||||
|
aliases:
|
||||||
|
- synapse.m.localhost
|
||||||
|
- synapse.othersite.m.localhost
|
||||||
|
- matrix-rtc.m.localhost
|
||||||
|
- matrix-rtc.othersite.m.localhost
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 91 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
@@ -0,0 +1,9 @@
|
|||||||
|
## Element Call Docs
|
||||||
|
|
||||||
|
This folder contains documentation for setup, usage, and development of Element Call.
|
||||||
|
|
||||||
|
- [Embedded vs standalone mode](./embedded_standalone.md)
|
||||||
|
- [Url format and parameters](./url_params.md)
|
||||||
|
- [Global JS controls](./controls.md)
|
||||||
|
- [Self-Hosting](./self_hosting.md)
|
||||||
|
- [Developing with linked packages](./linking.md)
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
@@ -0,0 +1,112 @@
|
|||||||
|
# Developer help
|
||||||
|
|
||||||
|
## Testing on Mobile Devices
|
||||||
|
|
||||||
|
When developing Element Call locally, you may want to test on physical mobile devices (iOS/Android)
|
||||||
|
on the same WiFi network.
|
||||||
|
|
||||||
|
**Known Limitations:** For now this setup allows to use your local EC server but not yet the SFUs and Synapses.
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
1. **Start the dev server**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Check the output for the `➜ Network` (this will contain the local IP address of your laptop)
|
||||||
|
|
||||||
|
```
|
||||||
|
➜ Local: https://m.localhost:3000/ 12:06:48
|
||||||
|
➜ Local: https://vite.m.localhost:3000/ 12:06:48
|
||||||
|
➜ Local: https://vite.othersite.m.localhost:3000/ 12:06:48
|
||||||
|
➜ Local: https://vite.nip.io:3000/ 12:06:48
|
||||||
|
➜ Network: https://192.168.0.122:3000/
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Transfer the CA certificate to your phone**
|
||||||
|
|
||||||
|
The file is located at `backend/dev_tls_local-ca.crt`. Transfer it via:
|
||||||
|
- Matrix room
|
||||||
|
- AirDrop for iphone
|
||||||
|
|
||||||
|
### IOS Setup
|
||||||
|
|
||||||
|
**Install the certificate profile on iPhone**
|
||||||
|
|
||||||
|
- Open the `dev_tls_local-ca.crt` file on your iPhone
|
||||||
|
- You'll see "Profile Downloaded"
|
||||||
|
- Go to **Settings → General → VPN & Device Management** (or **Settings → General → Profiles**)
|
||||||
|
- Tap the "Element Call Dev CA" profile
|
||||||
|
- Tap **Install** and enter your passcode
|
||||||
|
- Confirm by tapping **Install** again
|
||||||
|
|
||||||
|
**Enable full trust (Critical!)**
|
||||||
|
|
||||||
|
- Go to **Settings → General → About → Certificate Trust Settings**
|
||||||
|
- Under "Enable Full Trust for Root Certificates"
|
||||||
|
- Toggle **ON** for "Element Call Dev CA"
|
||||||
|
- Confirm the security warning
|
||||||
|
|
||||||
|
**Access Element Call**
|
||||||
|
|
||||||
|
Find your laptop's IP address (e.g., `192.168.0.122`) and use one of these URLs in Safari to validate:
|
||||||
|
|
||||||
|
```
|
||||||
|
https://192-168-0-122.nip.io:3000/
|
||||||
|
```
|
||||||
|
|
||||||
|
**For Element X iOS Developer Tools**
|
||||||
|
|
||||||
|
In Element X's developer settings, set the Element Call URL to the nip.io url (replace . with - in the IP address):
|
||||||
|
|
||||||
|
```
|
||||||
|
https://192-168-0-122.nip.io:3000/room
|
||||||
|
```
|
||||||
|
|
||||||
|
### Android Setup
|
||||||
|
|
||||||
|
**Transfer the CA certificate to your Android device**
|
||||||
|
|
||||||
|
The file is located at `backend/dev_tls_local-ca.crt`.
|
||||||
|
|
||||||
|
**Install the certificate**
|
||||||
|
|
||||||
|
This might vary by Android version and manufacturer, but generally:
|
||||||
|
|
||||||
|
- Open **Settings** search for "CA Certificate"/"Certificate"
|
||||||
|
- Tap **Install a certificate** or **Install from storage**
|
||||||
|
- Select **CA certificate**
|
||||||
|
- Confirm the security warning
|
||||||
|
- Navigate to and select the `dev_tls_local-ca.crt` file
|
||||||
|
- Give it a name like "Element Call Dev CA"
|
||||||
|
|
||||||
|
**Access Element Call**
|
||||||
|
|
||||||
|
Find your laptop's IP address (e.g., `192.168.0.122`) and use one of these URLs in Chrome to validate:
|
||||||
|
|
||||||
|
```
|
||||||
|
https://192-168-0-122.nip.io:3000/
|
||||||
|
```
|
||||||
|
|
||||||
|
**For Element X Android Developer Tools**
|
||||||
|
|
||||||
|
In Element X's developer settings, set the Element Call URL to the nip.io url (replace . with - in the IP address):
|
||||||
|
|
||||||
|
```
|
||||||
|
https://192-168-0-122.nip.io:3000/room
|
||||||
|
```
|
||||||
|
|
||||||
|
### Why nip.io?
|
||||||
|
|
||||||
|
[nip.io](https://nip.io) is a free wildcard DNS service that automatically resolves domain names containing IP addresses. For example, `192-168-0-122.nip.io` automatically resolves to `192.168.0.122`. This means:
|
||||||
|
|
||||||
|
- No need to regenerate certificates when your laptop's IP changes
|
||||||
|
- Works from any device without DNS configuration
|
||||||
|
- iOS/Android treat it as a proper domain name, not an IP address
|
||||||
|
- One-time certificate setup works for all future IP addresses
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> Make sure your network router doesn't enforce DNS rebinding protection (which will
|
||||||
|
> break nip.io). If it does, try allow-listing nip.io in your router's administration interface.
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
# threadnet-call: Fork-Anpassungen für axion1337.chat
|
||||||
|
|
||||||
|
Dieses Dokument beschreibt alles, was dieser Fork gegenüber Upstream Element Call ändert. Die
|
||||||
|
übrigen Dateien in `docs/` sind unverändertes Upstream-Material.
|
||||||
|
|
||||||
|
## 1. Warum Fork von `emmick4/element-call` (Branch `livekit`)?
|
||||||
|
|
||||||
|
Nicht direkt von `element-hq/element-call` geforkt, sondern von `emmick4/element-call`s
|
||||||
|
`livekit`-Branch, weil dieser bereits den noch nicht upstream gemergten PR
|
||||||
|
[element-hq/element-call#3736](https://github.com/element-hq/element-call/pull/3736)
|
||||||
|
enthält - config-driven `media_quality`. Ohne diesen PR wäre eigener Custom-Code nötig gewesen,
|
||||||
|
um Video-/Audio-Qualitätslimits pro Deployment konfigurierbar zu machen.
|
||||||
|
|
||||||
|
## 2. media_quality-Defaults
|
||||||
|
|
||||||
|
Konfiguriert in `vite-embedded.config.ts` (im `generateFile`-Plugin-Aufruf, der
|
||||||
|
`media_quality` in die zur Build-Zeit gebackene `config.json` des Embedded-Packages schreibt):
|
||||||
|
|
||||||
|
- Kamera: **1440p / 60fps / ~8 Mbps** (`video.max_resolution/max_framerate/max_bitrate`)
|
||||||
|
- Screen-Share: **1440p / 30fps / ~6 Mbps**
|
||||||
|
- 720p-Zwischen-Simulcast-Layer (`video.simulcast_layers`) - ohne diesen fiel die Übertragung
|
||||||
|
bei kleinsten Netzwerkschwankungen direkt von 1440p auf blockiges 360p
|
||||||
|
- `video_codec: "h264"` (siehe Incident unten für die Begründung)
|
||||||
|
|
||||||
|
Das sind Startwerte, keine harten Limits - Nutzer können in den Call-Settings weiter hochdrehen.
|
||||||
|
|
||||||
|
## 3. VP9-Incident (2026-07-28) — ⚠️ nicht ohne Browser-Repro erneut versuchen
|
||||||
|
|
||||||
|
Erster Versuch setzte `video_codec: "vp9"` (Commit `83db5224`). Das hat Calls **live komplett
|
||||||
|
kaputt gemacht** (kein Bild/Ton), obwohl die LiveKit-SFU-Server-Logs den
|
||||||
|
Codec-Regression-Fallback auf VP8 als scheinbar erfolgreich zeigten. Sofort zurückgerollt
|
||||||
|
(Commit `f845d81e`). Vermutete Ursache: LiveKit nutzt für VP9/AV1 SVC statt klassischem
|
||||||
|
Simulcast, aber `buildPublishOptions()` in diesem Fork setzt immer Simulcast-Layer - ein
|
||||||
|
echter Code-Fix wäre nötig, um das aufzulösen. **Root Cause nie abschließend isoliert** (hätte
|
||||||
|
einen Browser-Konsolen-/WebRTC-Internals-Repro gebraucht). Danach auf 720p-Zwischen-Layer +
|
||||||
|
`h264` (klassisches Simulcast, kein SVC-Risiko, oft hardwarebeschleunigt v.a. auf iOS)
|
||||||
|
umgestellt - live verifiziert (7/8 Tracks nativ H.264, 1 sauberer VP8-Fallback).
|
||||||
|
|
||||||
|
**Nicht erneut versuchen, ohne vorher einen echten Browser-Repro zu haben.**
|
||||||
|
|
||||||
|
## 4. npm-Publish zu Gitea (`@sorb/threadnet-call-embedded`)
|
||||||
|
|
||||||
|
Das Embedded-Package (`embedded/web/package.json`, aktuell `0.19.2-threadnet.5`) wird zu
|
||||||
|
Gitea's npm-Registry veröffentlicht (`https://rohana.axion1337.de/api/packages/sorb/npm/`,
|
||||||
|
Scope `@sorb`). Der obere Versionierungs-Track hier (`0.19.2-threadnet.N`) ist unabhängig von
|
||||||
|
den Docker-Image-Tags, unter denen das fertig gebaute Widget im gitops-Repo deployt wird (z.B.
|
||||||
|
`v0.2.3-elementcall-h264` als `threadnet-web`-Image-Tag) - zwei getrennte Versionsschemata für
|
||||||
|
zwei verschiedene Artefakte (npm-Package vs. Docker-Image).
|
||||||
|
|
||||||
|
Der aktuelle Publish-Vorgang läuft manuell/lokal - das committete
|
||||||
|
`.github/workflows/publish-embedded-packages.yaml` zielt noch auf `registry.npmjs.org`/
|
||||||
|
`@element-hq`-Scope (Upstream-Konfiguration, nicht an die Gitea-Registry angepasst). Registry-
|
||||||
|
Zugangsdaten liegen in einer lokalen, **nicht committeten** `.npmrc` - nicht Teil dieses Repos.
|
||||||
|
|
||||||
|
## 5. Bewusst keine Server-seitige ML-Rauschunterdrückung
|
||||||
|
|
||||||
|
Nur der client-seitige WebRTC-Standardtoggle (Echo/Noise/Gain-Suppression, aus derselben
|
||||||
|
Upstream-PR-Linie) wurde übernommen. Bewusst **kein** LiveKit-Agents-basiertes Server-seitiges
|
||||||
|
ML-Noise-Cancellation (z.B. selbst gehostetes DTLN/RNNoise) - LiveKits eigene Dokumentation
|
||||||
|
beschreibt diesen Baustein als für AI-Voice-Agents gedacht, nicht für Mensch-zu-Mensch-Calls
|
||||||
|
(kein unterstützter Weg, bereinigtes Audio an andere Teilnehmer weiterzuleiten).
|
||||||
|
|
||||||
|
## Repo-Topologie (seit 2026-07-31)
|
||||||
|
|
||||||
|
**Kanonisch ist `git.lab/axion1337.chat/threadnet-call`** (Homelab-GitLab) — die Kopie auf
|
||||||
|
`rohana.axion1337.de/sorb/threadnet-call` ist ein automatischer **Push-Mirror** (Lesekopie,
|
||||||
|
Issues, npm-Registry). **Niemals direkt nach rohana pushen** — der Mirror überschreibt
|
||||||
|
divergente Stände.
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
# Global JS controls
|
||||||
|
|
||||||
|
A few aspects of Element Call's interface can be controlled through a global API on the `window`.
|
||||||
|
|
||||||
|
## Picture-in-picture
|
||||||
|
|
||||||
|
- `controls.canEnterPip(): boolean` Determines whether it's possible to enter picture-in-picture mode.
|
||||||
|
- `controls.enablePip(): void` Puts the call interface into picture-in-picture mode. Throws if not in a call.
|
||||||
|
- `controls.disablePip(): void` Takes the call interface out of picture-in-picture mode, restoring it to its natural display mode. Throws if not in a call.
|
||||||
|
|
||||||
|
## Audio devices
|
||||||
|
|
||||||
|
On mobile platforms (iOS, Android), web views do not reliably support selecting audio output devices such as the main speaker, earpiece, or headset. To address this limitation, the following functions allow the hosting application (e.g., Element Web, Element X) to manage audio devices via exposed JavaScript interfaces. These functions must be enabled using the URL parameter `controlledAudioDevices` to take effect.
|
||||||
|
|
||||||
|
- `controls.setAvailableAudioDevices(devices: { id: string, name: string, forEarpiece?: boolean, isEarpiece?: boolean isSpeaker?: boolean, isExternalHeadset?: boolean }[]): void` Sets the list of available audio outputs. `forEarpiece` is used on iOS only.
|
||||||
|
It flags the device that should be used if the user selects earpiece mode. This should be the main stereo loudspeaker of the device.
|
||||||
|
- `controls.onAudioDeviceSelect: ((id: string) => void) | undefined` Callback called whenever the user or application selects a new audio output.
|
||||||
|
- `controls.setAudioDevice(id: string): void` Sets the selected audio device in Element Call's menu. This should be used if the OS decides to automatically switch to Bluetooth, for example.
|
||||||
|
- `controls.setAudioEnabled(enabled: boolean)` Enables/disables all audio output from the application. Output is enabled by default.
|
||||||
|
- `controls.onAudioPlaybackStarted: ((id: string) => void) | undefined`: This will be called the first time we start
|
||||||
|
playing audio in the webview. It can be helpful to do device setup on the native app when the webviews audio is ready.
|
||||||
|
In particular android is using it to setup the output channel so that the call volume can
|
||||||
|
be controlled by the hardware volume rocker.
|
||||||
|
|
||||||
|
## Element Call button delegation
|
||||||
|
|
||||||
|
Callbacks for buttons in EC that are handled by the native application
|
||||||
|
|
||||||
|
- `showNativeAudioDevicePicker: (() => void) | undefined`. Callback called whenever the user presses the output button in the settings menu.
|
||||||
|
This button is only shown on iOS. (`/iPad|iPhone|iPod|Mac/.test(navigator.userAgent)`)
|
||||||
|
- `onBackButtonPressed: (() => void) | undefined`. Callback when the webview detects a tab on the header's back button.
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 941 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 908 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 302 KiB |
@@ -0,0 +1,39 @@
|
|||||||
|
## Element Call packages
|
||||||
|
|
||||||
|
Element Call is available as two different packages: Full Package and Embedded Package.
|
||||||
|
|
||||||
|
The Full Package is designed for standalone use, while the Embedded Package is designed for widget mode only.
|
||||||
|
|
||||||
|
The table below provides a comparison of the two packages:
|
||||||
|
|
||||||
|
| | Full Package | Embedded Package |
|
||||||
|
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| **Supports use as standalone** | ✅ | ❌ |
|
||||||
|
| **Supports use as widget** | ✅ | ✅ |
|
||||||
|
| **Deployment mode** | Hosted as a static web page and accessed via a URL when used as a widget | Bundled within a messenger app for seamless integration |
|
||||||
|
| **Release artifacts** | Docker Image, Tarball | Tarball, NPM for Web, Android AAR, SwiftPM for iOS |
|
||||||
|
| **Recommended for** | Standalone/guest access usage | Embedding within messenger apps |
|
||||||
|
| **Responsibility for regulatory compliance** | The administrator that is deploying the app is responsible for compliance with any applicable regulations (e.g. privacy) | The developer of the messenger app is responsible for compliance |
|
||||||
|
| **Analytics consent** | Element Call will show a consent UI. | Element Call will not show a consent UI. The messenger app should only provide the embedded Element Call with the [analytics URL parameters](./url_params.md#embedded-only-parameters) if consent has been granted. |
|
||||||
|
| **Analytics data** | Element Call will send data to the Posthog, Sentry and Open Telemetry targets specified by the administrator in the `config.json` | Element Call will send data to the Posthog and Sentry targets specified in the URL parameters by the messenger app |
|
||||||
|
|
||||||
|
### Using the embedded package within a messenger app
|
||||||
|
|
||||||
|
Currently the best way to understand the necessary steps is to look at the implementations in the Element Messenger apps: [Web](https://github.com/element-hq/element-web/pull/29309), [iOS](https://github.com/element-hq/element-x-ios/pull/3939) and [Android](https://github.com/element-hq/element-x-android/pull/4470).
|
||||||
|
|
||||||
|
The basics are:
|
||||||
|
|
||||||
|
1. Add the appropriate platform dependency as given for a [release](https://github.com/element-hq/element-call/releases), or use the embedded tarball. e.g. `npm install @element-hq/element-call-embedded@0.9.0`
|
||||||
|
2. Include the assets from the platform dependency in the build process. e.g. copy the assets during a [Webpack](https://github.com/element-hq/element-web/blob/247cd8d56d832d006d7dfb919d1042529d712b59/webpack.config.js#L677-L682) build.
|
||||||
|
3. Use the `index.html` entrypoint of the imported assets when you are constructing the WebView or iframe. e.g. using a [relative path in a webapp](https://github.com/element-hq/element-web/blob/247cd8d56d832d006d7dfb919d1042529d712b59/src/models/Call.ts#L680), or on the the Android [WebViewAssetLoader](https://github.com/element-hq/element-x-android/blob/fe5aab6588ecdcf9354a3bfbd9e97c1b31175a8f/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/DefaultCallWidgetProvider.kt#L20)
|
||||||
|
4. Set any of the [embedded-only URL parameters](./url_params.md#embedded-only-parameters) that you need.
|
||||||
|
|
||||||
|
## Widget vs standalone mode
|
||||||
|
|
||||||
|
Element Call is developed using the [js-sdk](https://github.com/matrix-org/matrix-js-sdk) with matroska mode. This means the app can run either as a standalone app directly connected to a homeserver providing login interfaces or it can be used as a widget within a Matrix client.
|
||||||
|
|
||||||
|
As a widget, the app only uses the core calling (MatrixRTC) parts. The rest (authentication, sending events, getting room state updates about calls) is done by the hosting client.
|
||||||
|
Element Call and the hosting client are connected via the widget API.
|
||||||
|
|
||||||
|
Element Call detects that it is run as a widget if `widgetId` is defined in the url parameters. If `widgetId` is present then Element Call will try to connect to the client via the widget postMessage API using the parameters provided in [Url Format and parameters
|
||||||
|
](./url_params.md).
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 1.2 MiB |
@@ -0,0 +1,65 @@
|
|||||||
|
## Quickstart guide
|
||||||
|
|
||||||
|
Run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/setup-linking.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Read the script output:
|
||||||
|
|
||||||
|
```
|
||||||
|
Setup complete.
|
||||||
|
Update: .links.cjs to your liking
|
||||||
|
Run: 'pnpm links:on' to test your .links.cjs
|
||||||
|
Run: 'git commit' with links enabled to test the git pre-commit hook.
|
||||||
|
Run: 'pnpm links:off' to be able to commit again
|
||||||
|
Run: 'git config --local core.hooksPath ""' to allow committing with linking (not recommended)
|
||||||
|
Run: 'rm links.cjs' & 'git config --local core.hooksPath ""' to fully revert what this script did
|
||||||
|
```
|
||||||
|
|
||||||
|
# Developing with linked packages
|
||||||
|
|
||||||
|
If you want to make changes to a package that Element Call depends on and see those changes applied in real time, you can create a link to a local copy of the package. `pnpm` has a command for this (`pnpm link`), but it's not recommended to use it as it ends up modifying package.json with details specific to your development environment.
|
||||||
|
|
||||||
|
Instead, create a file named `.links.cjs` in the Element Call project directory (or run `./scripts/setup-linking.sh` to create a template), listing the names and paths of any dependencies you want to link. For example:
|
||||||
|
|
||||||
|
```cjs
|
||||||
|
// Packages to link to local checkouts
|
||||||
|
module.exports = {
|
||||||
|
"matrix-js-sdk": "../your/path/matrix-js-sdk",
|
||||||
|
"matrix-widget-api": "../your/path/matrix-widget-api",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run `pnpm links:on`. (this will activate the pnpm file + run `pnpm install` to setup the linking)
|
||||||
|
|
||||||
|
## Hooks
|
||||||
|
|
||||||
|
Changes in `.links.cjs` will also update `pnpm-lock.yaml` when `pnpm install` is executed. The lockfile will then contain the local
|
||||||
|
version of the package which would not work on others dev setups or the github CI.
|
||||||
|
|
||||||
|
One always needs to remove the pnpm `readPackage` script (the `.pnpmfile.cjs`) and run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
before committing a change.
|
||||||
|
|
||||||
|
To make this less of a foot gun we added a git hook.
|
||||||
|
A `pre-commit` hook will check if linking is currently used. If it detects
|
||||||
|
a `.pnpmfile.cjs` file it will abort the commit with an explanatory message.
|
||||||
|
You will then need to run `pnpm links:off` and commit again.
|
||||||
|
|
||||||
|
To activate the hooks configure git with (when using the setup script (`./scripts/setup-linking.sh`) this is already done):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git config --local core.hooksPath .githooks
|
||||||
|
```
|
||||||
|
|
||||||
|
This will add the hook path for this repository only to .gihooks. which is a tracked (by git) folder containing the pre-commit hook.
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
Information, why this approach is used can be found in the [linking concept reasoning](./linking_concept_reasoning.md) document.
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
### Why do we not enable .pnpmfile.cjs by default
|
||||||
|
|
||||||
|
Background: The presence of the `.pnpmfile.cjs` adds a field to the `pnpm-lock.yaml` called: `pnpmfileChecksum`. This field is a checksum of the content of the `.pnpmfile.cjs` file.
|
||||||
|
`pnpm install --frozen-lockfile` **fails** if there is a `.pnpmfile.cjs` but no `pnpmfileChecksum` or vice versa (or on mismatch).
|
||||||
|
|
||||||
|
_TLDR: running with `--ignore-pnpmfile` will fail if `pnpmfileChecksum` is present._
|
||||||
|
|
||||||
|
#### `pnpmfileChecksum` + renovate bot
|
||||||
|
|
||||||
|
When the renovate bot creates a PR it runs `pnpm install --ignore-pnpmfile`. This means that the `pnpmfileChecksum` in the lockfile will be **empty**.
|
||||||
|
This breaks builds that **don't** ignore the `.pnpmfile.cjs`-file. (CI that runs on the renovate PR)
|
||||||
|
From here we have two possible paths:
|
||||||
|
|
||||||
|
- ignore `.pnpmfile.cjs` in all CI builds (CI will also fail if we accidently add it locally).
|
||||||
|
- fixup the `pnpm-lock.yaml` in the renovate PR to contain the correct `pnpmfileChecksum`.
|
||||||
|
|
||||||
|
Ignoring in all CI builds means that CI will always fail if we enable the linking system.
|
||||||
|
This is annoying but can be worked around with the git hook we provide that at least lets us know that we are
|
||||||
|
commiting with enabled linking.
|
||||||
|
Only if we remember setting it back/disbale linking (or let ourselves remember by the git hook) the CI will work.
|
||||||
|
|
||||||
|
#### Summary
|
||||||
|
|
||||||
|
- We will always run into conflicts with the `pnpmfileChecksum` because in renovate prs it will be empty (`--ignore-pnpmfile`)
|
||||||
|
- To keep it simple we set `--ignore-pnpmfile` in all of our CI builds to see issues immediately.
|
||||||
|
- The only solution is to never have a `.pnpmfile.cjs` in the repository when pushing.
|
||||||
|
- This way there will never be a commit with `pnpmfileChecksum` in the lockfile.
|
||||||
|
- renovate (which uses `--ignore-pnpmfile` which we cannot disable) and other CI will work.
|
||||||
|
- We are able to use the linking system locally if we `cp` this file from the scripts folder into `./` on demand.
|
||||||
|
- `pnpm links:on` and `pnpm links:off` + `./scripts/setup-linking.sh` will help us with this.
|
||||||
@@ -0,0 +1,330 @@
|
|||||||
|
# Self-Hosting Element Call
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> For In-App calling (Element X, Element Web, Element Desktop) use-case only
|
||||||
|
> section [Prerequisites](#Prerequisites) is required.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> This section covers the requirements for deploying a **Matrix site**
|
||||||
|
> compatible with MatrixRTC, the foundation of Element Call. These requirements
|
||||||
|
> apply to both Standalone as well as Widget mode operation of Element Call.
|
||||||
|
|
||||||
|
### A Matrix Homeserver
|
||||||
|
|
||||||
|
The following [MSCs](https://github.com/matrix-org/matrix-spec-proposals) are
|
||||||
|
required for Element Call to work properly:
|
||||||
|
|
||||||
|
- **[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
|
||||||
|
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
|
||||||
|
contains the room join rules. We need that information to decide if the user
|
||||||
|
gets prompted with the option to knock ("Request to join call"), a "cannot
|
||||||
|
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)
|
||||||
|
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
|
||||||
|
Matrix rooms.
|
||||||
|
|
||||||
|
- **[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
|
||||||
|
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.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
experimental_features:
|
||||||
|
# MSC3266: Room summary API. Used for knocking over federation
|
||||||
|
msc3266_enabled: true
|
||||||
|
# MSC4222 needed for syncv2 state_after. This allow clients to
|
||||||
|
# correctly track the state of the room.
|
||||||
|
msc4222_enabled: true
|
||||||
|
|
||||||
|
# The maximum allowed duration by which sent events can be delayed, as
|
||||||
|
# per MSC4140.
|
||||||
|
max_event_delay_duration: 24h
|
||||||
|
|
||||||
|
rc_message:
|
||||||
|
# This needs to match at least e2ee key sharing frequency plus a bit of headroom
|
||||||
|
# Note key sharing events are bursty
|
||||||
|
per_second: 0.5
|
||||||
|
burst_count: 30
|
||||||
|
|
||||||
|
rc_delayed_event_mgmt:
|
||||||
|
# This needs to match at least the heart-beat frequency plus a bit of headroom
|
||||||
|
# Currently the heart-beat is every 5 seconds which translates into a rate of 0.2Hz
|
||||||
|
per_second: 1
|
||||||
|
burst_count: 20
|
||||||
|
```
|
||||||
|
|
||||||
|
As a prerequisite for the
|
||||||
|
[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
|
||||||
|
make sure that your Synapse server has either a `federation` or `openid`
|
||||||
|
[listener configured](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#listeners).
|
||||||
|
|
||||||
|
### MatrixRTC Backend
|
||||||
|
|
||||||
|
In order to **guarantee smooth operation** of Element Call, a MatrixRTC backend is
|
||||||
|
required for each site deployment.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
As depicted above in the `example.com` site deployment, Element Call requires a
|
||||||
|
[Livekit SFU](https://github.com/livekit/livekit) alongside a
|
||||||
|
[MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service)
|
||||||
|
to implement
|
||||||
|
[MSC4195: MatrixRTC using LiveKit backend](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md).
|
||||||
|
|
||||||
|
#### Matrix site endpoint routing
|
||||||
|
|
||||||
|
In the context of MatrixRTC, we suggest using a single hostname for backend
|
||||||
|
communication by implementing endpoint routing within a reverse proxy setup. For
|
||||||
|
the example above, this results in:
|
||||||
|
| Service | Endpoint | Example |
|
||||||
|
| -------- | ------- | ------- |
|
||||||
|
| [Livekit SFU](https://github.com/livekit/livekit) WebSocket signalling connection | `/livekit/sfu` | `matrix-rtc.example.com/livekit/sfu` |
|
||||||
|
| [MatrixRTC Authorization Service](https://github.com/element-hq/lk-jwt-service) | `/livekit/jwt` | `matrix-rtc.example.com/livekit/jwt` |
|
||||||
|
|
||||||
|
Using Nginx, you can achieve this by:
|
||||||
|
|
||||||
|
```nginx configuration file
|
||||||
|
server {
|
||||||
|
...
|
||||||
|
location ^~ /livekit/jwt/ {
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
# MatrixRTC Authorization Service running at port 8080
|
||||||
|
proxy_pass http://localhost:8080/;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ^~ /livekit/sfu/ {
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
|
||||||
|
proxy_send_timeout 120;
|
||||||
|
proxy_read_timeout 120;
|
||||||
|
proxy_buffering off;
|
||||||
|
|
||||||
|
proxy_set_header Accept-Encoding gzip;
|
||||||
|
proxy_set_header Upgrade $http_upgrade;
|
||||||
|
proxy_set_header Connection "upgrade";
|
||||||
|
|
||||||
|
# LiveKit SFU websocket connection running at port 7880
|
||||||
|
proxy_pass http://localhost:7880/;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Or Using Caddy, you can achieve this by:
|
||||||
|
|
||||||
|
```caddy configuration file
|
||||||
|
# Route for lk-jwt-service with livekit/jwt prefix
|
||||||
|
@jwt_service path /livekit/jwt/sfu/get /livekit/jwt/healthz
|
||||||
|
handle @jwt_service {
|
||||||
|
uri strip_prefix /livekit/jwt
|
||||||
|
reverse_proxy http://[::1]:8080 {
|
||||||
|
header_up Host {host}
|
||||||
|
header_up X-Forwarded-Server {host}
|
||||||
|
header_up X-Real-IP {remote_host}
|
||||||
|
header_up X-Forwarded-For {remote_host}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Default route for livekit
|
||||||
|
handle {
|
||||||
|
reverse_proxy http://localhost:7880 {
|
||||||
|
header_up Host {host}
|
||||||
|
header_up X-Forwarded-Server {host}
|
||||||
|
header_up X-Real-IP {remote_host}
|
||||||
|
header_up X-Forwarded-For {remote_host}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Using Haproxy, you can achieve this by:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Frontend
|
||||||
|
# Match /livekit/sfu/ path
|
||||||
|
acl is_sfu path_beg -i /livekit/sfu/
|
||||||
|
use_backend sfu_backend if is_sfu matrixrtc_domain
|
||||||
|
|
||||||
|
acl is_mxrtc_auth path_beg -i /sfu/get
|
||||||
|
use_backend mxrtc_auth_backend if is_mxrtc_auth matrixrtc_domain
|
||||||
|
|
||||||
|
# Backend
|
||||||
|
## MatrixRTC backend
|
||||||
|
backend sfu_backend
|
||||||
|
server livekit 127.0.0.1:7880
|
||||||
|
http-request set-path %[path,regsub(^/livekit/sfu/,/)]
|
||||||
|
http-request set-header Host %[req.hdr(host)]
|
||||||
|
timeout server 120s
|
||||||
|
# WebSocket support
|
||||||
|
option forwardfor
|
||||||
|
option http-server-close
|
||||||
|
option http-buffer-request
|
||||||
|
|
||||||
|
backend mxrtc_auth_backend
|
||||||
|
server sfu 127.0.0.1:8070
|
||||||
|
http-request set-header Host %[req.hdr(host)]
|
||||||
|
timeout server 120s
|
||||||
|
# WebSocket support
|
||||||
|
option forwardfor
|
||||||
|
option http-server-close
|
||||||
|
option http-buffer-request
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
#### MatrixRTC backend announcement
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> As defined in
|
||||||
|
> [MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143),
|
||||||
|
> the MatrixRTC backend(s) must be announced to the client via your **Matrix site's
|
||||||
|
> `.well-known/matrix/client`** file (e.g.
|
||||||
|
> `example.com/.well-known/matrix/client` matching the site deployment example
|
||||||
|
> from above). The configuration is a list of Foci configs:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"org.matrix.msc4143.rtc_foci": [
|
||||||
|
{
|
||||||
|
"type": "livekit",
|
||||||
|
"livekit_service_url": "https://matrix-rtc.example.com/livekit/jwt"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "livekit",
|
||||||
|
"livekit_service_url": "https://matrix-rtc-2.example.com/livekit/jwt"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
Make sure this file is served with the correct MIME type (`application/json`).
|
||||||
|
Additionally, ensure the appropriate CORS headers are set to allow web clients
|
||||||
|
to access it across origins. For more details, refer to the
|
||||||
|
[Matrix Client-Server API: 2. Web Browser Clients](https://spec.matrix.org/latest/client-server-api/#web-browser-clients).
|
||||||
|
|
||||||
|
```
|
||||||
|
Access-Control-Allow-Origin: *
|
||||||
|
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
|
||||||
|
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Authorization
|
||||||
|
```
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> Most `org.matrix.msc4143.rtc_foci` configurations will only have one entry in
|
||||||
|
> the array.
|
||||||
|
|
||||||
|
## Building Element Call
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This step is only required if you want to deploy Element Call in Standalone
|
||||||
|
> mode.
|
||||||
|
|
||||||
|
Until prebuilt tarballs are available, you'll need to build Element Call from
|
||||||
|
source. First, clone and install the package:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://github.com/element-hq/element-call.git
|
||||||
|
cd element-call
|
||||||
|
corepack enable
|
||||||
|
pnpm install
|
||||||
|
pnpm 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 that can be configured
|
||||||
|
with custom routes (see below).
|
||||||
|
|
||||||
|
You also need to add a configuration file which goes in `public/config.json` -
|
||||||
|
you can use the sample as a starting point:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cp config/config.sample.json public/config.json
|
||||||
|
# edit public/config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
The sample needs editing to contain the homeserver that you are using.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
```nginx configuration file
|
||||||
|
server {
|
||||||
|
...
|
||||||
|
location / {
|
||||||
|
...
|
||||||
|
try_files $uri /$uri /index.html;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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](../src/config/ConfigOptions.ts).
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> Please note configuring MatrixRTC backend via `config.json` of
|
||||||
|
> Element Call is only available for developing and debug purposes. Relying on
|
||||||
|
> it might break Element Call going forward!
|
||||||
|
|
||||||
|
## A Note on Standalone Mode of Element Call
|
||||||
|
|
||||||
|
Element Call in Standalone mode requires a homeserver with registration enabled
|
||||||
|
without any 3pid or token requirements, if you want it to be used by
|
||||||
|
unregistered users. Furthermore, it is not recommended to use it with an
|
||||||
|
existing homeserver where user accounts have joined normal rooms, as it may not
|
||||||
|
be able to handle those yet and it may behave unreliably.
|
||||||
|
|
||||||
|
Therefore, to use a self-hosted homeserver, this is recommended to be a new
|
||||||
|
server where any user account created has not joined any normal rooms anywhere
|
||||||
|
in the Matrix federated network. The homeserver used can be set up to disable
|
||||||
|
federation, so as to prevent spam registrations (if you keep registrations open)
|
||||||
|
and to ensure Element Call continues to work in case any user decides to log in
|
||||||
|
to their Element Call account using the standard Element app and joins normal
|
||||||
|
rooms that Element Call cannot handle.
|
||||||
|
|
||||||
|
# 📚 Community Guides & How-Tos
|
||||||
|
|
||||||
|
Looking for real-world tips, tutorials, and experiences from the community?
|
||||||
|
Below is a collection of blog posts, walkthroughs, and how-tos created by other
|
||||||
|
self-hosters and developers working with Element Call.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> These resources are community-created and may reflect different setups or
|
||||||
|
> versions. Use them alongside the official documentation for best results.
|
||||||
|
|
||||||
|
## 🌐 Blog Posts & Articles
|
||||||
|
|
||||||
|
- [How to resolve stuck MatrixRTC calls](https://sspaeth.de/2025/02/how-to-resolve-stuck-matrixrtc-calls/)
|
||||||
|
|
||||||
|
## 📝 How-Tos & Tutorials
|
||||||
|
|
||||||
|
- [MatrixRTC aka Element-call setup (Geek warning)](https://sspaeth.de/2024/11/sfu/)
|
||||||
|
- [MatrixRTC with Synology Container Manager (Docker)](https://ztfr.de/matrixrtc-with-synology-container-manager-docker/)
|
||||||
|
- [Encrypted & Scalable Video Calls: How to deploy an Element Call backend with Synapse Using Docker-Compose](https://willlewis.co.uk/blog/posts/deploy-element-call-backend-with-synapse-and-docker-compose/)
|
||||||
|
- [Element Call einrichten: Verschlüsselte Videoanrufe mit Element X und Matrix Synapse](https://www.cleveradmin.de/blog/2025/04/matrixrtc-element-call-backend-einrichten/)
|
||||||
|
- [MatrixRTC Back-End for Synapse with Docker Compose and Traefik](https://forge.avontech.net/kstro1/matrixrtc-docker-traefik/)
|
||||||
|
|
||||||
|
## 🛠️ Tools
|
||||||
|
|
||||||
|
- [A Matrix server sanity tester including tests for proper MatrixRTC setup](https://codeberg.org/spaetz/testmatrix)
|
||||||
|
|
||||||
|
## 🤝 Want to Contribute?
|
||||||
|
|
||||||
|
Have a guide or blog post you'd like to share? Open a
|
||||||
|
[PR](https://github.com/element-hq/element-call/pulls) to add it here, or drop a
|
||||||
|
link in the [#webrtc:matrix.org](https://matrix.to/#/#webrtc:matrix.org) room.
|
||||||
@@ -0,0 +1,100 @@
|
|||||||
|
# URL Format and parameters
|
||||||
|
|
||||||
|
There are two formats for Element Call URLs.
|
||||||
|
|
||||||
|
## Link for sharing
|
||||||
|
|
||||||
|
Requires Element Call to be deployed in [standalone](./embedded_standalone.md) mode.
|
||||||
|
|
||||||
|
```text
|
||||||
|
https://element_call.domain/room/#
|
||||||
|
/<room_name_alias>?roomId=!id:domain&password=1234&<other params see below>
|
||||||
|
```
|
||||||
|
|
||||||
|
The URL is split into two sections. The `https://element_call.domain/room/#`
|
||||||
|
contains the app and the intent that the link brings you into a specific room
|
||||||
|
(`https://call.element.io/#` would be the homepage). The fragment is used for
|
||||||
|
query parameters to make sure they never get sent to the element_call.domain
|
||||||
|
server. Here we have the actual Matrix room ID and the password which are used
|
||||||
|
to connect all participants with E2EE. This allows that `<room_name_alias>` does
|
||||||
|
not need to be unique. Multiple meetings with the label weekly-sync can be created
|
||||||
|
without collisions.
|
||||||
|
|
||||||
|
Additionally the following **deprecated** format is supported:
|
||||||
|
|
||||||
|
```text
|
||||||
|
https://element_call.domain/<room_name>
|
||||||
|
```
|
||||||
|
|
||||||
|
With this format the livekit alias that will be used is the `<room_name>`.
|
||||||
|
All people connecting to this URL will end up in the same unencrypted room.
|
||||||
|
This does not scale, is super unsecure
|
||||||
|
(people could end up in the same room by accident) and it also is not really
|
||||||
|
possible to support encryption.
|
||||||
|
|
||||||
|
## Widget within a messenger app
|
||||||
|
|
||||||
|
| Package | Deployment | URL |
|
||||||
|
| ------------------------------------ | ----------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| [Full](./embedded_standalone.md) | All | `https://element_call.domain/room` |
|
||||||
|
| [Embedded](./embedded_standalone.md) | Remote URL | `https://element_call.domain/` n.b. no `/room` part |
|
||||||
|
| [Embedded](./embedded_standalone.md) | Embedded within messenger app | Platform dependent, but you load the `index.html` file without a `/room` part |
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
### Common Parameters
|
||||||
|
|
||||||
|
These parameters are relevant to both [widget](./embedded_standalone.md) and [standalone](./embedded_standalone.md) modes:
|
||||||
|
|
||||||
|
| Name | Values | Required for widget | Required for SPA | Description |
|
||||||
|
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `intent` | `start_call`, `join_existing`, `start_call_voice`, `join_existing_voice`, `start_call_dm`, `join_existing_dm`, `start_call_dm_voice`, or `join_existing_dm_voice`. | No, defaults to `start_call` | No, defaults to `start_call` | The intent is a special url parameter that defines the defaults for all the other parameters. In most cases it should be enough to only set the intent to setup element-call. |
|
||||||
|
| `allowIceFallback` | `true` or `false` | No, defaults to `false` | No, defaults to `false` | Allows use of fallback STUN servers for ICE if the user's homeserver doesn’t provide any. |
|
||||||
|
| `posthogUserId` | Posthog analytics ID | No | No | Available only with user's consent for sharing telemetry in Element Web. |
|
||||||
|
| `confineToRoom` | `true` or `false` | No, defaults to `false` | No, defaults to `false` | Keeps the user confined to the current call/room. |
|
||||||
|
| `displayName` | | No | No | Display name used for auto-registration. |
|
||||||
|
| `enableE2EE` (deprecated) | `true` or `false` | No, defaults to `true` | No, defaults to `true` | Legacy flag to enable end-to-end encryption, not used in the `livekit` branch. |
|
||||||
|
| `fontScale` | A decimal number such as `0.9` | No, defaults to `1.0` | No, defaults to `1.0` | Factor by which to scale the interface's font size. |
|
||||||
|
| `fonts` | | No | No | Defines the font(s) used by the interface. Multiple font parameters can be specified: `?font=font-one&font=font-two...`. |
|
||||||
|
| `header` | `none`, `standard` or `app_bar` | No, defaults to `standard` | No, defaults to `standard` | The style of headers to show. `standard` is the default arrangement, `none` hides the header entirely, and `app_bar` produces a header with a back button like you might see in mobile apps. The callback for the back button is `window.controls.onBackButtonPressed`. |
|
||||||
|
| `hideScreensharing` | `true` or `false` | No, defaults to `false` | No, defaults to `false` | Hides the screen-sharing button. |
|
||||||
|
| `homeserver` | | Not applicable | No | Homeserver for registering a new (guest) user, configures non-default guest user server when creating a spa link. |
|
||||||
|
| `lang` | [BCP 47](https://www.rfc-editor.org/info/bcp47) code | No | No | The language the app should use. |
|
||||||
|
| `password` | | No | No | E2EE password when using a shared secret. (For individual sender keys in embedded mode this is not required.) |
|
||||||
|
| `perParticipantE2EE` | `true` or `false` | No, defaults to `false` | No, defaults to `false` | Enables per participant encryption with Keys exchanged over encrypted matrix room messages. |
|
||||||
|
| `controlledAudioDevices` | `true` or `false` | No, defaults to `false` | No, defaults to `false` | Whether the [global JS controls for audio devices](./controls.md#audio-devices) should be enabled, allowing the list of audio devices to be controlled by the app hosting Element Call. |
|
||||||
|
| `roomId` | [Matrix Room ID](https://spec.matrix.org/v1.12/appendices/#room-ids) | Yes | No | Anything about what room we're pointed to should be from useRoomIdentifier which parses the path and resolves alias with respect to the default server name, however roomId is an exception as we need the room ID in embedded widget mode, and not the room alias (or even the via params because we are not trying to join it). This is also not validated, where it is in `useRoomIdentifier()`. |
|
||||||
|
| `showControls` | `true` or `false` | No, defaults to `true` | No, defaults to `true` | Displays controls like mute, screen-share, invite, and hangup buttons during a call. |
|
||||||
|
| `skipLobby` (deprecated: use `intent` instead) | `true` or `false` | No. If `intent` is explicitly `start_call` then defaults to `true`. Otherwise defaults to `false` | No, defaults to `false` | Skips the lobby to join a call directly, can be combined with preload in widget. When `true` the audio and video inputs will be muted by default. (This means there currently is no way to start without muted video if one wants to skip the lobby. Also not in widget mode.) |
|
||||||
|
| `theme` | One of: `light`, `dark`, `light-high-contrast`, `dark-high-contrast` | No, defaults to `dark` | No, defaults to `dark` | UI theme to use. |
|
||||||
|
| `viaServers` | Comma separated list of [Matrix Server Names](https://spec.matrix.org/v1.12/appendices/#server-name) | Not applicable | No | Homeserver for joining a room, non-empty value required for rooms not on the user’s default homeserver. |
|
||||||
|
| `sendNotificationType` | `ring` or `notification` | No | No | Will send a "ring" or "notification" `m.rtc.notification` event if the user is the first one in the call. |
|
||||||
|
| `autoLeaveWhenOthersLeft` | `true` or `false` | No, defaults to `false` | No, defaults to `false` | Whether the app should automatically leave the call when there is no one left in the call. |
|
||||||
|
| `waitForCallPickup` | `true` or `false` | No, defaults to `false` | No, defaults to `false` | When sending a notification, show UI that the app is awaiting an answer, play a dial tone, and (in widget mode) auto-close the widget once the notification expires. |
|
||||||
|
|
||||||
|
### Widget-only parameters
|
||||||
|
|
||||||
|
These parameters are only supported in [widget](./embedded_standalone.md) mode.
|
||||||
|
|
||||||
|
| Name | Values | Required | Description |
|
||||||
|
| --------------- | ----------------------------------------------------------------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `baseUrl` | | Yes | The base URL of the homeserver to use for media lookups. |
|
||||||
|
| `deviceId` | Matrix device ID | Yes | The Matrix device ID for the widget host. |
|
||||||
|
| `parentUrl` | | Yes | The url used to send widget action postMessages. This should be the domain of the client or the webview the widget is hosted in. (In case the widget is not in an Iframe but in a dedicated webview, we send the postMessages in the same WebView the widget lives in. Filtering is done in the widget so it ignores the messages it receives from itself.) |
|
||||||
|
| `posthogUserId` | Posthog user identifier | No | This replaces the `analyticsID` parameter |
|
||||||
|
| `preload` | `true` or `false` | No, defaults to `false` | Pauses app before joining a call until an `io.element.join` widget action is seen, allowing preloading. |
|
||||||
|
| `returnToLobby` | `true` or `false` | No, defaults to `false` | Displays the lobby in widget mode after leaving a call; shows a blank page if set to `false`. Useful for video rooms. |
|
||||||
|
| `userId` | [Matrix User Identifier](https://spec.matrix.org/v1.12/appendices/#user-identifiers) | Yes | The Matrix user ID. |
|
||||||
|
| `widgetId` | [MSC2774](https://github.com/matrix-org/matrix-spec-proposals/pull/2774) format widget ID | Yes | The id used by the widget. The presence of this parameter implies that element call will not connect to a homeserver directly and instead tries to establish postMessage communication via the `parentUrl`. |
|
||||||
|
|
||||||
|
### Embedded-only parameters
|
||||||
|
|
||||||
|
These parameters are only supported in the [embedded](./embedded_standalone.md) package of Element Call and will be ignored in the [full](./embedded_standalone.md) package.
|
||||||
|
|
||||||
|
| Name | Values | Required | Description |
|
||||||
|
| -------------------- | -------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `posthogApiHost` | Posthog server URL | No | e.g. `https://posthog-element-call.element.io`. Only supported in embedded package. In full package the value from config is used. |
|
||||||
|
| `posthogApiKey` | Posthog project API key | No | Only supported in embedded package. In full package the value from config is used. |
|
||||||
|
| `rageshakeSubmitUrl` | Rageshake server URL endpoint | No | e.g. `https://rageshakes.element.io/api/submit`. In full package the value from config is used. |
|
||||||
|
| `sentryDsn` | Sentry [DSN](https://docs.sentry.io/concepts/key-terms/dsn-explainer/) | No | In full package the value from config is used. |
|
||||||
|
| `sentryEnvironment` | Sentry [environment](https://docs.sentry.io/concepts/key-terms/key-terms/) | No | In full package the value from config is used. |
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
#
|
||||||
|
# https://help.github.com/articles/dealing-with-line-endings/
|
||||||
|
#
|
||||||
|
# Linux start script should use lf
|
||||||
|
/gradlew text eol=lf
|
||||||
|
|
||||||
|
# These are Windows script files and should use crlf
|
||||||
|
*.bat text eol=crlf
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# Ignore Gradle project-specific cache directory
|
||||||
|
.gradle
|
||||||
|
|
||||||
|
# Ignore Gradle build output directory
|
||||||
|
build
|
||||||
|
|
||||||
|
# Ignore local gradle properties file
|
||||||
|
local.properties
|
||||||
|
|
||||||
|
# Also ignore the generated assets for Android
|
||||||
|
lib/src/main/assets
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# This file was generated by the Gradle 'init' task.
|
||||||
|
# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties
|
||||||
|
|
||||||
|
org.gradle.parallel=true
|
||||||
|
org.gradle.caching=true
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# This file was generated by the Gradle 'init' task.
|
||||||
|
# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format
|
||||||
|
|
||||||
|
[versions]
|
||||||
|
android_gradle_plugin = "8.13.2"
|
||||||
|
|
||||||
|
[libraries]
|
||||||
|
android_gradle_plugin = { module = "com.android.tools.build:gradle", version.ref = "android_gradle_plugin" }
|
||||||
|
|
||||||
|
[plugins]
|
||||||
|
android_library = { id = "com.android.library", version.ref = "android_gradle_plugin" }
|
||||||
|
maven_publish = { id = "com.vanniktech.maven.publish", version = "0.36.0" }
|
||||||
Binary file not shown.
@@ -0,0 +1,7 @@
|
|||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.5-all.zip
|
||||||
|
networkTimeout=10000
|
||||||
|
validateDistributionUrl=true
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
zipStorePath=wrapper/dists
|
||||||
+251
@@ -0,0 +1,251 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
#
|
||||||
|
# Copyright © 2015-2021 the original authors.
|
||||||
|
#
|
||||||
|
# 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
|
||||||
|
#
|
||||||
|
# https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# 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.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
#
|
||||||
|
|
||||||
|
##############################################################################
|
||||||
|
#
|
||||||
|
# Gradle start up script for POSIX generated by Gradle.
|
||||||
|
#
|
||||||
|
# Important for running:
|
||||||
|
#
|
||||||
|
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
|
||||||
|
# noncompliant, but you have some other compliant shell such as ksh or
|
||||||
|
# bash, then to run this script, type that shell name before the whole
|
||||||
|
# command line, like:
|
||||||
|
#
|
||||||
|
# ksh Gradle
|
||||||
|
#
|
||||||
|
# Busybox and similar reduced shells will NOT work, because this script
|
||||||
|
# requires all of these POSIX shell features:
|
||||||
|
# * functions;
|
||||||
|
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
|
||||||
|
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
|
||||||
|
# * compound commands having a testable exit status, especially «case»;
|
||||||
|
# * various built-in commands including «command», «set», and «ulimit».
|
||||||
|
#
|
||||||
|
# Important for patching:
|
||||||
|
#
|
||||||
|
# (2) This script targets any POSIX shell, so it avoids extensions provided
|
||||||
|
# by Bash, Ksh, etc; in particular arrays are avoided.
|
||||||
|
#
|
||||||
|
# The "traditional" practice of packing multiple parameters into a
|
||||||
|
# space-separated string is a well documented source of bugs and security
|
||||||
|
# problems, so this is (mostly) avoided, by progressively accumulating
|
||||||
|
# options in "$@", and eventually passing that to Java.
|
||||||
|
#
|
||||||
|
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
|
||||||
|
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
|
||||||
|
# see the in-line comments for details.
|
||||||
|
#
|
||||||
|
# There are tweaks for specific operating systems such as AIX, CygWin,
|
||||||
|
# Darwin, MinGW, and NonStop.
|
||||||
|
#
|
||||||
|
# (3) This script is generated from the Groovy template
|
||||||
|
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
|
||||||
|
# within the Gradle project.
|
||||||
|
#
|
||||||
|
# You can find Gradle at https://github.com/gradle/gradle/.
|
||||||
|
#
|
||||||
|
##############################################################################
|
||||||
|
|
||||||
|
# Attempt to set APP_HOME
|
||||||
|
|
||||||
|
# Resolve links: $0 may be a link
|
||||||
|
app_path=$0
|
||||||
|
|
||||||
|
# Need this for daisy-chained symlinks.
|
||||||
|
while
|
||||||
|
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
|
||||||
|
[ -h "$app_path" ]
|
||||||
|
do
|
||||||
|
ls=$( ls -ld "$app_path" )
|
||||||
|
link=${ls#*' -> '}
|
||||||
|
case $link in #(
|
||||||
|
/*) app_path=$link ;; #(
|
||||||
|
*) app_path=$APP_HOME$link ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
# This is normally unused
|
||||||
|
# shellcheck disable=SC2034
|
||||||
|
APP_BASE_NAME=${0##*/}
|
||||||
|
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||||
|
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
|
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
|
MAX_FD=maximum
|
||||||
|
|
||||||
|
warn () {
|
||||||
|
echo "$*"
|
||||||
|
} >&2
|
||||||
|
|
||||||
|
die () {
|
||||||
|
echo
|
||||||
|
echo "$*"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
} >&2
|
||||||
|
|
||||||
|
# OS specific support (must be 'true' or 'false').
|
||||||
|
cygwin=false
|
||||||
|
msys=false
|
||||||
|
darwin=false
|
||||||
|
nonstop=false
|
||||||
|
case "$( uname )" in #(
|
||||||
|
CYGWIN* ) cygwin=true ;; #(
|
||||||
|
Darwin* ) darwin=true ;; #(
|
||||||
|
MSYS* | MINGW* ) msys=true ;; #(
|
||||||
|
NONSTOP* ) nonstop=true ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
CLASSPATH="\\\"\\\""
|
||||||
|
|
||||||
|
|
||||||
|
# Determine the Java command to use to start the JVM.
|
||||||
|
if [ -n "$JAVA_HOME" ] ; then
|
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||||
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
|
JAVACMD=$JAVA_HOME/jre/sh/java
|
||||||
|
else
|
||||||
|
JAVACMD=$JAVA_HOME/bin/java
|
||||||
|
fi
|
||||||
|
if [ ! -x "$JAVACMD" ] ; then
|
||||||
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
JAVACMD=java
|
||||||
|
if ! command -v java >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can.
|
||||||
|
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
|
||||||
|
case $MAX_FD in #(
|
||||||
|
max*)
|
||||||
|
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
|
||||||
|
# shellcheck disable=SC2039,SC3045
|
||||||
|
MAX_FD=$( ulimit -H -n ) ||
|
||||||
|
warn "Could not query maximum file descriptor limit"
|
||||||
|
esac
|
||||||
|
case $MAX_FD in #(
|
||||||
|
'' | soft) :;; #(
|
||||||
|
*)
|
||||||
|
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
|
||||||
|
# shellcheck disable=SC2039,SC3045
|
||||||
|
ulimit -n "$MAX_FD" ||
|
||||||
|
warn "Could not set maximum file descriptor limit to $MAX_FD"
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Collect all arguments for the java command, stacking in reverse order:
|
||||||
|
# * args from the command line
|
||||||
|
# * the main class name
|
||||||
|
# * -classpath
|
||||||
|
# * -D...appname settings
|
||||||
|
# * --module-path (only if needed)
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
|
||||||
|
|
||||||
|
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||||
|
if "$cygwin" || "$msys" ; then
|
||||||
|
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||||
|
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||||
|
|
||||||
|
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||||
|
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
for arg do
|
||||||
|
if
|
||||||
|
case $arg in #(
|
||||||
|
-*) false ;; # don't mess with options #(
|
||||||
|
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
|
||||||
|
[ -e "$t" ] ;; #(
|
||||||
|
*) false ;;
|
||||||
|
esac
|
||||||
|
then
|
||||||
|
arg=$( cygpath --path --ignore --mixed "$arg" )
|
||||||
|
fi
|
||||||
|
# Roll the args list around exactly as many times as the number of
|
||||||
|
# args, so each arg winds up back in the position where it started, but
|
||||||
|
# possibly modified.
|
||||||
|
#
|
||||||
|
# NB: a `for` loop captures its iteration list before it begins, so
|
||||||
|
# changing the positional parameters here affects neither the number of
|
||||||
|
# iterations, nor the values presented in `arg`.
|
||||||
|
shift # remove old arg
|
||||||
|
set -- "$@" "$arg" # push replacement arg
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||||
|
|
||||||
|
# Collect all arguments for the java command:
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||||
|
# and any embedded shellness will be escaped.
|
||||||
|
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
|
||||||
|
# treated as '${Hostname}' itself on the command line.
|
||||||
|
|
||||||
|
set -- \
|
||||||
|
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||||
|
-classpath "$CLASSPATH" \
|
||||||
|
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
|
||||||
|
"$@"
|
||||||
|
|
||||||
|
# Stop when "xargs" is not available.
|
||||||
|
if ! command -v xargs >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "xargs is not available"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Use "xargs" to parse quoted args.
|
||||||
|
#
|
||||||
|
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
|
||||||
|
#
|
||||||
|
# In Bash we could simply go:
|
||||||
|
#
|
||||||
|
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
|
||||||
|
# set -- "${ARGS[@]}" "$@"
|
||||||
|
#
|
||||||
|
# but POSIX shell has neither arrays nor command substitution, so instead we
|
||||||
|
# post-process each arg (as a line of input to sed) to backslash-escape any
|
||||||
|
# character that might be a shell metacharacter, then use eval to reverse
|
||||||
|
# that process (while maintaining the separation between arguments), and wrap
|
||||||
|
# the whole thing up as a single "set" statement.
|
||||||
|
#
|
||||||
|
# This will of course break if any of these variables contains a newline or
|
||||||
|
# an unmatched quote.
|
||||||
|
#
|
||||||
|
|
||||||
|
eval "set -- $(
|
||||||
|
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
|
||||||
|
xargs -n1 |
|
||||||
|
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
|
||||||
|
tr '\n' ' '
|
||||||
|
)" '"$@"'
|
||||||
|
|
||||||
|
exec "$JAVACMD" "$@"
|
||||||
Vendored
+94
@@ -0,0 +1,94 @@
|
|||||||
|
@rem
|
||||||
|
@rem Copyright 2015 the original author or authors.
|
||||||
|
@rem
|
||||||
|
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@rem you may not use this file except in compliance with the License.
|
||||||
|
@rem You may obtain a copy of the License at
|
||||||
|
@rem
|
||||||
|
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
@rem
|
||||||
|
@rem Unless required by applicable law or agreed to in writing, software
|
||||||
|
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
@rem See the License for the specific language governing permissions and
|
||||||
|
@rem limitations under the License.
|
||||||
|
@rem
|
||||||
|
@rem SPDX-License-Identifier: Apache-2.0
|
||||||
|
@rem
|
||||||
|
|
||||||
|
@if "%DEBUG%"=="" @echo off
|
||||||
|
@rem ##########################################################################
|
||||||
|
@rem
|
||||||
|
@rem Gradle startup script for Windows
|
||||||
|
@rem
|
||||||
|
@rem ##########################################################################
|
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell
|
||||||
|
if "%OS%"=="Windows_NT" setlocal
|
||||||
|
|
||||||
|
set DIRNAME=%~dp0
|
||||||
|
if "%DIRNAME%"=="" set DIRNAME=.
|
||||||
|
@rem This is normally unused
|
||||||
|
set APP_BASE_NAME=%~n0
|
||||||
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||||
|
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||||
|
|
||||||
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||||
|
|
||||||
|
@rem Find java.exe
|
||||||
|
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||||
|
|
||||||
|
set JAVA_EXE=java.exe
|
||||||
|
%JAVA_EXE% -version >NUL 2>&1
|
||||||
|
if %ERRORLEVEL% equ 0 goto execute
|
||||||
|
|
||||||
|
echo. 1>&2
|
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
|
||||||
|
echo. 1>&2
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
|
||||||
|
echo location of your Java installation. 1>&2
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:findJavaFromJavaHome
|
||||||
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto execute
|
||||||
|
|
||||||
|
echo. 1>&2
|
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
|
||||||
|
echo. 1>&2
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
|
||||||
|
echo location of your Java installation. 1>&2
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:execute
|
||||||
|
@rem Setup the command line
|
||||||
|
|
||||||
|
set CLASSPATH=
|
||||||
|
|
||||||
|
|
||||||
|
@rem Execute Gradle
|
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
|
||||||
|
|
||||||
|
:end
|
||||||
|
@rem End local scope for the variables with windows NT shell
|
||||||
|
if %ERRORLEVEL% equ 0 goto mainEnd
|
||||||
|
|
||||||
|
:fail
|
||||||
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
|
rem the _cmd.exe /c_ return code!
|
||||||
|
set EXIT_CODE=%ERRORLEVEL%
|
||||||
|
if %EXIT_CODE% equ 0 set EXIT_CODE=1
|
||||||
|
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
|
||||||
|
exit /b %EXIT_CODE%
|
||||||
|
|
||||||
|
:mainEnd
|
||||||
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|
||||||
|
:omega
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 New Vector Ltd.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
||||||
|
* Please see LICENSE files in the repository root for full details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
alias(libs.plugins.android.library)
|
||||||
|
alias(libs.plugins.maven.publish)
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
google()
|
||||||
|
}
|
||||||
|
|
||||||
|
android {
|
||||||
|
namespace = "io.element.android"
|
||||||
|
|
||||||
|
defaultConfig {
|
||||||
|
compileSdk = 35
|
||||||
|
minSdk = 24
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
mavenPublishing {
|
||||||
|
publishToMavenCentral(automaticRelease = true)
|
||||||
|
|
||||||
|
signAllPublications()
|
||||||
|
|
||||||
|
val version = System.getenv("EC_VERSION")
|
||||||
|
coordinates("io.element.android", "element-call-embedded", version)
|
||||||
|
pom {
|
||||||
|
name = "Embedded Element Call for Android"
|
||||||
|
description.set("Android AAR package containing an embedded build of the Element Call widget.")
|
||||||
|
inceptionYear.set("2025")
|
||||||
|
url.set("https://github.com/element-hq/element-call/")
|
||||||
|
licenses {
|
||||||
|
license {
|
||||||
|
name.set("GNU Affero General Public License (AGPL) version 3.0")
|
||||||
|
url.set("https://www.gnu.org/licenses/agpl-3.0.txt")
|
||||||
|
distribution.set("https://www.gnu.org/licenses/agpl-3.0.txt")
|
||||||
|
}
|
||||||
|
license {
|
||||||
|
name.set("Element Commercial License")
|
||||||
|
url.set("https://raw.githubusercontent.com/element-hq/element-call/refs/heads/livekit/LICENSE-COMMERCIAL")
|
||||||
|
distribution.set("https://raw.githubusercontent.com/element-hq/element-call/refs/heads/livekit/LICENSE-COMMERCIAL")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
developers {
|
||||||
|
developer {
|
||||||
|
id.set("matrixdev")
|
||||||
|
name.set("matrixdev")
|
||||||
|
url.set("https://github.com/element-hq/")
|
||||||
|
email.set("android@element.io")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
scm {
|
||||||
|
url.set("https://github.com/element-hq/element-call/")
|
||||||
|
connection.set("scm:git:git://github.com/element-hq/element-call.git")
|
||||||
|
developerConnection.set("scm:git:ssh://git@github.com/element-hq/element-call.git")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 New Vector Ltd.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
||||||
|
* Please see LICENSE files in the repository root for full details.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const val VERSION = "0.0.0"
|
||||||
Executable
+59
@@ -0,0 +1,59 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# This script is used for local build and testing of the AAR packaging
|
||||||
|
# In CI we call gradlew directly
|
||||||
|
|
||||||
|
EC_ASSETS_FOLDER=lib/src/main/assets/element-call
|
||||||
|
CURRENT_DIR=$( dirname -- "${BASH_SOURCE[0]}" )
|
||||||
|
|
||||||
|
pushd $CURRENT_DIR > /dev/null
|
||||||
|
|
||||||
|
function build_assets() {
|
||||||
|
echo "Generating Element Call assets..."
|
||||||
|
pushd ../.. > /dev/null
|
||||||
|
pnpm build
|
||||||
|
popd > /dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
function copy_assets() {
|
||||||
|
if [ ! -d $EC_ASSETS_FOLDER ]; then
|
||||||
|
echo "Creating $EC_ASSETS_FOLDER..."
|
||||||
|
mkdir -p $EC_ASSETS_FOLDER
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Copying generated Element Call assets to the Android project..."
|
||||||
|
cp -R ../../dist/* $EC_ASSETS_FOLDER
|
||||||
|
}
|
||||||
|
|
||||||
|
getopts :sh opt
|
||||||
|
case $opt in
|
||||||
|
s)
|
||||||
|
SKIP=1
|
||||||
|
;;
|
||||||
|
h)
|
||||||
|
echo "-s: will skip building the assets and just publish the library."
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ ! $SKIP ]; then
|
||||||
|
read -p "Do you want to re-build the assets (y/n, defaults to no)? " -n 1 -r
|
||||||
|
echo ""
|
||||||
|
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||||
|
build_assets
|
||||||
|
else
|
||||||
|
echo "Using existing assets from ../../dist"
|
||||||
|
fi
|
||||||
|
copy_assets
|
||||||
|
elif [ ! -d $EC_ASSETS_FOLDER ]; then
|
||||||
|
echo "Assets folder at $EC_ASSETS_FOLDER not found. Either build and copy the assets manually or remove the -s flag."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Exit with an error if the gradle publishing fails
|
||||||
|
set -e
|
||||||
|
echo "Publishing the Android project"
|
||||||
|
|
||||||
|
./gradlew publishAndReleaseToMavenCentral --no-daemon
|
||||||
|
|
||||||
|
popd > /dev/null
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
/*
|
||||||
|
* This file was generated by the Gradle 'init' task.
|
||||||
|
*
|
||||||
|
* The settings file is used to specify which projects to include in your build.
|
||||||
|
* For more detailed information on multi-project builds, please refer to https://docs.gradle.org/8.6/userguide/multi_project_builds.html in the Gradle documentation.
|
||||||
|
* This project uses @Incubating APIs which are subject to change.
|
||||||
|
*/
|
||||||
|
|
||||||
|
pluginManagement {
|
||||||
|
repositories {
|
||||||
|
gradlePluginPortal()
|
||||||
|
google()
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
rootProject.name = "element-call"
|
||||||
|
include("lib")
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
.build
|
||||||
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user