Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Client Well-Known docs. #2078

Merged
merged 3 commits into from
Sep 28, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions docs/client_well_known.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Client Well-Known

| Status | Last updated |
|--|--|
| Draft | September 27, 2023 |

<hr />



## Jitsi Configuration

Jitsi configuration is keyed by `io.element.jitsi`. The following options are supported:

| Key | Type | 🤖 | 🍎 | 🕸️ | Description |
| - | - | - | - | - | - |
| `preferredDomain` | `String` | ❓ | ✅ | ❌ | Use the specified server for Jitsi calls. |
pixlwave marked this conversation as resolved.
Show resolved Hide resolved
| `useFor1To1Calls` | `Bool` | ❓ | ✅ | ❌ | Use Jitsi for 1:1 calls (by default we use native Matrix calls). |
pixlwave marked this conversation as resolved.
Show resolved Hide resolved

## Encryption Configuration

Encryption configuration is keyed by `io.element.e2ee`. The following options are supported:

| Key | Type | 🤖 | 🍎 | 🕸️ | Description |
| - | - | - | - | - | - |
| `default` | `Bool` | ❓ | ✅ | ✅ | Indicate if E2EE is enabled by default. |
pixlwave marked this conversation as resolved.
Show resolved Hide resolved
| `force_disable` | `Bool` | ❓ | ❌ | ✅ | Overrides `default` when true, removing the option to enable encryption throughout the UI (existing encrypted rooms are unaffected). |
pixlwave marked this conversation as resolved.
Show resolved Hide resolved
| `secure_backup_required` | `Bool` | ❓ | ✅ | ✅ | Indicate if secure backup (SSSS) is mandatory. |
pixlwave marked this conversation as resolved.
Show resolved Hide resolved
| `secure_backup_setup_methods` | `BackupSetupMethod` | ❓ | ✅ | ✅ | Methods to use to setup secure backup (SSSS). |
pixlwave marked this conversation as resolved.
Show resolved Hide resolved
| `outbound_keys_pre_sharing_mode` | `KeyPreSharingStrategy` | ❓ | ✅ | ❌ | Outbound keys pre sharing strategy. |
pixlwave marked this conversation as resolved.
Show resolved Hide resolved

### Encryption Configuration Types

```
enum BackupSetupMethod: Int {
case passphrase = 0
case key = 1
}
```

```
enum KeyPreSharingStrategy: Int {
case none = 0,
case whenEnteringRoom = 1,
case whenTyping = 2
}
```
pixlwave marked this conversation as resolved.
Show resolved Hide resolved