Technical Reference

This section covers more of the details of the JupyterHub architecture, as well as what happens under-the-hood when you deploy and configure your JupyterHub.

• Technical Overview
  • The Major Subsystems: Hub, Proxy, Single-User Notebook Server
  • How the Subsystems Interact
  • The Process from JupyterHub Access to User Login
  • Default Behavior
  • Customizing JupyterHub
• JupyterHub URL scheme
  • /
  • /hub/
  • /hub/home
  • /hub/login
  • /hub/logout
  • /user/:username[/:servername]
  • /hub/user/:username[/:servername]
  • /user-redirect/...
  • Spawning
  • /hub/token
  • /hub/admin
• Security Overview
  • Semi-trusted and untrusted users
  • Protect users from each other
  • Mitigate security issues
  • Security audits
  • Vulnerability reporting
• Authenticators
  • The default PAM Authenticator
  • The OAuthenticator
  • The Dummy Authenticator
  • Additional Authenticators
  • Technical Overview of Authentication
  • Authenticator-managed group membership
  • pre_spawn_start and post_spawn_stop hooks
  • JupyterHub as an OAuth provider
• Spawners
  • Examples
  • Spawner control methods
  • Spawner state
  • Spawner options form
  • Writing a custom spawner
  • Environment variables and command-line arguments
  • Spawners, resource limits, and guarantees (Optional)
• Services
  • Definition of a Service
  • Properties of a Service
  • Hub-Managed Services
  • Launching a Hub-Managed Service
  • Externally-Managed Services
  • Writing your own Services
  • Hub Authentication and Services
• JupyterHub REST API
• Starting servers with the JupyterHub API
  • Checking server status
  • Starting servers
  • Waiting for a server to start
  • Stopping servers
  • Communicating with servers
  • Python example
• Monitoring
  • List of Prometheus Metrics
• The Hub’s Database
  • Why does JupyterHub have a database?
  • What’s in the database?
  • How does JupyterHub use the database?
  • Database backends
  • Notes and Tips
• Event logging and telemetry
  • How to emit events
  • Event schemas
• Configuration Reference
  • JupyterHub configuration
  • JupyterHub help command output
• JupyterHub and OAuth
  • Key OAuth terms
  • One oauth flow
  • Full sequence of OAuth in JupyterHub
  • Token caches and expiry
  • Extra bits