From d4224554e5331d4e1c0b74b2fcfa9a8d44005198 Mon Sep 17 00:00:00 2001 From: Paul Doyle <37384169+ZoteTheMighty@users.noreply.github.com> Date: Fri, 19 Jan 2024 15:26:02 -0800 Subject: [PATCH] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b4cb64..a6a32e6 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,10 @@ export PATH=$HOME/.foreman/bin:$PATH ``` ### Authentication -To install tools from a private GitHub repository, Foreman supports authenticating with a [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). When creating the token in GitHub, make sure to grant access to the `repo` scope. +To install tools from a private GitHub repository, Foreman supports authenticating with a [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). When creating the token in GitHub: + +1. Make sure to configure the token to have access to the `repo` scope +2. Once created, you may need to click the `Configure SSO` button next to the token to auhtorize it for SSO usage. Whether or not you need to do this will depend on the GitHub org that you need to access. Use `foreman github-auth` to pass an authentication token to Foreman, or open `~/.foreman/auth.toml` and follow the contained instructions.