Skip to content

Commit

Permalink
Merge pull request #1646 from GeorgianaElena/fix-auth-docs
Browse files Browse the repository at this point in the history
[Documentation] Replace references to `jupyterhub.auth`  key with new auth config location
  • Loading branch information
yuvipanda committed Mar 22, 2023
2 parents ddba232 + 0ff528b commit 4893dd8
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/source/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ you need to add the following into ``config.yaml``:
config:
BinderSpawner:
auth_enabled: true
# specify the desired authenticator
JupyterHub:
authenticator_class: <desired-authenticator>
# use config of your authenticator here
# use the docs at https://zero-to-jupyterhub.readthedocs.io/en/stable/authentication.html
# to get more info about different config options
Authenticator: {}
<desired-authenticator-class>: {}
services:
binder:
oauth_client_id: service-binderhub
Expand All @@ -37,8 +45,6 @@ you need to add the following into ``config.yaml``:
# to make notebook servers aware of hub
cmd: jupyterhub-singleuser
auth: {}
If the configuration above was entered correctly, once you upgrade your
BinderHub Helm Chart with ``helm upgrade...``, users that arrive at your
BinderHub URL will be directed to a login page. Once they enter their
Expand All @@ -51,8 +57,8 @@ credentials, they'll be taken to the typical BinderHub landing page.
the BinderHub configuration (and the JupyterHub authentication configuration)
look good.
.. note::
For ``jupyterhub.auth`` you should use config of your authenticator.
For more information you can check
For the authentication config in ``jupyterhub.hub.config``,
you should use config of your authenticator. For more information you can check
`the Authentication guide
<https://zero-to-jupyterhub.readthedocs.io/en/stable/authentication.html>`_.

Expand Down

0 comments on commit 4893dd8

Please sign in to comment.