Update docs for persistence support
This commit is contained in:
parent
9d9234173c
commit
883c4f9b28
1 changed files with 5 additions and 5 deletions
|
|
@ -15,7 +15,6 @@ working:
|
||||||
not yet:
|
not yet:
|
||||||
- cursor/selection sync (awareness protocol stubbed but unused)
|
- cursor/selection sync (awareness protocol stubbed but unused)
|
||||||
- other editor adapters (helix, kakoune, zed)
|
- other editor adapters (helix, kakoune, zed)
|
||||||
- persistence (rooms are ephemeral)
|
|
||||||
- reconnection handling
|
- reconnection handling
|
||||||
|
|
||||||
## stack
|
## stack
|
||||||
|
|
@ -29,6 +28,7 @@ not yet:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
just dev # daemon on :4040
|
just dev # daemon on :4040
|
||||||
|
COLLABD_DB=path.db just dev # custom db path (default: collabd.db)
|
||||||
bun test # unit tests
|
bun test # unit tests
|
||||||
just check # biome lint
|
just check # biome lint
|
||||||
```
|
```
|
||||||
|
|
@ -66,6 +66,7 @@ server -> client:
|
||||||
- src/index.ts - websocket server, room routing
|
- src/index.ts - websocket server, room routing
|
||||||
- src/session.ts - yjs doc per room, peer management
|
- src/session.ts - yjs doc per room, peer management
|
||||||
- src/protocol.ts - message types
|
- src/protocol.ts - message types
|
||||||
|
- src/db.ts - sqlite persistence, save/load crdt updates
|
||||||
- adapters/vim/bridge.ts - bun process vim spawns
|
- adapters/vim/bridge.ts - bun process vim spawns
|
||||||
- adapters/vim/collab.vim - vim9script plugin
|
- adapters/vim/collab.vim - vim9script plugin
|
||||||
|
|
||||||
|
|
@ -95,7 +96,6 @@ known gaps (not production ready):
|
||||||
- room names guessable via brute force
|
- room names guessable via brute force
|
||||||
- no encryption (deploy behind wss, not ws)
|
- no encryption (deploy behind wss, not ws)
|
||||||
- no audit logging
|
- no audit logging
|
||||||
- no persistence (data lost on daemon restart)
|
|
||||||
|
|
||||||
before production:
|
before production:
|
||||||
1. auth layer (jwt tokens or unix socket for local-only)
|
1. auth layer (jwt tokens or unix socket for local-only)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue