Skip to content

Commit a8073c3

Browse files
Further clarify missing readme instructions (#89)
1 parent 928479e commit a8073c3

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@ export PATH=$HOME/.foreman/bin:$PATH
4646
```
4747

4848
### Authentication
49-
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.
49+
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:
50+
51+
1. Make sure to configure the token to have access to the `repo` scope
52+
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.
5053

5154
Use `foreman github-auth` to pass an authentication token to Foreman, or open `~/.foreman/auth.toml` and follow the contained instructions.
5255

0 commit comments

Comments
 (0)