Skip to content

Commit 8faaf59

Browse files
committed
Mention this feature in documentation
1 parent 161029e commit 8faaf59

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/source/configuration.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ you happen to delete it, there shouldn't be any serious consequence either.
1010
There are a number of settings that you can change:
1111

1212
```bash
13-
# To enable or disable RTC(Real-Time Collaboration) (default: False).
13+
# To enable or disable RTC (Real-Time Collaboration) (default: False).
1414
# If True, RTC will be disabled.
1515
jupyter lab --YDocExtension.disable_rtc=True
1616

@@ -29,3 +29,20 @@ jupyter lab --YDocExtension.document_cleanup_delay=100
2929
# The YStore class to use for storing Y updates (default: JupyterSQLiteYStore).
3030
jupyter lab --YDocExtension.ystore_class=pycrdt_websocket.ystore.TempFileYStore
3131
```
32+
33+
There is an experimental feature that is currently only supported by the
34+
[Jupyverse](https://github.com/jupyter-server/jupyverse) server
35+
(not yet with [jupyter-server](https://github.com/jupyter-server/jupyter_server)):
36+
server-side execution. With this, running notebook code cells is not done in the frontend through
37+
the low-level kernel protocol over WebSocket API, but through a high-level REST API. Communication
38+
with the kernel is then delegated to the server, and cell outputs are populated in the notebook
39+
shared document. The frontend gets these outputs changes and shows them live. What this means is
40+
that the notebook state can be fully recovered even if the frontend disconnects, because cell
41+
outputs are not populated frontend-side but server-side.
42+
43+
This feature is disabled by default, and can be enabled like so:
44+
```bash
45+
pip install "jupyterlab>=4.2.0b0"
46+
pip install "jupyverse[jupyterlab, auth]>=0.4.2"
47+
jupyverse --set kernels.require_yjs=true --set jupyterlab.server_side_execution=true
48+
```

0 commit comments

Comments
 (0)