Skip to main content
`Ctrl`+`K`

# Welcome!

You’ve landed on the documentation pages for the Jupyter Server Project. Some other pages you may have been looking for:

- Jupyter Server Github Repo, the source code we describe in this code.

- Jupyter Notebook Github Repo , the source code for the classic Notebook.

- JupyterLab Github Repo, the JupyterLab server which runs on the Jupyter Server.

## Introduction

Jupyter Server is the backend that provides the core services, APIs, and REST endpoints for Jupyter web applications.

Note

Jupyter Server is a replacement for the Tornado Web Server in Jupyter Notebook. Jupyter web applications should move to using Jupyter Server. For help, see the Migrating from Notebook Server page.

## Applications

Jupyter Server extensions can use the framework and services provided by Jupyter Server to create applications and services.

Examples of Jupyter Server extensions include:

Jupyter Lab

  JupyterLab computational environment.

Jupyter Resource Usage

  Jupyter Notebook Extension for monitoring your own resource usage.

Jupyter Scheduler

  Run Jupyter notebooks as jobs.

jupyter-collaboration

  A Jupyter Server Extension Providing Support for Y Documents.

NbClassic

  Jupyter notebook as a Jupyter Server extension.

Cylc UI Server

  A Jupyter Server extension that serves the cylc-ui web application for monitoring and controlling Cylc workflows.

For more information on extensions, see Server Extensions.

## Who’s this for?

The Jupyter Server is a highly technical piece of the Jupyter Stack, so we’ve separated documentation to help specific personas:

1. Users: people using Jupyter web applications.

2. Operators: people deploying or serving Jupyter web applications to others.

3. Developers: people writing Jupyter Server extensions and web applications.

4. Contributors: people contributing directly to the Jupyter Server library.

If you finds gaps in our documentation, please open an issue (or better, a pull request) on the Jupyter Server Github repo.

## Table of Contents

- Users
  - Installation
  - Configuring a Jupyter Server
  - Launching a bare Jupyter Server
  - Getting Help
- Operators
  - 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
- Developers
  - Architecture Diagrams
  - Depending on Jupyter Server
  - The REST API
  - Server Extensions
  - File save hooks
  - Contents API
  - WebSocket kernel wire protocols
  - API Docs
- Contributors
  - Team Meetings, Road Map and Calendar
  - General Jupyter contributor guidelines
  - Setting Up a Development Environment
  - Running Tests
  - Building the Docs
- Other
  - List of helpful links
  - Frequently asked questions
  - Config file and command line options
  - Changelog