Skip to content

Commit fe34c3a

Browse files
committed
Add documentation for new configuration option
1 parent ddc7627 commit fe34c3a

2 files changed

Lines changed: 51 additions & 0 deletions

File tree

docs/usage/configuration/config_documentation.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2575,6 +2575,28 @@ Example configuration:
25752575
turn_allow_guests: false
25762576
```
25772577
---
2578+
### `matrix_rtc`
2579+
2580+
*(object)* Options related to MatrixRTC. Defaults to `{}`.
2581+
2582+
This setting has the following sub-options:
2583+
2584+
* `transports` (array): A list of transport types and arguments to use for MatrixRTC connections. Defaults to `[]`.
2585+
2586+
Options for each entry include:
2587+
2588+
* `type` (string): The type of transport to use to connect to the selective forwarding unit (SFU).
2589+
2590+
* `livekit_service_url` (string): The base URL of the LiveKit service. Should only be used with LiveKit-based transports.
2591+
2592+
Example configuration:
2593+
```yaml
2594+
matrix_rtc:
2595+
transports:
2596+
- type: livekit
2597+
livekit_service_url: https://matrix-rtc.example.com/livekit/jwt
2598+
```
2599+
---
25782600
## Registration
25792601

25802602
Registration can be rate-limited using the parameters in the [Ratelimiting](#ratelimiting) section of this manual.

schema/synapse-config.schema.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2886,6 +2886,35 @@ properties:
28862886
default: true
28872887
examples:
28882888
- false
2889+
matrix_rtc:
2890+
type: object
2891+
description: >-
2892+
Options related to MatrixRTC.
2893+
properties:
2894+
transports:
2895+
type: array
2896+
items:
2897+
type: object
2898+
required:
2899+
- type
2900+
properties:
2901+
type:
2902+
type: string
2903+
description: The type of transport to use to connect to the selective forwarding unit (SFU).
2904+
example: livekit
2905+
livekit_service_url:
2906+
type: string
2907+
description: >-
2908+
The base URL of the LiveKit service. Should only be used with LiveKit-based transports.
2909+
example: https://matrix-rtc.example.com/livekit/jwt
2910+
description:
2911+
A list of transport types and arguments to use for MatrixRTC connections.
2912+
default: []
2913+
default: {}
2914+
examples:
2915+
- transports:
2916+
- type: livekit
2917+
livekit_service_url: https://matrix-rtc.example.com/livekit/jwt
28892918
enable_registration:
28902919
type: boolean
28912920
description: >-

0 commit comments

Comments
 (0)