How the Jupyter Server Documentation Is Organized

Updated

The Jupyter Server documentation is split by role rather than by feature, so the fastest way to use it is to identify which of four personas you match: Users, Operators, Developers, or Contributors. Each section covers a different scope of work, and the same topic (for example, extensions) appears in more than one section with a different level of depth.

Users

This section is for people who run Jupyter web applications rather than build or deploy them for others. It covers:

  • Installation
  • Configuring a Jupyter Server
  • Launching a bare Jupyter Server
  • Getting Help

If your goal is to get a server running locally and adjust basic settings, this is the only section you need.

Operators

This section is for people deploying or serving Jupyter web applications to others. It covers:

  • Managing multiple extensions
  • Configuring Extensions
  • Migrating from Notebook Server
  • Running Jupyter Notebook on Jupyter Server
  • Running a public Jupyter Server
  • Security in the Jupyter Server
  • Security in notebook documents
  • Configuring Logging

The migration page matters if you are moving off the classic Notebook server: the documentation states that Jupyter Server is a replacement for the Tornado Web Server in Jupyter Notebook, and that Jupyter web applications should move to using Jupyter Server.

Developers

This section is for people writing Jupyter Server extensions and web applications. It covers:

  • Architecture Diagrams
  • Depending on Jupyter Server
  • The REST API
  • Server Extensions
  • File save hooks
  • Contents API
  • WebSocket kernel wire protocols
  • API Docs

The documentation describes Jupyter Server as the backend that provides the core services, APIs, and REST endpoints for Jupyter web applications, and notes that extensions can use its framework and services to build applications. Listed examples of such extensions include JupyterLab, Jupyter Resource Usage, Jupyter Scheduler, jupyter-collaboration, NbClassic, and Cylc UI Server.

Contributors

This section is for people contributing directly to the Jupyter Server library itself, and includes team and meeting information.

Choosing Your Entry Point

Your situation Start here
Installing and running a server for yourself Users
Deploying, securing, or migrating a shared server Operators
Building an extension or calling the REST API Developers
Working on the Jupyter Server codebase Contributors

One practical note from the documentation: if you find gaps, the project asks you to open an issue or a pull request on the Jupyter Server GitHub repo. The docs also point out that the GitHub repo holds the source code described in these pages, and that the classic Notebook and JupyterLab have their own separate repositories.