How-to

The How-to guides provide practical step-by-step details to help you achieve a particular goal. They are useful when you are trying to get something done but require you to understand and adapt the steps to your specific usecase.

Use the following guides when:

• Deploying JupyterHub in “API only mode”
• Writing a custom Proxy implementation
• Using JupyterHub’s REST API
• Running proxy separately from the hub
• Working with templates and UI
• Upgrading JupyterHub
• Interpreting common log messages

Configuration

The following guides provide examples, including configuration files and tips, for the following:

• Configuring user environments
• Configure GitHub OAuth
• Using a reverse proxy
• Run JupyterHub without root privileges using sudo