Personal tools
Skip to content. | Skip to navigation
Jupyter Server The Jupyter Server provides the backend (i.e. the core services, APIs, and REST endpoints) for Jupyter web applications like Jupyter notebook, JupyterLab, and Voila. For more information, read our documentation here. Installation and Basic usage To install the latest release locally, make sure you have pip installed and run: pip install jupyter_server Jupyter Server currently supports Python>=3.6 on Linux, OSX and Windows. Versioning and Branches If Jupyter Server is a dependency of your project/application, it is important that you pin it to a version that works for your application. Currently, Jupyter Server only has minor and patch versions. Different minor versions likely include API-changes while patch versions do not change API. When a new minor version is released on PyPI, a branch for that version will be created in this repository, and the version of the main branch will be bumped to the next minor version number. That way, the main branch always reflects the
jupyter_server_fileid A Jupyter Server extension providing an implementation of the File ID service. Requirements Jupyter Server Install To install the extension, execute: pip install jupyter_server_fileid Uninstall To remove the extension, execute: pip uninstall jupyter_server_fileid Troubleshoot If you are seeing the frontend extension, but it is not working, check that the server extension is enabled: jupyter server extension list Contributing Development install pip install -e . You can watch the source directory and run your Jupyter Server-based application at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. For example, when running JupyterLab: jupyter lab --autoreload If your extension does not depend a part
Jupyter Server Kernels Jupyter Server Kernels is a Jupyter Server Extension providing support for kernels.
Jupyter Server Kernels Proxy
MathJax resources endpoints for Jupyter Server Basic Usage Install from PyPI: > pip install jupyter_server_mathjax This will automatically enable the extension in Jupyter Server. To test the installation, you can run Jupyter Server and visit the /static/jupyter_server_mathjax/MathJax.js endpoint: > jupyter server Maintenance Notes To install an editable install locally for development, first clone the repository locally, then run: `pip install -e .[test]` Note that the editable install will not install the data file that automatically configures the extension for use. To manually enable it, run: jupyter server extension enable --py jupyter_server_mathjax To build for distribution, use the build package: pip install build python -m build Then release using twine: twine check dist/* twine check dist/*
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: 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
Jupyter Server Terminals Jupyter Server Terminals is a Jupyter Server Extension providing support for terminals. Installation and Basic usage To install the latest release locally, make sure you have pip installed and run: pip install jupyter_server_terminals Jupyter Server Terminals currently supports Python>=3.6 on Linux, OSX and Windows. Testing See CONTRIBUTING. Contributing If you are interested in contributing to the project, see CONTRIBUTING.
Jupyter Server Terminals Proxy In one terminal/environment: pip install fps_uvicorn pip install fps_terminals pip install fps-noauth fps-uvicorn --port=8000 --no-open-browser In another terminal/environment: pip install jupyter_server_terminals_proxy pip install jupyterlab jupyter lab --port=8888 --ServerApp.terminals_enabled=False --TerminalsProxyExtensionApp.proxy_url='http:/127.0.0.1:8000' Terminals should now be served from http:/127.0.0.1:8000.
Jupyter Server WidgetJupyter Notebook %magics and Widget to start and stop servers from a CellLoad extension inside a Jupyter notebook: %load_ext jupyterserverwidget Add server commands with cell magic: %server myserver1 --args myargs%servers myserver1 --args myargs myserver2 --args myargs Click buttons to start them, click again to stop. Installation...