Skip to content

Commit

Permalink
Update get-started.md with SSO auth for SSH keys (#468)
Browse files Browse the repository at this point in the history
We just had a new starter who followed this guidance but couldn't clone any repos.  It turned out his SSH key wasn't authorised for use with the moj-analytical-services org, so I assume this is a new step everyone now needs given the recent changes to sign-on?

This adds the new step to the quickstart to stop anyone else tripping up on this.  Does this work?  I am not an expert in the new auth process!
  • Loading branch information
pjrh-moj authored Nov 21, 2024
1 parent c1680ea commit aaf4931
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions source/documentation/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@ $ cat /home/jovyan/.ssh/id_rsa.pub

You then need to add the SSH key to GitHub; see the [GitHub documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) for instructions.

You also need to authorise your SSH key for use with the MoJ-Analytical-Services organisation before you can use it; see [GitHub: Authorizing an SSH key](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on#authorizing-an-ssh-key) for instructions.

## 6. Set up RStudio

>**Note**: Only follow this step if you want to use the Analytical Platform as an R-based user. RStudio supports Python, but we recommend using JupyterLab for Python instead. If you configured JupyterLab in the previous step, proceed to step 7.
Expand All @@ -157,6 +159,8 @@ To create an SSH key in RStudio:

You then need to add the SSH key to GitHub; see the [GitHub documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) for instructions.

You also need to authorise your SSH key for use with the MoJ-Analytical-Services organisation before you can use it; see [GitHub: Authorizing an SSH key](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on#authorizing-an-ssh-key) for instructions.

Now that you have completed this guide you are ready to begin using the Analytical Platform. See [training](training.md) for a list of different resources to help you begin using the platform.

## 7. Set up Visual Studio Code
Expand Down Expand Up @@ -190,3 +194,5 @@ $ cat ~/.ssh/id_ed25519.pub
8. Copy the SSH key to your clipboard

You then need to add the SSH key to GitHub; see the [GitHub documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) for instructions.

You also need to authorise your SSH key for use with the MoJ-Analytical-Services organisation before you can use it; see [GitHub: Authorizing an SSH key](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on#authorizing-an-ssh-key) for instructions.

0 comments on commit aaf4931

Please sign in to comment.