Getting Started

• Configuration Basics
  • Generate a default config file
  • Start with a specific config file
  • Configure using command line options
  • Configure for various deployment environments
  • Run the proxy separately
• Networking basics
  • Set the Proxy’s IP address and port
  • Set the Proxy’s REST API communication URL (optional)
  • Configure the Hub if the Proxy or Spawners are remote or isolated
  • Adjusting the hub’s URL
• Security settings
  • Enabling SSL encryption
  • Cookie secret
  • Proxy authentication token
• Authentication and User Basics
  • Create a whitelist of users
  • Configure admins (admin_users)
  • Give admin access to other users’ notebook servers (admin_access)
  • Add or remove users from the Hub
  • Use LocalAuthenticator to create system users
  • Use OAuthenticator to support OAuth with popular service providers
  • Use DummyAuthenticator for testing
• Spawners and single-user notebook servers
• External services
  • Real-world example to cull idle servers
  • API Token basics
  • Authenticating to single-user servers using API token
  • Configure cull-idle to run as a Hub-Managed Service
  • Run cull-idle manually as a standalone script