.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH JUPYTERHUB "1" "November 2022" "jupyterhub 3.0.0+ds1" "User Commands"
.SH NAME
jupyterhub \- Multi-user server for Jupyter notebooks
.SH DESCRIPTION
Start a multi\-user Jupyter Notebook server
.IP
Spawns a configurable\-http\-proxy and multi\-user Hub,
which authenticates users and spawns single\-user Notebook servers
on behalf of users.
.PP
Subcommands
===========
Subcommands are launched as `jupyterhub cmd [args]`. For information on using
subcommand 'cmd', do: `jupyterhub cmd \fB\-h\fR`.
.PP
token
.IP
Generate an API token for a user
.PP
upgrade\-db
.IP
Upgrade your JupyterHub state database to the current version.
.PP
Options
=======
The options below are convenience aliases to configurable class\-options,
as listed in the "Equivalent to" description\-line of the aliases.
To see all configurable class\-options for some <cmd>, use:
.IP
<cmd> \fB\-\-help\-all\fR
.PP
\fB\-\-debug\fR
.IP
set log level to logging.DEBUG (maximize logging output)
Equivalent to: [\-\-Application.log_level=10]
.PP
\fB\-\-show\-config\fR
.IP
Show the application's configuration (human\-readable format)
Equivalent to: [\-\-Application.show_config=True]
.PP
\fB\-\-show\-config\-json\fR
.IP
Show the application's configuration (json format)
Equivalent to: [\-\-Application.show_config_json=True]
.PP
\fB\-\-generate\-config\fR
.IP
generate default config file
Equivalent to: [\-\-JupyterHub.generate_config=True]
.PP
\fB\-\-generate\-certs\fR
.IP
generate certificates used for internal ssl
Equivalent to: [\-\-JupyterHub.generate_certs=True]
.PP
\fB\-\-no\-db\fR
.IP
disable persisting state database to disk
Equivalent to: [\-\-JupyterHub.db_url=sqlite:///:memory:]
.PP
\fB\-\-upgrade\-db\fR
.IP
Automatically upgrade the database if needed on startup.
.IP
Only safe if the database has been backed up.
Only SQLite database files will be backed up automatically.
.IP
Equivalent to: [\-\-JupyterHub.upgrade_db=True]
.PP
\fB\-\-no\-ssl\fR
.IP
[DEPRECATED in 0.7: does nothing]
Equivalent to: [\-\-JupyterHub.confirm_no_ssl=True]
.PP
\fB\-\-base\-url=\fR<URLPrefix>
.IP
The base URL of the entire application.
.IP
Add this to the beginning of all JupyterHub URLs.
Use base_url to run JupyterHub within an existing website.
\&.. deprecated: 0.9
.IP
Use JupyterHub.bind_url
.IP
Default: '/'
Equivalent to: [\-\-JupyterHub.base_url]
.PP
\fB\-y=\fR<Bool>
.IP
Answer yes to any questions (e.g. confirm overwrite)
Default: False
Equivalent to: [\-\-JupyterHub.answer_yes]
.PP
\fB\-\-ssl\-key=\fR<Unicode>
.IP
Path to SSL key file for the public facing interface of the proxy
.IP
When setting this, you should also set ssl_cert
.IP
Default: ''
Equivalent to: [\-\-JupyterHub.ssl_key]
.PP
\fB\-\-ssl\-cert=\fR<Unicode>
.IP
Path to SSL certificate file for the public facing interface of the proxy
.IP
When setting this, you should also set ssl_key
.IP
Default: ''
Equivalent to: [\-\-JupyterHub.ssl_cert]
.PP
\fB\-\-url=\fR<Unicode>
.IP
The public facing URL of the whole JupyterHub application.
.IP
This is the address on which the proxy will bind.
Sets protocol, ip, base_url
.IP
Default: 'http://:8000'
Equivalent to: [\-\-JupyterHub.bind_url]
.PP
\fB\-\-ip=\fR<Unicode>
.IP
The public facing ip of the whole JupyterHub application
.IP
(specifically referred to as the proxy).
This is the address on which the proxy will listen. The default is to
listen on all interfaces. This is the only address through which JupyterHub
should be accessed by users.
\&.. deprecated: 0.9
.IP
Use JupyterHub.bind_url
.IP
Default: ''
Equivalent to: [\-\-JupyterHub.ip]
.PP
\fB\-\-port=\fR<Int>
.IP
The public facing port of the proxy.
.IP
This is the port on which the proxy will listen.
This is the only port through which JupyterHub
should be accessed by users.
\&.. deprecated: 0.9
.IP
Use JupyterHub.bind_url
.IP
Default: 8000
Equivalent to: [\-\-JupyterHub.port]
.PP
\fB\-\-pid\-file=\fR<Unicode>
.IP
File to write PID
.IP
Useful for daemonizing JupyterHub.
.IP
Default: ''
Equivalent to: [\-\-JupyterHub.pid_file]
.PP
\fB\-\-log\-file=\fR<Unicode>
.IP
DEPRECATED: use output redirection instead, e.g.
jupyterhub &>> \fI\,/var/log/jupyterhub.log\/\fP
Default: ''
Equivalent to: [\-\-JupyterHub.extra_log_file]
.PP
\fB\-\-log\-level=\fR<Enum>
.IP
Set the log level by value or name.
Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
Default: 30
Equivalent to: [\-\-Application.log_level]
.PP
\fB\-f=\fR<Unicode>
.IP
The config file to load
Default: 'jupyterhub_config.py'
Equivalent to: [\-\-JupyterHub.config_file]
.PP
\fB\-\-config=\fR<Unicode>
.IP
The config file to load
Default: 'jupyterhub_config.py'
Equivalent to: [\-\-JupyterHub.config_file]
.PP
\fB\-\-db=\fR<Unicode>
.IP
url for the database. e.g. `sqlite:///jupyterhub.sqlite`
Default: 'sqlite:///jupyterhub.sqlite'
Equivalent to: [\-\-JupyterHub.db_url]
.PP
Examples
\fB\-\-\-\-\-\-\-\-\fR
.IP
generate default config file:
.IP
jupyterhub \fB\-\-generate\-config\fR \fB\-f\fR \fI\,/etc/jupyterhub/jupyterhub_config.py\/\fP
.IP
spawn the server on 10.0.1.2:443 with https:
.IP
jupyterhub \fB\-\-ip\fR 10.0.1.2 \fB\-\-port\fR 443 \fB\-\-ssl\-key\fR my_ssl.key \fB\-\-ssl\-cert\fR my_ssl.cert
.PP
To see all available configurables, use `\-\-help\-all`.
.SH "SEE ALSO"
The full documentation for
.B jupyterhub
is maintained as a Texinfo manual.  If the
.B info
and
.B jupyterhub
programs are properly installed at your site, the command
.IP
.B info jupyterhub
.PP
should give you access to the complete manual.