-
Notifications
You must be signed in to change notification settings - Fork 149
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pandoc conversion of README from rST to Markdown
- Loading branch information
1 parent
56af515
commit f702911
Showing
1 changed file
with
72 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,125 +1,109 @@ | ||
| ==================== | ||
| Jupyter Server Proxy | ||
| ==================== | ||
|
|
||
| |ReadTheDocs badge| |Travis badge| |PyPI badge| |Conda badge| |NPM badge| | ||
|
|
||
| .. |ReadTheDocs badge| image:: https://img.shields.io/readthedocs/jupyter-server-proxy?logo=read-the-docs | ||
| :target: https://jupyter-server-proxy.readthedocs.io/ | ||
|
|
||
| .. |Travis badge| image:: https://img.shields.io/travis/com/jupyterhub/jupyter-server-proxy?logo=travis | ||
| :target: https://travis-ci.com/jupyterhub/jupyter-server-proxy | ||
|
|
||
| .. |PyPI badge| image:: https://img.shields.io/pypi/v/jupyter-server-proxy.svg?logo=pypi | ||
| :target: https://pypi.python.org/pypi/jupyter-server-proxy | ||
|
|
||
| .. |Conda badge| image:: https://img.shields.io/conda/vn/conda-forge/jupyter-server-proxy?logo=conda-forge | ||
| :target: https://anaconda.org/conda-forge/jupyter-server-proxy | ||
|
|
||
| .. |NPM badge| image:: https://img.shields.io/npm/v/@jupyterlab/server-proxy.svg?logo=npm | ||
| :target: https://www.npmjs.com/package/@jupyterlab/server-proxy | ||
|
|
||
| Jupyter Server Proxy lets you run arbitrary external processes (such | ||
| as RStudio, Shiny Server, Syncthing, PostgreSQL, Code Server, etc) | ||
| [](https://jupyter-server-proxy.readthedocs.io/) | ||
| [](https://travis-ci.com/jupyterhub/jupyter-server-proxy) | ||
| [](https://pypi.python.org/pypi/jupyter-server-proxy) | ||
| [](https://anaconda.org/conda-forge/jupyter-server-proxy) | ||
| [](https://www.npmjs.com/package/@jupyterlab/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 (``@jupyterlab/server-proxy``) provides buttons | ||
| in the JupyterLab launcher window to get to RStudio for example. | ||
| them using a path like `/rstudio` next to others like `/lab`. Alongside | ||
| the python package that provides the main functionality, the JupyterLab | ||
| extension (`@jupyterlab/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. | ||
| nbserverproxy before installing jupyter-server-proxy to avoid conflicts. | ||
|
|
||
| The primary use cases are: | ||
|
|
||
| #. Use with JupyterHub / Binder to allow launching users into web | ||
| interfaces that have nothing to do with Jupyter - such as RStudio, | ||
| Shiny, or OpenRefine. | ||
| #. 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://dask.org/>`_. | ||
|
|
||
| 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://dask.org/). | ||
|
|
||
| `The documentation <https://jupyter-server-proxy.readthedocs.io/>`_ | ||
| [The documentation](https://jupyter-server-proxy.readthedocs.io/) | ||
| contains information on installation & usage. | ||
|
|
||
| Install | ||
| ======= | ||
| ------- | ||
|
|
||
| Python package | ||
| -------------- | ||
| ### Python package | ||
|
|
||
| pip | ||
| ^^^ | ||
| #### pip | ||
|
|
||
| .. code-block:: | ||
| ``` {.} | ||
| pip install jupyter-server-proxy | ||
| ``` | ||
|
|
||
| pip install jupyter-server-proxy | ||
| #### conda | ||
|
|
||
| conda | ||
| ^^^^^ | ||
| ``` {.} | ||
| conda install jupyter-server-proxy -c conda-forge | ||
| ``` | ||
|
|
||
| .. code-block:: | ||
|
|
||
| conda install jupyter-server-proxy -c conda-forge | ||
|
|
||
| JupyterLab extension | ||
| -------------------- | ||
| ### JupyterLab extension | ||
|
|
||
| Note that as the JupyterLab extension only is a graphical interface to | ||
| launch registered applications in the python package, the extension | ||
| requires the python package to be installed. | ||
|
|
||
| .. code-block:: | ||
|
|
||
| jupyter labextension install @jupyterlab/server-proxy | ||
| ``` {.} | ||
| jupyter labextension install @jupyterlab/server-proxy | ||
| ``` | ||
|
|
||
| Contributing | ||
| ============ | ||
|
|
||
| Python package | ||
| -------------- | ||
| ------------ | ||
|
|
||
| .. code-block:: | ||
| ### Python package | ||
|
|
||
| pip install -e . | ||
| ``` {.} | ||
| pip install -e . | ||
| # explicit install needed with editable mode (-e) jupyter | ||
| jupyter serverextension enable --sys-prefix jupyter_server_proxy | ||
| # explicit install needed with editable mode (-e) jupyter | ||
| jupyter serverextension enable --sys-prefix jupyter_server_proxy | ||
| ``` | ||
|
|
||
| ### JupyterLab extension | ||
|
|
||
| JupyterLab extension | ||
| -------------------- | ||
| The `jlpm` command is JupyterLab\'s pinned version of `yarn` that is | ||
| installed with JupyterLab. You may use `yarn` or `npm` instead of `jlpm` | ||
| below. | ||
|
|
||
| The ``jlpm`` command is JupyterLab's pinned version of ``yarn`` that | ||
| is installed with JupyterLab. You may use ``yarn`` or ``npm`` instead | ||
| of ``jlpm`` below. | ||
|
|
||
| .. code-block:: | ||
|
|
||
| cd jupyterlab-server-proxy | ||
| # Install dependencies | ||
| jlpm | ||
| # Build Typescript source | ||
| jlpm build | ||
| # Link your development version of the extension with JupyterLab | ||
| jupyter labextension link . | ||
| # Rebuild Typescript source after making changes | ||
| jlpm build | ||
| # Rebuild JupyterLab after making any changes | ||
| jupyter lab build | ||
| ``` {.} | ||
| cd jupyterlab-server-proxy | ||
| # Install dependencies | ||
| jlpm | ||
| # Build Typescript source | ||
| jlpm build | ||
| # Link your development version of the extension with JupyterLab | ||
| jupyter labextension link . | ||
| # Rebuild Typescript source after making changes | ||
| jlpm build | ||
| # Rebuild JupyterLab after making any changes | ||
| jupyter lab build | ||
| ``` | ||
|
|
||
| You can watch the source directory and run JupyterLab in watch mode to | ||
| watch for changes in the extension's source and automatically rebuild | ||
| watch for changes in the extension\'s source and automatically rebuild | ||
| the extension and application. | ||
|
|
||
| .. code-block:: | ||
|
|
||
| # Watch the source directory in another terminal tab | ||
| jlpm watch | ||
| # Run jupyterlab in watch mode in one terminal tab | ||
| jupyter lab --watch | ||
| ``` {.} | ||
| # Watch the source directory in another terminal tab | ||
| jlpm watch | ||
| # Run jupyterlab in watch mode in one terminal tab | ||
| jupyter lab --watch | ||
| ``` |