On this page
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
active_server_limit (jupyterhub.app.JupyterHub attribute)
active_user_window (jupyterhub.app.JupyterHub attribute)
add() (jupyterhub.user.UserDict method)
add_all_services() (jupyterhub.proxy.Proxy method)
add_all_users() (jupyterhub.proxy.Proxy method)
add_hub_route() (jupyterhub.proxy.Proxy method)
add_route() (jupyterhub.proxy.Proxy method)
add_service() (jupyterhub.proxy.Proxy method)
add_system_user() (jupyterhub.auth.LocalAuthenticator method)
add_user() (jupyterhub.auth.Authenticator method)
(jupyterhub.auth.LocalAuthenticator method)
(jupyterhub.proxy.Proxy method)
add_user_cmd (jupyterhub.auth.LocalAuthenticator attribute)
,
[1]
(jupyterhub.auth.PAMAuthenticator attribute)
admin_access (jupyterhub.app.JupyterHub attribute)
admin_groups (jupyterhub.auth.PAMAuthenticator attribute)
admin_users (jupyterhub.app.JupyterHub attribute)
(jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
allow_all (jupyterhub.services.auth.HubAuthenticated attribute)
allow_named_servers (jupyterhub.app.JupyterHub attribute)
answer_yes (jupyterhub.app.JupyterHub attribute)
api_token (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
api_tokens (jupyterhub.app.JupyterHub attribute)
api_url (jupyterhub.proxy.ConfigurableHTTPProxy attribute)
,
[1]
(jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
args (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
auth_refresh_age (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
auth_token (jupyterhub.proxy.ConfigurableHTTPProxy attribute)
,
[1]
authenticate() (jupyterhub.auth.Authenticator method)
authenticate_prometheus (jupyterhub.app.JupyterHub attribute)
Authenticator (class in jupyterhub.auth)
authenticator_class (jupyterhub.app.JupyterHub attribute)
auto_login (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
B
base_url (jupyterhub.app.JupyterHub attribute)
(jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
bind_url (jupyterhub.app.JupyterHub attribute)
blacklist (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
C
cache_max_age (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
certfile (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
check_account (jupyterhub.auth.PAMAuthenticator attribute)
check_blacklist() (jupyterhub.auth.Authenticator method)
check_group_whitelist() (jupyterhub.auth.LocalAuthenticator method)
check_hub_user() (jupyterhub.services.auth.HubAuthenticated method)
check_routes() (jupyterhub.proxy.Proxy method)
check_whitelist() (jupyterhub.auth.Authenticator method)
(jupyterhub.auth.LocalAuthenticator method)
cleanup_proxy (jupyterhub.app.JupyterHub attribute)
cleanup_servers (jupyterhub.app.JupyterHub attribute)
clear_cookie() (jupyterhub.services.auth.HubOAuth method)
client_ca (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
cmd (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
command (jupyterhub.proxy.ConfigurableHTTPProxy attribute)
,
[1]
concurrency (jupyterhub.proxy.ConfigurableHTTPProxy attribute)
concurrent_spawn_limit (jupyterhub.app.JupyterHub attribute)
config_file (jupyterhub.app.JupyterHub attribute)
ConfigurableHTTPProxy (class in jupyterhub.proxy)
confirm_no_ssl (jupyterhub.app.JupyterHub attribute)
consecutive_failure_limit (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
cookie_max_age_days (jupyterhub.app.JupyterHub attribute)
cookie_name (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
cookie_options (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
cookie_secret (jupyterhub.app.JupyterHub attribute)
cookie_secret_file (jupyterhub.app.JupyterHub attribute)
count_active_users() (jupyterhub.user.UserDict method)
cpu_guarantee (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
cpu_limit (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
create_certs() (jupyterhub.spawner.Spawner method)
create_system_users (jupyterhub.auth.LocalAuthenticator attribute)
,
[1]
(jupyterhub.auth.PAMAuthenticator attribute)
D
data_files_path (jupyterhub.app.JupyterHub attribute)
db_kwargs (jupyterhub.app.JupyterHub attribute)
db_url (jupyterhub.app.JupyterHub attribute)
debug (jupyterhub.proxy.ConfigurableHTTPProxy attribute)
,
[1]
(jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
debug_db (jupyterhub.app.JupyterHub attribute)
debug_proxy (jupyterhub.app.JupyterHub attribute)
default_url (jupyterhub.app.JupyterHub attribute)
(jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
delete() (jupyterhub.user.UserDict method)
delete_route() (jupyterhub.proxy.Proxy method)
delete_service() (jupyterhub.proxy.Proxy method)
delete_user() (jupyterhub.auth.Authenticator method)
(jupyterhub.proxy.Proxy method)
disable_user_config (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
DummyAuthenticator (class in jupyterhub.auth)
E
enable_auth_state (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
encoding (jupyterhub.auth.PAMAuthenticator attribute)
env_keep (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
environment (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
escaped_name (jupyterhub.user.User attribute)
external_ssl_authorities (jupyterhub.app.JupyterHub attribute)
extra_handlers (jupyterhub.app.JupyterHub attribute)
extra_log_file (jupyterhub.app.JupyterHub attribute)
extra_log_handlers (jupyterhub.app.JupyterHub attribute)
F
format_string() (jupyterhub.spawner.Spawner method)
G
generate_certs (jupyterhub.app.JupyterHub attribute)
generate_config (jupyterhub.app.JupyterHub attribute)
generate_state() (jupyterhub.services.auth.HubOAuth method)
get_all_routes() (jupyterhub.proxy.Proxy method)
get_args() (jupyterhub.spawner.Spawner method)
get_authenticated_user() (jupyterhub.auth.Authenticator method)
get_current_user() (jupyterhub.services.auth.HubAuthenticated method)
get_env() (jupyterhub.spawner.Spawner method)
get_handlers() (jupyterhub.auth.Authenticator method)
get_login_url() (jupyterhub.services.auth.HubAuthenticated method)
get_next_url() (jupyterhub.services.auth.HubOAuth method)
get_route() (jupyterhub.proxy.Proxy method)
get_session_id() (jupyterhub.services.auth.HubAuth method)
get_state() (jupyterhub.spawner.Spawner method)
get_state_cookie_name() (jupyterhub.services.auth.HubOAuth method)
get_token() (jupyterhub.services.auth.HubAuth method)
get_user() (jupyterhub.services.auth.HubAuth method)
group_whitelist (jupyterhub.auth.LocalAuthenticator attribute)
,
[1]
(jupyterhub.auth.PAMAuthenticator attribute)
H
http_timeout (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
hub_auth_class (jupyterhub.services.auth.HubAuthenticated attribute)
hub_bind_url (jupyterhub.app.JupyterHub attribute)
hub_connect_ip (jupyterhub.app.JupyterHub attribute)
hub_connect_port (jupyterhub.app.JupyterHub attribute)
hub_connect_url (jupyterhub.app.JupyterHub attribute)
hub_host (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
hub_ip (jupyterhub.app.JupyterHub attribute)
hub_port (jupyterhub.app.JupyterHub attribute)
hub_prefix (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
HubAuth (class in jupyterhub.services.auth)
HubAuthenticated (class in jupyterhub.services.auth)
HubOAuth (class in jupyterhub.services.auth)
HubOAuthCallbackHandler (class in jupyterhub.services.auth)
HubOAuthenticated (class in jupyterhub.services.auth)
I
internal_certs_location (jupyterhub.app.JupyterHub attribute)
internal_ssl (jupyterhub.app.JupyterHub attribute)
interrupt_timeout (jupyterhub.spawner.LocalProcessSpawner attribute)
ip (jupyterhub.app.JupyterHub attribute)
(jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
is_admin() (jupyterhub.auth.Authenticator method)
J
jinja_environment_options (jupyterhub.app.JupyterHub attribute)
JupyterHub (class in jupyterhub.app)
jupyterhub.app (module)
jupyterhub.auth (module)
jupyterhub.proxy (module)
jupyterhub.services.auth (module)
jupyterhub.services.service (module)
jupyterhub.spawner (module)
jupyterhub.user (module)
K
keyfile (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
kill_timeout (jupyterhub.spawner.LocalProcessSpawner attribute)
kind (jupyterhub.services.service.Service attribute)
L
last_activity_interval (jupyterhub.app.JupyterHub attribute)
load_groups (jupyterhub.app.JupyterHub attribute)
LocalAuthenticator (class in jupyterhub.auth)
LocalProcessSpawner (class in jupyterhub.spawner)
log_datefmt (jupyterhub.app.JupyterHub attribute)
log_format (jupyterhub.app.JupyterHub attribute)
log_level (jupyterhub.app.JupyterHub attribute)
login_url (jupyterhub.services.auth.HubAuth attribute)
,
[1]
(jupyterhub.services.auth.HubOAuth attribute)
login_url() (jupyterhub.auth.Authenticator method)
logo_file (jupyterhub.app.JupyterHub attribute)
logout_url() (jupyterhub.auth.Authenticator method)
M
managed (jupyterhub.services.service.Service attribute)
mem_guarantee (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
mem_limit (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
move_certs() (jupyterhub.spawner.Spawner method)
N
name (jupyterhub.user.User attribute)
named_server_limit_per_user (jupyterhub.app.JupyterHub attribute)
normalize_username() (jupyterhub.auth.Authenticator method)
notebook_dir (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
O
oauth_authorization_url (jupyterhub.services.auth.HubOAuth attribute)
,
[1]
oauth_client_id (jupyterhub.services.auth.HubOAuth attribute)
,
[1]
oauth_redirect_uri (jupyterhub.services.auth.HubOAuth attribute)
,
[1]
oauth_token_url (jupyterhub.services.auth.HubOAuth attribute)
,
[1]
open_sessions (jupyterhub.auth.PAMAuthenticator attribute)
options_form (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
options_from_form() (jupyterhub.spawner.Spawner method)
P
pam_normalize_username (jupyterhub.auth.PAMAuthenticator attribute)
PAMAuthenticator (class in jupyterhub.auth)
password (jupyterhub.auth.DummyAuthenticator attribute)
pid_file (jupyterhub.app.JupyterHub attribute)
(jupyterhub.proxy.ConfigurableHTTPProxy attribute)
poll() (jupyterhub.spawner.Spawner method)
poll_interval (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
popen_kwargs (jupyterhub.spawner.LocalProcessSpawner attribute)
port (jupyterhub.app.JupyterHub attribute)
(jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
post_auth_hook (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
post_spawn_stop() (jupyterhub.auth.Authenticator method)
post_stop_hook (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
pre_spawn_hook (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
pre_spawn_start() (jupyterhub.auth.Authenticator method)
Proxy (class in jupyterhub.proxy)
proxy_api_ip (jupyterhub.app.JupyterHub attribute)
proxy_api_port (jupyterhub.app.JupyterHub attribute)
proxy_auth_token (jupyterhub.app.JupyterHub attribute)
proxy_check_interval (jupyterhub.app.JupyterHub attribute)
proxy_class (jupyterhub.app.JupyterHub attribute)
proxy_cmd (jupyterhub.app.JupyterHub attribute)
R
recreate_internal_certs (jupyterhub.app.JupyterHub attribute)
redirect_to_server (jupyterhub.app.JupyterHub attribute)
refresh_pre_spawn (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
refresh_user() (jupyterhub.auth.Authenticator method)
reset_db (jupyterhub.app.JupyterHub attribute)
run_post_auth_hook() (jupyterhub.auth.Authenticator method)
S
server (jupyterhub.user.User attribute)
Service (class in jupyterhub.services.service)
service (jupyterhub.auth.PAMAuthenticator attribute)
service_check_interval (jupyterhub.app.JupyterHub attribute)
service_tokens (jupyterhub.app.JupyterHub attribute)
services (jupyterhub.app.JupyterHub attribute)
set_cookie() (jupyterhub.services.auth.HubOAuth method)
set_state_cookie() (jupyterhub.services.auth.HubOAuth method)
shell_cmd (jupyterhub.spawner.LocalProcessSpawner attribute)
should_start (jupyterhub.proxy.ConfigurableHTTPProxy attribute)
(jupyterhub.proxy.Proxy attribute)
,
[1]
shutdown_on_logout (jupyterhub.app.JupyterHub attribute)
Spawner (class in jupyterhub.spawner)
spawner (jupyterhub.user.User attribute)
spawner_class (jupyterhub.app.JupyterHub attribute)
ssl_alt_names (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
ssl_alt_names_include_local (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
ssl_cert (jupyterhub.app.JupyterHub attribute)
ssl_key (jupyterhub.app.JupyterHub attribute)
start() (jupyterhub.proxy.Proxy method)
(jupyterhub.spawner.Spawner method)
start_timeout (jupyterhub.spawner.LocalProcessSpawner attribute)
(jupyterhub.spawner.Spawner attribute)
state_cookie_name (jupyterhub.services.auth.HubOAuth attribute)
statsd_host (jupyterhub.app.JupyterHub attribute)
statsd_port (jupyterhub.app.JupyterHub attribute)
statsd_prefix (jupyterhub.app.JupyterHub attribute)
stop() (jupyterhub.proxy.Proxy method)
(jupyterhub.spawner.Spawner method)
subdomain_host (jupyterhub.app.JupyterHub attribute)
system_user_exists() (jupyterhub.auth.LocalAuthenticator method)
T
template_namespace() (jupyterhub.spawner.Spawner method)
template_paths (jupyterhub.app.JupyterHub attribute)
template_vars (jupyterhub.app.JupyterHub attribute)
term_timeout (jupyterhub.spawner.LocalProcessSpawner attribute)
token_for_code() (jupyterhub.services.auth.HubOAuth method)
tornado_settings (jupyterhub.app.JupyterHub attribute)
trust_user_provided_tokens (jupyterhub.app.JupyterHub attribute)
trusted_alt_names (jupyterhub.app.JupyterHub attribute)
trusted_downstream_ips (jupyterhub.app.JupyterHub attribute)
U
upgrade_db (jupyterhub.app.JupyterHub attribute)
User (class in jupyterhub.user)
user_for_cookie() (jupyterhub.services.auth.HubAuth method)
user_for_token() (jupyterhub.services.auth.HubAuth method)
UserDict (class in jupyterhub.user)
username_map (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
username_pattern (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
V
validate_routespec() (jupyterhub.proxy.Proxy method)
validate_username() (jupyterhub.auth.Authenticator method)
W
whitelist (jupyterhub.auth.Authenticator attribute)
,
[1]
(jupyterhub.auth.DummyAuthenticator attribute)
(jupyterhub.auth.LocalAuthenticator attribute)
(jupyterhub.auth.PAMAuthenticator attribute)
JupyterHub
Documentation for JupyterHub
Quick search
Table of Contents
Installation Guide
Quickstart
Using Docker
Installation Basics
Getting Started
Configuration Basics
Networking basics
Security settings
Authentication and User Basics
Spawners and single-user notebook servers
External services
Technical Reference
Technical Overview
Security Overview
Authenticators
Spawners
Services
Using JupyterHub’s REST API
Working with templates and UI
Configuring user environments
Configuration examples
Configure GitHub OAuth
Using a reverse proxy
Run JupyterHub without root privileges using
sudo
Community communication channels
Setting up a development install
Contributing Documentation
Testing JupyterHub
The JupyterHub roadmap
Reporting security issues in Jupyter or JupyterHub
Upgrading JupyterHub
Changelog
The JupyterHub API
Troubleshooting
Contributors
Changelog
A Gallery of JupyterHub Deployments
Installation Guide
Getting Started
Technical Reference
The JupyterHub API
Troubleshooting
Contributors
A Gallery of JupyterHub Deployments
Changelog
GitHub Repo
Issue Tracker
Navigation
Documentation Home