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

Update to the services.md

Browse Source
This commit is contained in:
lumenCodes
2022-10-24 17:47:49 +01:00
parent 88e2346bf2
commit 8ffa07e82d
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/reference/services.md
View File

@@ -146,8 +146,8 @@ See the GitHub repo for additional information about the [jupyterhub_idle_culler
## Externally-Managed Services ## Externally-Managed Services
You may prefer to use your own service management tools, such as Docker or You may prefer to use your service management tools, such as `Docker` or
systemd, to manage a JupyterHub Service. These **Externally-Managed `systemd`, to manage a JupyterHub Service. These **Externally-Managed
Services**, unlike Hub-Managed Services, are not subprocesses of the Hub. You Services**, unlike Hub-Managed Services, are not subprocesses of the Hub. You
must tell JupyterHub which API token the Externally-Managed Service is using must tell JupyterHub which API token the Externally-Managed Service is using
to perform its API requests. Each Externally-Managed Service will need a to perform its API requests. Each Externally-Managed Service will need a
@@ -186,7 +186,7 @@ information to the Service via the environment variables described above. A
flexible Service, whether managed by the Hub or not, can make use of these flexible Service, whether managed by the Hub or not, can make use of these
same environment variables. same environment variables.
When you run a service that has a url, it will be accessible under a When you run a service that has a `url`, it will be accessible under a
`/services/` prefix, such as `https://myhub.horse/services/my-service/`. For `/services/` prefix, such as `https://myhub.horse/services/my-service/`. For
your service to route proxied requests properly, it must take your service to route proxied requests properly, it must take
`JUPYTERHUB_SERVICE_PREFIX` into account when routing requests. For example, a `JUPYTERHUB_SERVICE_PREFIX` into account when routing requests. For example, a
@@ -257,7 +257,7 @@ which makes a request of the Hub, and returns:
You are then free to use the returned user information to take appropriate You are then free to use the returned user information to take appropriate
action. action.
HubAuth also caches the Hub's response for a number of seconds, HubAuth also caches the Hub's response for some seconds,
configurable by the `cookie_cache_max_age` setting (default: five minutes). configurable by the `cookie_cache_max_age` setting (default: five minutes).
If your service would like to make further requests _on behalf of users_, If your service would like to make further requests _on behalf of users_,
@@ -268,7 +268,7 @@ you can access the token authenticating the current request with {meth}`.HubAuth
:::{versionchanged} 2.2 :::{versionchanged} 2.2
{meth}`.HubAuth.get_token` adds support for retrieving {meth}`.HubAuth.get_token` adds support for retrieving
tokens stored in tornado cookies after completion of OAuth. tokens stored in tornado cookies after the completion of OAuth.
Previously, it only retrieved tokens from URL parameters or the Authorization header. Previously, it only retrieved tokens from URL parameters or the Authorization header.
Passing `get_token(handler, in_cookie=False)` preserves this behavior. Passing `get_token(handler, in_cookie=False)` preserves this behavior.
::: :::