--- name: "jupyterhub-singleuser" section: "1" platform: "linux" package: "jupyterhub" version: "5.2.1+ds1-4" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/jupyterhub-singleuser" --- # jupyterhub-singleuser(1) Single-user server for Jupyter notebooks ## NAME jupyterhub-singleuser - Single-user server for Jupyter notebooks ## DESCRIPTION Single-user server for JupyterHub. Extends the Jupyter Notebook server. Meant to be invoked by JupyterHub Spawners, not directly. 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 \, use: - \ **--help-all** **--debug** - set log level to logging.DEBUG (maximize logging output) Equivalent to: \[--Application.log\_level=10\] **--show-config** - Show the application's configuration (human-readable format) Equivalent to: \[--Application.show\_config=True\] **--show-config-json** - Show the application's configuration (json format) Equivalent to: \[--Application.show\_config\_json=True\] **--generate-config** - generate default config file Equivalent to: \[--JupyterApp.generate\_config=True\] **-y** - Answer yes to any questions instead of prompting. Equivalent to: \[--JupyterApp.answer\_yes=True\] **--no-browser** - Don't open the notebook in a browser after startup. Equivalent to: \[--NotebookApp.open\_browser=False\] **--pylab** - DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib. Equivalent to: \[--NotebookApp.pylab=warn\] **--no-mathjax** - Disable MathJax - MathJax is the javascript library Jupyter uses to render math/LaTeX. It is very large, so you may want to disable it if you have a slow internet connection, or for offline use of the notebook. - When disabled, equations etc. will appear as their untransformed TeX source. - Equivalent to: \[--NotebookApp.enable\_mathjax=False\] **--allow-root** - Allow the notebook to be run from root user. Equivalent to: \[--NotebookApp.allow\_root=True\] **--autoreload** - Autoreload the webapp - Enable reloading of the tornado webapp and all imported Python packages when any changes are made to any Python src files in Notebook or extensions. - Equivalent to: \[--NotebookApp.autoreload=True\] **--script** - DEPRECATED, IGNORED Equivalent to: \[--FileContentsManager.save\_script=True\] **--no-script** - DEPRECATED, IGNORED Equivalent to: \[--FileContentsManager.save\_script=False\] **--disable-user-config** - Disable user-controlled configuration of the notebook server. Equivalent to: \[--SingleUserNotebookApp.disable\_user\_config=True\] **--log-level=**\ - 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\] **--config=**\ - Full path of a config file. Default: '' Equivalent to: \[--JupyterApp.config\_file\] **--ip=**\ - The IP address the notebook server will listen on. Default: 'localhost' Equivalent to: \[--NotebookApp.ip\] **--port=**\ - The port the notebook server will listen on (env: JUPYTER\_PORT). Default: 8888 Equivalent to: \[--NotebookApp.port\] **--port-retries=**\ - The number of additional ports to try if the specified port is not available (env: JUPYTER\_PORT\_RETRIES). Default: 50 Equivalent to: \[--NotebookApp.port\_retries\] **--sock=**\ - The UNIX socket the notebook server will listen on. Default: '' Equivalent to: \[--NotebookApp.sock\] **--sock-mode=**\ - The permissions mode for UNIX socket creation (default: 0600). Default: '0600' Equivalent to: \[--NotebookApp.sock\_mode\] **--transport=**\ - Choices: any of \['tcp', 'ipc'\] (case-insensitive) Default: 'tcp' Equivalent to: \[--KernelManager.transport\] **--keyfile=**\ - The full path to a private key file for usage with SSL/TLS. Default: '' Equivalent to: \[--NotebookApp.keyfile\] **--certfile=**\ - The full path to an SSL/TLS certificate file. Default: '' Equivalent to: \[--NotebookApp.certfile\] **--client-ca=**\ - The full path to a certificate authority certificate for SSL/TLS client authentication. Default: '' Equivalent to: \[--NotebookApp.client\_ca\] **--notebook-dir=**\ - The directory to use for notebooks and kernels. Default: '' Equivalent to: \[--NotebookApp.notebook\_dir\] **--browser=**\ - Specify what command to use to invoke a web browser when opening the notebook. If not specified, the default browser will be determined by the \`webbrowser\` standard library module, which allows setting of the BROWSER environment variable to override it. - Default: '' Equivalent to: \[--NotebookApp.browser\] **--pylab=**\ - DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib. Default: 'disabled' Equivalent to: \[--NotebookApp.pylab\] **--gateway-url=**\ - The url of the Kernel or Enterprise Gateway server where - kernel specifications are defined and kernel management takes place. If defined, this Notebook server acts as a proxy for all kernel management and kernel specification retrieval. (JUPYTER\_GATEWAY\_URL env var) - Default: None Equivalent to: \[--GatewayClient.url\] **--user=**\ - Default: '' Equivalent to: \[--SingleUserNotebookApp.user\] **--group=**\ - Default: '' Equivalent to: \[--SingleUserNotebookApp.group\] **--hub-prefix=**\ - Default: '/hub/' Equivalent to: \[--SingleUserNotebookApp.hub\_prefix\] **--hub-host=**\ - Default: '' Equivalent to: \[--SingleUserNotebookApp.hub\_host\] **--hub-api-url=**\ - Default: '' Equivalent to: \[--SingleUserNotebookApp.hub\_api\_url\] **--base-url=**\ - The base URL for the notebook server. Leading and trailing slashes can be omitted, and will automatically be added. - Default: '/' Equivalent to: \[--SingleUserNotebookApp.base\_url\] To see all available configurables, use \`--help-all\`. ## SEE ALSO The full documentation for **jupyterhub-singleuser** is maintained as a Texinfo manual. If the **info** and **jupyterhub-singleuser** programs are properly installed at your site, the command - **info jupyterhub-singleuser** should give you access to the complete manual.