Skip to content

Commit 193187e

Browse files
Add note about manager in the Lab UI in docs
1 parent cb3fe40 commit 193187e

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed
294 KB
Loading

docs/source/launchers.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,26 @@ buttons in JupyterLab's Launcher panel for registered server processes.
2727
```
2828

2929
Clicking on them opens the proxied application in a new browser window.
30+
31+
Currently running proxy applications are shown in the running sessions tab
32+
under "Server Proxy Apps" section.
33+
34+
```{image} _static/images/labextension-manager.gif
35+
36+
```
37+
38+
As shown in the GIF, users can consult the metadata of each running proxy
39+
application by hovering over the name of the proxy. It is also possible to
40+
terminate the proxy application using Shut Down button.
41+
42+
```{note}
43+
When the user clicks Shut Down button to terminate a proxy application,
44+
a `SIGTERM` signal is sent to the application. It is the user's responsibility
45+
to ensure that the application exits cleanly with a `SIGTERM` signal. There
46+
are certain applications (like MLflow) that cannot be terminted with `SIGTERM`
47+
signal and in those cases, the users can setup wrapper scripts to trap the
48+
signal and ensure clean teardown of the application.
49+
```
50+
51+
Only proxy applications that are started by `jupyter-server-proxy` are shown
52+
in the running Server Proxy Apps section.

0 commit comments

Comments
 (0)