Skip to content

Commit

Permalink
add troubleshooting instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hickford committed Oct 16, 2024
1 parent bcad799 commit 62d8703
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ OAuth has multiple advantages over personal access tokens or SSH:
| Host | Preconfigured | OAuth | OAuth device flow |
|---------------------|---------------|-------------------|-------------------|
| github.com ||||
| GitHub Enterprise Server | 🗙 |||
| gitlab.com ||||
| gitlab.example.com | 🗙 |||
| gitea.example.com ||| 🗙 |
Expand Down Expand Up @@ -186,6 +187,14 @@ Would you like to see universal GitLab support? Vote for [GitLab issue #374172](

The maintainer personally uses GCM on Windows and git-credential-oauth on Linux.

## Troubleshooting

1. List Git credential helpers `git config --get-all credential.helper`. At least one storage helper should preceed `oauth`.
2. Check Git version `git --version` is at least 2.45. Older Git versions have [limited support for storing OAuth refresh tokens](https://github.com/hickford/git-credential-oauth/issues/20).
3. Check git-credential-oauth version is [recent](https://github.com/hickford/git-credential-oauth/releases/).
4. Check Git remote URL `git remote -v` does not contain a username.
5. Test git-credential-oauth in verbose mode for *your specific host* `printf host=example.com\nprotocol=https\n | git-credential-oauth -verbose get`. Set any config keys suggested.

## Development

Install locally with `go install .`.
Expand Down

0 comments on commit 62d8703

Please sign in to comment.