| Name | jupyter-server-proxy JSON |
| Version |
4.4.0
JSON |
| download |
| home_page | None |
| Summary | A Jupyter server extension to run additional processes and proxy to them that comes bundled JupyterLab extension to launch pre-defined processes. |
| upload_time | 2024-08-29 12:49:22 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2017, Data Science 8 All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jupyter Server Proxy
[](https://jupyter-server-proxy.readthedocs.io/)
[](https://github.com/jupyterhub/jupyter-server-proxy/actions)
[](https://pypi.python.org/pypi/jupyter-server-proxy)
[](https://anaconda.org/conda-forge/jupyter-server-proxy)
[](https://www.npmjs.com/package/@jupyterhub/jupyter-server-proxy)
Jupyter Server Proxy lets you run arbitrary external processes (such as
RStudio, Shiny Server, Syncthing, PostgreSQL, Code Server, etc)
alongside your notebook server and provide authenticated web access to
them using a path like `/rstudio` next to others like `/lab`. Alongside
the python package that provides the main functionality, the JupyterLab
extension (`@jupyterhub/jupyter-server-proxy`) provides buttons in the
JupyterLab launcher window to get to RStudio for example.
**Note:** This project used to be called **nbserverproxy**. As
nbserverproxy is an older version of jupyter-server-proxy, uninstall
nbserverproxy before installing jupyter-server-proxy to avoid conflicts.
The primary use cases are:
1. Use with JupyterHub / Binder to allow launching users into web
interfaces that have nothing to do with Jupyter - such as RStudio,
Shiny, or OpenRefine.
2. Allow access from frontend javascript (in classic notebook or
JupyterLab extensions) to access web APIs of other processes running
locally in a safe manner. This is used by the [JupyterLab
extension](https://github.com/dask/dask-labextension) for
[dask](https://www.dask.org/).
[The documentation](https://jupyter-server-proxy.readthedocs.io/)
contains information on installation & usage.
## Security warning
Jupyter Server Proxy is often used to start a user defined process listening to
some network port (e.g. `http://localhost:4567`) for a user starting a Jupyter Server
that only that user has permission to access. The user can then access the
started process proxied through the Jupyter Server.
For safe use of Jupyter Server Proxy, you should ensure that the process started
by Jupyter Server proxy can't be accessed directly by another user and bypass
the Jupyter Server's authorization!
A common strategy to enforce access proxied via Jupyter Server is to start
Jupyter Server within a container and only allow network access to the Jupyter
Server via the container.
> For more insights, see [Ryan Lovett's comment about
> it](https://github.com/jupyterhub/jupyter-server-proxy/pull/359#issuecomment-1350118197).
## Install
### Python package
#### `pip`
```bash
pip install jupyter-server-proxy
```
#### `conda`
```bash
conda install -c conda-forge jupyter-server-proxy
```
### Jupyter Client Extensions
A JupyterLab and Notebook extension is bundled with the Python package to
provide:
- servers in the _New_ dropwdown of the Notebook Tree view
- launch buttons in JupyterLab's Launcher panel for registered server processes.
- 
#### Client compatibility
For historical compatibility ranges, see the table below:
| `jupyter-server-proxy` | `notebook` | `jupyterlab` |
| :--------------------: | :--------: | :----------: |
| `4.1.x` | `>=6,<8` | `>=3,<5` |
| `4.0.x` | `>=6,<7` | `>=3,<4` |
| `3.x` | `>=6,<7` | `>=2,<4` |
## Disable
### Server extension
```bash
jupyter serverextension disable --sys-prefix jupyter_server_proxy
jupyter server extension disable --sys-prefix jupyter_server_proxy
```
### Notebook Classic extension
```bash
jupyter nbextension disable --sys-prefix --py jupyter_server_proxy
```
### JupyterLab extension
```bash
jupyter labextension disable @jupyterhub/jupyter-server-proxy
```
#### Local development
To setup a local development environment, see the [contributing guide](https://github.com/jupyterhub/jupyter-server-proxy/blob/main/CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-server-proxy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Ryan Lovett <rylo@berkeley.edu>, Yuvi Panda <yuvipanda@gmail.com>, Jupyter Development Team <jupyter@googlegroups.com>",
"download_url": "https://files.pythonhosted.org/packages/2a/c8/ff6ecdbf55ac1a9253d53d87c60004ee508cfc852662b15fb33cd6ebfdbc/jupyter_server_proxy-4.4.0.tar.gz",
"platform": null,
"description": "# Jupyter Server Proxy\n\n[](https://jupyter-server-proxy.readthedocs.io/)\n[](https://github.com/jupyterhub/jupyter-server-proxy/actions)\n[](https://pypi.python.org/pypi/jupyter-server-proxy)\n[](https://anaconda.org/conda-forge/jupyter-server-proxy)\n[](https://www.npmjs.com/package/@jupyterhub/jupyter-server-proxy)\n\nJupyter Server Proxy lets you run arbitrary external processes (such as\nRStudio, Shiny Server, Syncthing, PostgreSQL, Code Server, etc)\nalongside your notebook server and provide authenticated web access to\nthem using a path like `/rstudio` next to others like `/lab`. Alongside\nthe python package that provides the main functionality, the JupyterLab\nextension (`@jupyterhub/jupyter-server-proxy`) provides buttons in the\nJupyterLab launcher window to get to RStudio for example.\n\n**Note:** This project used to be called **nbserverproxy**. As\nnbserverproxy is an older version of jupyter-server-proxy, uninstall\nnbserverproxy before installing jupyter-server-proxy to avoid conflicts.\n\nThe primary use cases are:\n\n1. Use with JupyterHub / Binder to allow launching users into web\n interfaces that have nothing to do with Jupyter - such as RStudio,\n Shiny, or OpenRefine.\n2. Allow access from frontend javascript (in classic notebook or\n JupyterLab extensions) to access web APIs of other processes running\n locally in a safe manner. This is used by the [JupyterLab\n extension](https://github.com/dask/dask-labextension) for\n [dask](https://www.dask.org/).\n\n[The documentation](https://jupyter-server-proxy.readthedocs.io/)\ncontains information on installation & usage.\n\n## Security warning\n\nJupyter Server Proxy is often used to start a user defined process listening to\nsome network port (e.g. `http://localhost:4567`) for a user starting a Jupyter Server\nthat only that user has permission to access. The user can then access the\nstarted process proxied through the Jupyter Server.\n\nFor safe use of Jupyter Server Proxy, you should ensure that the process started\nby Jupyter Server proxy can't be accessed directly by another user and bypass\nthe Jupyter Server's authorization!\n\nA common strategy to enforce access proxied via Jupyter Server is to start\nJupyter Server within a container and only allow network access to the Jupyter\nServer via the container.\n\n> For more insights, see [Ryan Lovett's comment about\n> it](https://github.com/jupyterhub/jupyter-server-proxy/pull/359#issuecomment-1350118197).\n\n## Install\n\n### Python package\n\n#### `pip`\n\n```bash\npip install jupyter-server-proxy\n```\n\n#### `conda`\n\n```bash\nconda install -c conda-forge jupyter-server-proxy\n```\n\n### Jupyter Client Extensions\n\nA JupyterLab and Notebook extension is bundled with the Python package to\nprovide:\n\n- servers in the _New_ dropwdown of the Notebook Tree view\n- launch buttons in JupyterLab's Launcher panel for registered server processes.\n - ![a screenshot of the JupyterLab Launcher](docs/source/_static/images/labextension-launcher.png \"launch proxied servers as JupyterLab panels or new browser tabs\")\n\n#### Client compatibility\n\nFor historical compatibility ranges, see the table below:\n\n| `jupyter-server-proxy` | `notebook` | `jupyterlab` |\n| :--------------------: | :--------: | :----------: |\n| `4.1.x` | `>=6,<8` | `>=3,<5` |\n| `4.0.x` | `>=6,<7` | `>=3,<4` |\n| `3.x` | `>=6,<7` | `>=2,<4` |\n\n## Disable\n\n### Server extension\n\n```bash\njupyter serverextension disable --sys-prefix jupyter_server_proxy\njupyter server extension disable --sys-prefix jupyter_server_proxy\n```\n\n### Notebook Classic extension\n\n```bash\njupyter nbextension disable --sys-prefix --py jupyter_server_proxy\n```\n\n### JupyterLab extension\n\n```bash\njupyter labextension disable @jupyterhub/jupyter-server-proxy\n```\n\n#### Local development\n\nTo setup a local development environment, see the [contributing guide](https://github.com/jupyterhub/jupyter-server-proxy/blob/main/CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2017, Data Science 8 All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A Jupyter server extension to run additional processes and proxy to them that comes bundled JupyterLab extension to launch pre-defined processes.",
"version": "4.4.0",
"project_urls": {
"Documentation": "https://jupyter-server-proxy.readthedocs.io",
"Source": "https://github.com/jupyterhub/jupyter-server-proxy",
"Tracker": "https://github.com/jupyterhub/jupyter-server-proxy/issues"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fdc6e4a1d9fdd22d40962befd82780a98b20b67ef9cafe87246e4955f44b8f09",
"md5": "ba650d8c4b92c84aea69c2741b389c08",
"sha256": "707b5c84810bb8863d50f6c6d50a386fec216149e11802b7d4c451b54a63a9a6"
},
"downloads": -1,
"filename": "jupyter_server_proxy-4.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba650d8c4b92c84aea69c2741b389c08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 37567,
"upload_time": "2024-08-29T12:49:20",
"upload_time_iso_8601": "2024-08-29T12:49:20.890120Z",
"url": "https://files.pythonhosted.org/packages/fd/c6/e4a1d9fdd22d40962befd82780a98b20b67ef9cafe87246e4955f44b8f09/jupyter_server_proxy-4.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ac8ff6ecdbf55ac1a9253d53d87c60004ee508cfc852662b15fb33cd6ebfdbc",
"md5": "780a77a0b66b59394bc576c9121444c4",
"sha256": "e5732eb9c810c0caa997f90a2f15f7d09af638e7eea9c67eb5c43e9c1f0e1157"
},
"downloads": -1,
"filename": "jupyter_server_proxy-4.4.0.tar.gz",
"has_sig": false,
"md5_digest": "780a77a0b66b59394bc576c9121444c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 136830,
"upload_time": "2024-08-29T12:49:22",
"upload_time_iso_8601": "2024-08-29T12:49:22.906054Z",
"url": "https://files.pythonhosted.org/packages/2a/c8/ff6ecdbf55ac1a9253d53d87c60004ee508cfc852662b15fb33cd6ebfdbc/jupyter_server_proxy-4.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 12:49:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterhub",
"github_project": "jupyter-server-proxy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-server-proxy"
}
