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
• Writing a custom Proxy implementation
  • Subclassing Proxy
  • Starting and stopping the proxy
  • Encryption
  • Routes
  • Note on activity tracking
• Running proxy separately from the hub
  • Background
  • Configuration options
  • Proxy configuration
  • Docker image
  • See also
• Using JupyterHub’s REST API
  • What you can do with the API
  • Create an API token
  • Assigning permissions to a token
  • Updating to admin services
  • Make an API request
  • Paginating API requests
  • Enabling users to spawn multiple named-servers via the API
  • Learn more about the API
• 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
• The Hub’s Database
  • Default SQLite database
  • Using an RDBMS (PostgreSQL, MySQL)
  • Notes and Tips
• Working with templates and UI
  • Custom Templates
  • Extending Templates
  • Page Announcements
• Deploying JupyterHub in “API only mode”
  • Limited UI customization via templates
  • Rich UI customization with REST API based apps
  • Disabling Hub UI
• Event logging and telemetry
  • How to emit events
  • Event schemas
• Configuring user environments
  • Installing packages
  • Configuring Jupyter and IPython
  • Installing kernelspecs
  • Multi-user hosts vs. Containers
  • Named servers
  • Switching back to the classic notebook
• Configuration examples
• Configure GitHub OAuth
• Using a reverse proxy
  • Nginx
  • Apache
• Run JupyterHub without root privileges using sudo
  • Overview
  • Create a user
  • Set up sudospawner
  • Edit /etc/sudoers
  • Test sudo setup
  • Enable PAM for non-root
  • Test that PAM works
  • Make a directory for JupyterHub
  • Start jupyterhub
  • Troubleshooting: SELinux
  • Troubleshooting: PAM session errors
• 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