hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 07:23:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix formatting of spawner env-vars

Browse Source
This commit is contained in:
Simon Li
2022-12-02 17:39:11 +00:00
parent 681ff09e06
commit cfc93d8555
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/reference/spawners.md
View File

@@ -297,7 +297,7 @@ 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: 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_ 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_SERVICE_PREFIX - the URL prefix the service will run on (e.g. `/user/name/`)
- JUPYTERHUB_USER - the JupyterHub user's username - JUPYTERHUB_USER - the JupyterHub user's username
@@ -315,7 +315,7 @@ The process environment is returned by `Spawner.get_env`, which specifies the fo
Optional environment variables, depending on configuration: Optional environment variables, depending on configuration:
- JUPYTERHUB*SSL*[KEYFILE|CERTFILE|CLIENT_CI] - SSL configuration, when `internal_ssl` is enabled - 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_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_DEFAULT_URL - the default URL for the server (for redirects from `/user/:name/`),
if `Spawner.default_url` is defined if `Spawner.default_url` is defined
@@ -326,7 +326,7 @@ Optional environment variables, depending on configuration:
sets maximum log level when `Spawner.debug` is True (new in 2.0, sets maximum log level when `Spawner.debug` is True (new in 2.0,
previously passed via CLI) 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, These are not expected to be enforced by the process,
but are made available as a hint, but are made available as a hint,
e.g. for resource monitoring extensions. e.g. for resource monitoring extensions.