From e580b907c3c94e26030684b8ba9d4311f8aea9b7 Mon Sep 17 00:00:00 2001 From: Simon Li Date: Thu, 15 Dec 2022 14:05:24 +0000 Subject: [PATCH] spawners.md: format env vars as code (avoids prettier bug) --- docs/source/reference/spawners.md | 34 +++++++++++++++---------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/source/reference/spawners.md b/docs/source/reference/spawners.md index 87e3e9d1..26ff01d2 100644 --- a/docs/source/reference/spawners.md +++ b/docs/source/reference/spawners.md @@ -297,36 +297,36 @@ Additional variables can be specified via the `Spawner.environment` configuratio The process environment is returned by `Spawner.get_env`, which specifies the following environment variables: -- JUPYTERHUB_SERVICE_URL - the \_bind* URL where the server should launch its HTTP server (`http://127.0.0.1:12345`). +- `JUPYTERHUB_SERVICE_URL` - the _bind_ URL where the server should launch its HTTP server (`http://127.0.0.1:12345`). This includes `Spawner.ip` and `Spawner.port`; _new in 2.0, prior to 2.0 IP, port were on the command-line and only if specified_ -- JUPYTERHUB_SERVICE_PREFIX - the URL prefix the service will run on (e.g. `/user/name/`) -- JUPYTERHUB_USER - the JupyterHub user's username -- JUPYTERHUB_SERVER_NAME - the server's name, if using named servers (default server has an empty name) -- JUPYTERHUB_API_URL - the full URL for the JupyterHub API (http://17.0.0.1:8001/hub/api) -- JUPYTERHUB_BASE_URL - the base URL of the whole jupyterhub deployment, i.e. the bit before `hub/` or `user/`, +- `JUPYTERHUB_SERVICE_PREFIX` - the URL prefix the service will run on (e.g. `/user/name/`) +- `JUPYTERHUB_USER` - the JupyterHub user's username +- `JUPYTERHUB_SERVER_NAME` - the server's name, if using named servers (default server has an empty name) +- `JUPYTERHUB_API_URL` - the full URL for the JupyterHub API (http://17.0.0.1:8001/hub/api) +- `JUPYTERHUB_BASE_URL` - the base URL of the whole jupyterhub deployment, i.e. the bit before `hub/` or `user/`, as set by `c.JupyterHub.base_url` (default: `/`) -- JUPYTERHUB_API_TOKEN - the API token the server can use to make requests to the Hub. +- `JUPYTERHUB_API_TOKEN` - the API token the server can use to make requests to the Hub. This is also the OAuth client secret. -- JUPYTERHUB_CLIENT_ID - the OAuth client ID for authenticating visitors. -- JUPYTERHUB_OAUTH_CALLBACK_URL - the callback URL to use in OAuth, typically `/user/:name/oauth_callback` -- JUPYTERHUB_OAUTH_ACCESS_SCOPES - the scopes required to access the server (called JUPYTERHUB_OAUTH_SCOPES prior to 3.0) -- JUPYTERHUB_OAUTH_CLIENT_ALLOWED_SCOPES - the scopes the service is allowed to request. +- `JUPYTERHUB_CLIENT_ID` - the OAuth client ID for authenticating visitors. +- `JUPYTERHUB_OAUTH_CALLBACK_URL` - the callback URL to use in OAuth, typically `/user/:name/oauth_callback` +- `JUPYTERHUB_OAUTH_ACCESS_SCOPES` - the scopes required to access the server (called `JUPYTERHUB_OAUTH_SCOPES` prior to 3.0) +- `JUPYTERHUB_OAUTH_CLIENT_ALLOWED_SCOPES` - the scopes the service is allowed to request. If no scopes are requested explicitly, these scopes will be requested. Optional environment variables, depending on configuration: -- JUPYTERHUB_SSL_[KEYFILE|CERTFILE|CLIENT_CI] - SSL configuration, when `internal_ssl` is enabled -- JUPYTERHUB_ROOT_DIR - the root directory of the server (notebook directory), when `Spawner.notebook_dir` is defined (new in 2.0) -- JUPYTERHUB_DEFAULT_URL - the default URL for the server (for redirects from `/user/:name/`), +- `JUPYTERHUB_SSL_[KEYFILE|CERTFILE|CLIENT_CI]` - SSL configuration, when `internal_ssl` is enabled +- `JUPYTERHUB_ROOT_DIR` - the root directory of the server (notebook directory), when `Spawner.notebook_dir` is defined (new in 2.0) +- `JUPYTERHUB_DEFAULT_URL` - the default URL for the server (for redirects from `/user/:name/`), if `Spawner.default_url` is defined (new in 2.0, previously passed via CLI) -- JUPYTERHUB_DEBUG=1 - generic debug flag, sets maximum log level when `Spawner.debug` is True +- `JUPYTERHUB_DEBUG=1` - generic debug flag, sets maximum log level when `Spawner.debug` is True (new in 2.0, previously passed via CLI) -- JUPYTERHUB_DISABLE_USER_CONFIG=1 - disable loading user config, +- `JUPYTERHUB_DISABLE_USER_CONFIG=1` - disable loading user config, sets maximum log level when `Spawner.debug` is True (new in 2.0, previously passed via CLI) -- JUPYTERHUB_[MEM|CPU]_[LIMIT_GUARANTEE] - the values of CPU and memory limits and guarantees. +- `JUPYTERHUB_[MEM|CPU]_[LIMIT_GUARANTEE]` - the values of CPU and memory limits and guarantees. These are not expected to be enforced by the process, but are made available as a hint, e.g. for resource monitoring extensions.