JUPYTER-SERVER(1)

✨ JUPYTER-SERVER ✨

okay so bestie, listen — this is the manual page for jupyter-server, from the User Commands section, and it's literally your golden ticket to spinning up a tornado-based Jupyter server. yes. tornado. like the weather but for your notebooks. 🌪️✨

💖 NAME 💖

jupyter-server — start a tornado-based jupyter server

no cap, that's the whole job description.

🌸 SYNOPSIS 🌸

jupyter-server <subcommand> [<options>]

that's it. that's the shape of it. subcommand first, options after, main character energy throughout. 👑

🎀 SUBCOMMANDS 🎀

so you've got four lil subcommands and each one is doing its own thing:

• list — shows you all the notebook servers that are currently running. like a lil roster. a vibe check of what's alive. 🦋
• stop — stops a currently running Jupyter server, but only for a given port. you gotta tell it which port, bestie. it's not a mind reader. 💅
• password — sets a password for the Jupyter server. protect the whole thing. lock it down. 🔐
• extension — work with Jupyter server extensions. that's where the extension business lives.

✨ OPTIONS ✨

buckle up, there's a bunch, and we're doing ALL of them, no skipping, no summarising, because every single flag matters. 🫶

• --help-all — lists the available options for this command. it's giving "show me everything."
• --debug — sets the log level to logging.DEBUG, which means it maximizes logging output. maximum yapping. you will see everything. 😭
• --generate-config — generates the default config file. new config, fresh start, slay. ✨
• -y — answers yes to any questions instead of prompting you. it just says yes for you. very confident. very decisive.
• --allow-root — allows the server to be run from the root user. (root user, bestie. be careful out there. 🙈)
• --no-browser — prevents the default url from being opened in the browser. it will NOT pop a tab on you. respectful honestly.
• --log-level=<Enum> — set the log level by value or name. choices are any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']. default is 30.
• --config=<Unicode> — the full path of a config file. default is ''.
• --ip=<Unicode> — the IP address the Jupyter server will listen on. default is 'localhost'.
• --port=<Int> — the port the Jupyter server will listen on. default is 8888.
• --port-retries=<Int> — the number of additional ports to try if the specified port is not available. default is 50. it's persistent. it's not giving up on you. 💪
• --transport=<CaselessStrEnum> — choices are any of ['tcp', 'ipc'] (case-insensitive). default is 'tcp'.
• --keyfile=<Unicode> — the full path to a private key file for usage with SSL/TLS. default is ''.
• --certfile=<Unicode> — the full path to an SSL/TLS certificate file. default is ''.
• --client-ca=<Unicode> — the full path to a certificate authority certificate for SSL/TLS client authentication. default is ''.
• --notebook-dir=<Unicode> — the directory to use for notebooks and kernels. default is ''.
• --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 is ''.
• --pylab=<Unicode> — DISABLED: use %pylab or %matplotlib in the notebook to enable matplotlib. default is 'disabled'.

⚠️ bestie, --pylab is DISABLED. do not come for it. go use %pylab or %matplotlib in the notebook instead, okay? okay. 💀

• --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. (this one reads the JUPYTER_GATEWAY_URL env var). default is None.

🌈 EXAMPLES 🌈

here's how it actually looks in the wild, copy-paste ready:

jupyter server # start the server

jupyter server --certfile=mycert.pem # use SSL/TLS certificate

jupyter server password # enter a password to protect the server

three lil lines. start it, secure it, lock it. iconic behaviour honestly. 👑

and that's the whole page, bestie!! this was jupyter-server version 1.0.5, dated October 2020, so go forth, start your server, and remember: it's giving tornado, it's giving notebooks, it's giving absolute legend. 💜🦋✨🎀💅