JupyterHubGitHubSignUp: Difference between revisions

From CSDMS
(Initialize page)
 
(First draft of instructions, with pictures)
Line 1: Line 1:
{{PageTitle|GitHub Authentication for the CSDMS JupyterHub}}
{{PageTitle|GitHub Authentication for the CSDMS JupyterHub}}


Although the CSDMS JupyterHub is publicly available, it's password-protected.
Logins to the ''jupyter'' instance of the CSDMS JupyterHub are controlled through GitHub.
It takes a little extra work to set this up, but afterward you won't have to remember a username and a password to login.
 
To obtain a login, follow these steps.
To obtain a login, follow these steps.


# If you're not already a CSDMS member, [[Join_CSDMS|sign up]]
# You must be a CSDMS member to use this Hub. [[Join_CSDMS| Join CSDMS]] if you're interested in using community software to model earth surface processes.
# [https://csdms.rc.colorado.edu/hub/signup Create a login on the JupyterHub], providing a username and password (they can be whatever you like); this is separate from your CSDMS membership
# If you don't already have a [https://github.com/ GitHub] account, please [https://github.com/signup sign up] for one.
# [https://github.com/csdms/help-desk/issues/new?assignees=mdpiper&labels=jupyterhub&template=new-csdms-jupyterhub-account.md&title=CSDMS+JupyterHub+account Request authorization] for your new JupyterHub account through the CSDMS Help Desk--if you don't already have a GitHub account, you'll be asked to make one
# [https://github.com/csdms/help-desk/issues/new?assignees=mdpiper&labels=jupyterhub&template=new-csdms-jupyterhub-account.md&title=CSDMS+JupyterHub+account Request authorization] for your JupyterHub account through the CSDMS Help Desk. You should typically hear back in less than a day.
# Once you're approved, [https://csdms.rc.colorado.edu/hub/login sign in] to the Hub!
# Once you're approved, [https://csdms.rc.colorado.edu/hub/login sign in] to the Hub.
 
== The first-time login process ==
 
The first time you login, you'll be asked to authenticate through GitHub.
This can seem a little scary, so here are some screenshots of the process.
 
First, the login screen for https://jupyter.openearthscape.org.
Click the "Sign in with GitHub" button.
 
Next, you'll be asked to provide your GitHub login credentials.
If you've turned on two-factor authentication in GitHub, you'll also be asked to provide a code.
 
Finally, GitHub will ask you if it's OK to use your credentials to login to the OpenEarthscape JupyterHub.
 
These steps only need to be performed once.
Afterward, GitHub will automatically log you in to the JupyterHub.
 
<gallery>
File:hub-login-screen.png|The OpenEarthscape JupyterHub login screen
File:provide-github-credentials.png|Provide GitHub login credentials to continue
File:allow-use-of-credentials.png|Allow the OpenEarthscape JupyterHub to use your GitHub credentials for login
</gallery>

Revision as of 17:55, 25 February 2022

GitHub Authentication for the CSDMS JupyterHub

Logins to the jupyter instance of the CSDMS JupyterHub are controlled through GitHub. It takes a little extra work to set this up, but afterward you won't have to remember a username and a password to login.

To obtain a login, follow these steps.

  1. You must be a CSDMS member to use this Hub. Join CSDMS if you're interested in using community software to model earth surface processes.
  2. If you don't already have a GitHub account, please sign up for one.
  3. Request authorization for your JupyterHub account through the CSDMS Help Desk. You should typically hear back in less than a day.
  4. Once you're approved, sign in to the Hub.

The first-time login process

The first time you login, you'll be asked to authenticate through GitHub. This can seem a little scary, so here are some screenshots of the process.

First, the login screen for https://jupyter.openearthscape.org. Click the "Sign in with GitHub" button.

Next, you'll be asked to provide your GitHub login credentials. If you've turned on two-factor authentication in GitHub, you'll also be asked to provide a code.

Finally, GitHub will ask you if it's OK to use your credentials to login to the OpenEarthscape JupyterHub.

These steps only need to be performed once. Afterward, GitHub will automatically log you in to the JupyterHub.