Skip to content
This repository was archived by the owner on Nov 13, 2024. It is now read-only.

Commit a757174

Browse files
authored
docs: add warning for dropping custom room_id soon (#119)
1 parent 982008a commit a757174

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

docs/getting_started/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,14 +187,14 @@ Example log with and without this option:
187187
<TabItem value="json-log-on" label="true" default>
188188

189189
```json
190-
{"time":"2024-02-20T17:32:32.448Z","severity":"info","message":"Initialize room","metadata":{"room_id":"40"}}
190+
{"time":"2024-02-20T17:32:32.448Z","severity":"info","message":"Initialize room","metadata":{"room_id":"da2e-4a75-95ff-776bad2caf04-666973686a616d4031302e302e302e31"}}
191191
```
192192

193193
</TabItem>
194194
<TabItem value="json-log-off" label="false" default>
195195

196196
```
197-
17:32:32.448 room_id=40 [info] Initialize room
197+
17:32:32.448 room_id=da2e-4a75-95ff-776bad2caf04-666973686a616d4031302e302e302e31 [info] Initialize room
198198
```
199199

200200
</TabItem>

docs/getting_started/room.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@ The holder for peers and components.
66

77
**Optional**
88

9+
:::caution
10+
Support for custom ID will be dropped soon in favor of IDs generated by the server.
11+
912
* `roomId` (string, default: null) - Custom ID used for identifying the room within Fishjam.
10-
Must be unique across all rooms. If not provided, a random UUID will be generated.
13+
Must be unique across all rooms. If not provided, a random UUID will be generated.
1114
It may contain only alphanumeric characters, hyphens and underscores.
15+
:::
1216

1317
* `maxPeers` (integer 1.., default: null) - Maximum number of peers allowed in the room.
1418
If set to null (default), the number of peers is unlimited.

0 commit comments

Comments
 (0)