chore: explain GIT_ASKPASS behavior in docs #12784
Merged
Conversation
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
- VSCode configuration requirements
matifali
approved these changes
Mar 27, 2024
kylecarbs
requested changes
Mar 27, 2024
docs/admin/external-auth.md
Outdated
| @@ -212,8 +212,32 @@ you can require users authenticate via git prior to creating a workspace: | |||
|
|
|||
|  | |||
|
|
|||
| The following example will require users authenticate via GitHub and auto-clone | |||
| a repo into the `~/coder` directory. | |||
| ### `GIT_ASKPASS` will auto-refresh tokens | |||
There was a problem hiding this comment.
I think users will be unfamiliar with what GIT_ASKPASS is.
We should approach this from a git perspective... as the tool most users are familiar with, and explain that we use GIT_ASKPASS is a variable Git hooks into for authentication.
It's worth mentioning that coder external-auth token <id> will output the same token as the Git hook will.
command only works if inside
kylecarbs
approved these changes
Mar 27, 2024
| Note: Some IDE's override the `GIT_ASKPASS` environment variable and need to be | ||
| configured. | ||
|
|
||
| **VSCode** |
There was a problem hiding this comment.
We should note that this is automatically done for you. No manual user configuration is actually needed.
There was a problem hiding this comment.
It is not automatically done though. The user must manually turn off the VSCode overrides.
Does our extension do this for you?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #12291