Skip to content

Commit

Permalink
Update docs to match latest script updates
Browse files Browse the repository at this point in the history
  • Loading branch information
GeorgianaElena committed Mar 22, 2023
1 parent ea33040 commit 3cf3057
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/hub-deployment-guide/configure-auth/cilogon.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ The steps to enable the JupyterHub CILogonOAuthenticator for a hub are similar w
This can be achieved by using the `deployer cilogon-client-create` command.

- The command needs to be passed the cluster and hub name for which a client id and secret will be generated, but also the hub type, and the authorization callback URL.
- The authorization callback URL is the homepage url appended with `/hub/oauth_callback`. For example, `https://staging.2i2c.cloud/hub/oauth_callback`.
- The hub domain, as specified in `cluster.yaml` (ex: staging.2i2c.cloud).
- Example script invocation that creates a CILogon OAuth client for the 2i2c dask-staging hub:
```bash
deployer cilogon-client-create create 2i2c dask-staging daskhub https://dask-staging.2i2c.cloud/hub/oauth_callback
deployer cilogon-client-create create 2i2c dask-staging daskhub dask-staging.2i2c.cloud
```
- If successful, the script will have created a secret values file under `config/clusters/<cluster_name>/enc-<hub_name>.secret.values.yaml`. This file
holds the encrypted OAuth client id and secret that have been created for this hub.
Expand Down
2 changes: 1 addition & 1 deletion docs/hub-deployment-guide/configure-auth/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Switching authentication providers (e.g. from GitHub to Google) for a pre-existi
```{toctree}
:maxdepth: 2
:caption: Authentication Providers
auth0
github-orgs
cilogon
auth0
```

0 comments on commit 3cf3057

Please sign in to comment.