@@ -20,8 +20,12 @@ Jupyter Server Proxy
20
20
:target: https://www.npmjs.com/package/@jupyterlab/server-proxy
21
21
22
22
Jupyter Server Proxy lets you run arbitrary external processes (such
23
- as RStudio, Shiny Server, syncthing, PostgreSQL, etc) alongside your
24
- notebook, and provide authenticated web access to them.
23
+ as RStudio, Shiny Server, Syncthing, PostgreSQL, Code Server, etc)
24
+ alongside your notebook server and provide authenticated web access to
25
+ them using a path like ``/rstudio `` next to others like ``/lab ``.
26
+ Alongside the python package that provides the main functionality, the
27
+ JupyterLab extension (``@jupyterlab/server-proxy ``) provides buttons
28
+ in the JupyterLab launcher window to get to RStudio for example.
25
29
26
30
**Note: ** This project used to be called **nbserverproxy **. As
27
31
nbserverproxy is an older version of jupyter-server-proxy, uninstall
@@ -43,33 +47,75 @@ The primary use cases are:
43
47
`The documentation <https://jupyter-server-proxy.readthedocs.io/ >`_
44
48
contains information on installation & usage.
45
49
46
- ====================
47
50
Install
48
- ====================
51
+ =======
52
+
53
+ Python package
54
+ --------------
49
55
50
56
pip
51
- ---
57
+ ^^^
52
58
53
59
.. code-block ::
54
60
55
61
pip install jupyter-server-proxy
56
62
57
63
conda
58
- -----
64
+ ^^^^^
59
65
60
66
.. code-block ::
61
67
62
68
conda install jupyter-server-proxy -c conda-forge
63
69
64
- src
65
- ---
70
+ JupyterLab extension
71
+ --------------------
72
+
73
+ .. code-block ::
74
+
75
+ jupyter labextension install @jupyterlab/server-proxy
76
+
77
+ Contributing
78
+ ============
79
+
80
+ Python package
81
+ --------------
66
82
67
83
.. code-block ::
68
84
69
- pip install .
85
+ pip install -e .
86
+
87
+ # explicit install needed with editable mode (``-e``) jupyter
88
+ serverextension enable --sys-prefix jupyter_server_proxy
89
+
90
+
91
+ JupyterLab extension
92
+ --------------------
93
+
94
+ The ``jlpm `` command is JupyterLab's pinned version of ``yarn `` that
95
+ is installed with JupyterLab. You may use ``yarn `` or ``npm `` instead
96
+ of ``jlpm `` below.
97
+
98
+ .. code-block ::
70
99
71
- **Note: ** if installing from source in editable mode: ``setup.py develop/pip install -e ``, please explicitly install the server extensions:
100
+ cd jupyterlab-server-proxy
101
+ # Install dependencies
102
+ jlpm
103
+ # Build Typescript source
104
+ jlpm build
105
+ # Link your development version of the extension with JupyterLab
106
+ jupyter labextension link .
107
+ # Rebuild Typescript source after making changes
108
+ jlpm build
109
+ # Rebuild JupyterLab after making any changes
110
+ jupyter lab build
111
+
112
+ You can watch the source directory and run JupyterLab in watch mode to
113
+ watch for changes in the extension's source and automatically rebuild
114
+ the extension and application.
72
115
73
116
.. code-block ::
74
117
75
- jupyter serverextension enable --sys-prefix jupyter_server_proxy
118
+ # Watch the source directory in another terminal tab
119
+ jlpm watch
120
+ # Run jupyterlab in watch mode in one terminal tab
121
+ jupyter lab --watch
0 commit comments