jupyter-server

Version:: 2.14.2
Category:: tools
Cluster:: Loki

Author / Distributor

Description

The Jupyter Server provides the backend (i.e. the core services, APIs, and REST endpoints) for Jupyter web applications like Jupyter notebook, JupyterLab, and Voila.

Note

Refer to the JupyterLab Module Update (Loki) guide for full setup and examples.

Documentation

   The Jupyter Server.

   This launches a Tornado-based Jupyter Server.

Subcommands
===========
Subcommands are launched as `jupyter-server cmd [args]`. For information on
using subcommand 'cmd', do: `jupyter-server cmd -h`.

list
   List currently running Jupyter servers.
stop
   Stop currently running Jupyter server for a given port
password
   Set a password for the Jupyter server.
extension
   Work with Jupyter server extensions

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:
   <cmd> --help-all

--debug
   Set debug level for the extension and underlying server applications.
   Equivalent to: [--ServerApp.log_level=DEBUG --ExtensionApp.log_level=DEBUG]
--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]
--allow-root
   Allow the server to be run from root user.
   Equivalent to: [--ServerApp.allow_root=True]
--no-browser
   Prevent the opening of the default url in the browser.
   Equivalent to: [--ServerApp.open_browser=False --ExtensionApp.open_browser=False]
--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 server or
       extensions.
   Equivalent to: [--ServerApp.autoreload=True]
--script
   DEPRECATED, IGNORED
   Equivalent to: [--FileContentsManager.save_script=True]
--no-script
   DEPRECATED, IGNORED
   Equivalent to: [--FileContentsManager.save_script=False]
--log-level=<Enum>
   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=<Unicode>
   Full path of a config file.
   Default: ''
   Equivalent to: [--JupyterApp.config_file]
--ip=<Unicode>
   The IP address the Jupyter server will listen on.
   Default: 'localhost'
   Equivalent to: [--ServerApp.ip]
--port=<Int>
   The port the server will listen on (env: JUPYTER_PORT).
   Default: 0
   Equivalent to: [--ServerApp.port]
--port-retries=<Int>
   The number of additional ports to try if the specified port is not available
   (env: JUPYTER_PORT_RETRIES).
   Default: 50
   Equivalent to: [--ServerApp.port_retries]
--sock=<Unicode>
   The UNIX socket the Jupyter server will listen on.
   Default: ''
   Equivalent to: [--ServerApp.sock]
--sock-mode=<Unicode>
   The permissions mode for UNIX socket creation (default: 0600).
   Default: '0600'
   Equivalent to: [--ServerApp.sock_mode]
--transport=<CaselessStrEnum>
   Choices: any of ['tcp', 'ipc'] (case-insensitive)
   Default: 'tcp'
   Equivalent to: [--KernelManager.transport]
--keyfile=<Unicode>
   The full path to a private key file for usage with SSL/TLS.
   Default: ''
   Equivalent to: [--ServerApp.keyfile]
--certfile=<Unicode>
   The full path to an SSL/TLS certificate file.
   Default: ''
   Equivalent to: [--ServerApp.certfile]
--client-ca=<Unicode>
   The full path to a certificate authority certificate for SSL/TLS client
   authentication.
   Default: ''
   Equivalent to: [--ServerApp.client_ca]
--notebook-dir=<Unicode>
   The directory to use for notebooks and kernels.
   Default: ''
   Equivalent to: [--ServerApp.root_dir]
--preferred-dir=<Unicode>
   Preferred starting directory to use for notebooks and kernels.
   ServerApp.preferred_dir is deprecated in jupyter-server 2.0. Use
   FileContentsManager.preferred_dir instead
   Default: ''
   Equivalent to: [--ServerApp.preferred_dir]
--browser=<Unicode>
   Specify what command to use to invoke a web
                         browser when starting the server. 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: [--ServerApp.browser]
--pylab=<Unicode>
   DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib.
   Default: 'disabled'
   Equivalent to: [--ServerApp.pylab]
--gateway-url=<Unicode>
   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]

Examples
--------

   jupyter server                       # start the server
   jupyter server  --certfile=mycert.pem # use SSL/TLS certificate
   jupyter server password              # enter a password to protect the server

To see all available configurables, use `--help-all`.

Examples/Usage

List available modules:
```
$ module avail jupyter-server
```

Load the jupyter-server module:

$ module load jupyter-server/2.14.2-GCCcore-13.3.0

Check the loaded modules:
```
$ module list
```

Unload the jupyter-server module:

$ module unload jupyter-server/2.14.2-GCCcore-13.3.0

Run help commands from jupyter-server:
```
$ jupyter-server --help
```
Show the application’s configuration:
```
$ jupyter-server --config
```

Installation

Source code is obtained from jupyter-server