@ifc-lite/collab-server 0.2.3 → 0.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -9
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,18 +1,24 @@
|
|
|
1
1
|
# @ifc-lite/collab-server
|
|
2
2
|
|
|
3
|
-
Reference websocket sync server for [`@ifc-lite/collab`](
|
|
3
|
+
Reference websocket sync server for [`@ifc-lite/collab`](https://www.npmjs.com/package/@ifc-lite/collab).
|
|
4
4
|
|
|
5
|
-
> **Status:
|
|
6
|
-
>
|
|
7
|
-
>
|
|
8
|
-
>
|
|
5
|
+
> **Status: early (0.x).** y-websocket-compatible sync, room manager,
|
|
6
|
+
> pluggable auth hook (viewer / commenter / editor / admin roles), file,
|
|
7
|
+
> S3 and Redis persistence, audit log, rate limiting, retention policies,
|
|
8
|
+
> metrics endpoint, blob route, and healthcheck.
|
|
9
9
|
|
|
10
10
|
## Run it
|
|
11
11
|
|
|
12
12
|
```sh
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
13
|
+
npx @ifc-lite/collab-server
|
|
14
|
+
# default port 1234
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Or install it:
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npm install @ifc-lite/collab-server
|
|
21
|
+
npx ifc-lite-collab-server
|
|
16
22
|
```
|
|
17
23
|
|
|
18
24
|
Environment variables:
|
|
@@ -22,7 +28,6 @@ Environment variables:
|
|
|
22
28
|
| `COLLAB_PORT` | `1234` | Listen port |
|
|
23
29
|
| `COLLAB_HOST` | `0.0.0.0` | Listen host |
|
|
24
30
|
| `COLLAB_DATA_DIR` | `./.collab-data` | Persistence root for room logs |
|
|
25
|
-
| `COLLAB_JWT_SECRET` | _(unset = auth disabled)_ | HMAC secret for JWT validation |
|
|
26
31
|
| `COLLAB_MAX_ROOMS` | `1024` | Soft cap on simultaneous rooms |
|
|
27
32
|
|
|
28
33
|
## Programmatic use
|
|
@@ -42,6 +47,13 @@ const server = await startCollabServer({
|
|
|
42
47
|
await server.stop();
|
|
43
48
|
```
|
|
44
49
|
|
|
50
|
+
Also exported: `S3Persistence`, `RedisPersistence`, `MemoryPersistence`,
|
|
51
|
+
`FilePersistence`, `RoomManager`, audit sinks, and retention helpers.
|
|
52
|
+
|
|
53
|
+
## Docs
|
|
54
|
+
|
|
55
|
+
See the [ifc-lite docs](https://ifclite.dev/docs/).
|
|
56
|
+
|
|
45
57
|
## License
|
|
46
58
|
|
|
47
59
|
MPL-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ifc-lite/collab-server",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.5",
|
|
4
4
|
"description": "Reference websocket sync server for @ifc-lite/collab",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -24,10 +24,10 @@
|
|
|
24
24
|
"ws": "^8.21.0",
|
|
25
25
|
"y-protocols": "^1.0.6",
|
|
26
26
|
"yjs": "^13.6.31",
|
|
27
|
-
"@ifc-lite/collab": "^0.2.
|
|
27
|
+
"@ifc-lite/collab": "^0.2.6"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
|
-
"@types/node": "^26.0
|
|
30
|
+
"@types/node": "^26.1.0",
|
|
31
31
|
"@types/ws": "^8.5.13",
|
|
32
32
|
"typescript": "^6.0.3",
|
|
33
33
|
"vitest": "^4.1.9",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
"url": "https://github.com/LTplus-AG/ifc-lite.git",
|
|
41
41
|
"directory": "packages/collab-server"
|
|
42
42
|
},
|
|
43
|
-
"homepage": "https://
|
|
43
|
+
"homepage": "https://ifclite.dev/docs/",
|
|
44
44
|
"bugs": "https://github.com/LTplus-AG/ifc-lite/issues",
|
|
45
45
|
"keywords": [
|
|
46
46
|
"ifc",
|