- Notifications
You must be signed in to change notification settings - Fork1k
docs: document GIT_ASKPASS for OAuth connections#17457
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
19 changes: 16 additions & 3 deletionsdocs/admin/external-auth.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -80,11 +80,24 @@ If no tokens are available, it defaults to SSH authentication. | ||
### OAuth (external auth) | ||
For Git providers configured with [external authentication](#configuration), Coder can use OAuth tokens for Git operations over HTTPS. | ||
When using SSH URLs (like `git@github.com:organization/repo.git`), Coder uses SSH keys as described in the [SSH Authentication](#ssh-authentication) section instead. | ||
For Git operations over HTTPS, Coder automatically uses the appropriate external auth provider | ||
token based on the repository URL. | ||
This works through Git's `GIT_ASKPASS` mechanism, which Coder configures in each workspace. | ||
To use OAuth tokens for Git authentication over HTTPS: | ||
1. Complete the OAuth authentication flow (**Login with GitHub**, **Login with GitLab**). | ||
1. Use HTTPS URLs when interacting with repositories (`https://github.com/organization/repo.git`). | ||
1. Coder automatically handles authentication. You can perform your Git operations as you normally would. | ||
Behind the scenes, Coder: | ||
- Stores your OAuth token securely in its database | ||
EdwardAngert marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
- Sets up `GIT_ASKPASS` at `/tmp/coder.<random-string>/coder` in your workspaces | ||
- Retrieves and injects the appropriate token when Git operations require authentication | ||
To manually access these tokens within a workspace: | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.