Add docs for the HPB conversation clustering

Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2020-05-25 10:51:16 +02:00
Родитель 1962e2541d
Коммит 9aaeba876c
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 7076EA9751AACDDA
3 изменённых файлов: 25 добавлений и 6 удалений

Просмотреть файл

@ -40,3 +40,9 @@ title: Constants
## Webinary lobby states
* `0` no lobby
* `1` lobby for non moderators
## Signaling modes
* `internal` No external signaling server is used
* `external` A single external signaling server is used
* `conversation_cluster` A external signaling server is assigned per conversation

Просмотреть файл

@ -1,6 +1,4 @@
# Internal signaling API
See [External Signaling API](standalone-signaling-api-v1.md) for the Signaling of the High-Performance Backend.
# Signaling API
Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
@ -12,10 +10,19 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
field | type | Description
------|------|------------
`stunservers` | array | STUN servers
`turnservers` | array | TURN servers
`token` | string | The conversation to get the signaling settings for
* Response:
field | type | Description
------|------|------------
`signalingMode` | string | See [Signaling modes](constants.md#Signaling_modes)
`userId` | string | Current user id
`hideWarning` | string | Don't show a performance warning although internal signaling is used
`server` | string | URL of the external signaling server
`ticket` | string | Ticket for the external signaling server
`stunservers` | array | STUN servers
`turnservers` | array | TURN servers
- STUN server
@ -37,4 +44,10 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
+ `200 OK`
+ `404 Not Found`
### Internal signaling API
Todo
### External signaling API
See [External signaling API](standalone-signaling-api-v1.md) for the Signaling of the High-Performance Backend.

Просмотреть файл

@ -27,7 +27,7 @@ nav:
- 'Webinar management': 'webinar.md'
- 'Settings': 'settings.md'
- 'Integration by other apps': 'integration.md'
- 'Internal signaling API': 'internal-signaling.md'
- 'Signaling API': 'internal-signaling.md'
- 'External signaling API': 'standalone-signaling-api-v1.md'
- Commands: 'commands.md'
- 'PHP events': 'events.md'