From 264a78e2ccd3fbe839d16b17d108fdccac556dee Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Tue, 8 Aug 2017 15:46:47 -0700 Subject: [PATCH] Add note about single-user servers auth and tokens --- docs/source/services-basics.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/source/services-basics.md b/docs/source/services-basics.md index 6ea7cad2..5c6e5771 100644 --- a/docs/source/services-basics.md +++ b/docs/source/services-basics.md @@ -13,6 +13,8 @@ JupyterHub has a REST API that can be used by external services. This document will: - explain some basic information about API tokens +- clarify that API tokens can be used to authenticate to + single-user servers as of [version 0.8.0](./changelog.html) - show how the [cull_idle_servers]_ script can be: - used in a Hub-managed service - run as a standalone script @@ -56,6 +58,7 @@ the **key** is the 'token' while the **value** is the 'username'): c.JupyterHub.api_tokens = {'token' : 'username'} ``` + ### Restart JupyterHub Upon restarting JupyterHub, you should see a message like below in the @@ -65,6 +68,12 @@ logs: Adding API token for ``` +## Authenticating to single-user servers using API token + +In JupyterHub 0.7, there is no mechanism for token authentication to +single-user servers, and only cookies can be used for authentication. +0.8 supports using JupyterHub API tokens to authenticate to single-user +servers. ## Configure `cull-idle` to run as a Hub-Managed Service