Skip to content

Commit d9aff30

Browse files
authored
Update docs
1 parent 278a74a commit d9aff30

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

jupyterlab-server-proxy/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Launcher icons for proxied applications
44

55
## Prerequisites
66

7-
- JupyterLab >=2,<3
7+
- JupyterLab >=2,<4
88

99
## Installation
1010

@@ -20,12 +20,21 @@ or
2020
conda install jupyter-server-proxy
2121
```
2222

23-
As a _prebuilt_ extension, it will "just work," and requires not
23+
> As a _prebuilt_ extension, it will "just work," only a simple page reload should be required
24+
> to see launcher items. However, a full restart of `jupyter_server` or `notebook` is required
25+
> to reload the `jupyter_server_proxy` serverextension which provides most of the functionality.
2426
2527
### JupyterLab 2
2628

27-
For JupyterLab 2, ensure `nodejs` is installed, and run:
29+
For JupyterLab 2, ensure `nodejs` is installed and available on `$PATH` and run:
2830

2931
```bash
3032
jupyter labextension install @jupyterlab/server-proxy
3133
```
34+
35+
> This will cause:
36+
>
37+
> - a download of a great deal of build assets from `npmjs.org`
38+
> - a large `webpack` build that may exhaust memory and open files handles
39+
>
40+
> **Please** consider upgrading to JupyterLab 3 before reporting issues.

0 commit comments

Comments
 (0)