-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
42 additions
and
43 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| # Environment variables | ||
|
|
||
| [Git Credential Manager][] works out of the box for most users. Configuration options are available to customize or tweak behavior. | ||
| [Git Credential Manager][gcm] works out of the box for most users. Configuration options are available to customize or tweak behavior. | ||
|
|
||
| Git Credential Manager (GCM) can be configured using environment variables. **Environment variables take precedence over [configuration][] options and enterprise system administrator [default values][]**. | ||
| Git Credential Manager (GCM) can be configured using environment variables. **Environment variables take precedence over [configuration][configuration] options and enterprise system administrator [default values][default-values]**. | ||
|
|
||
| For the complete list of environment variables GCM understands, see the list below. | ||
|
|
||
|
|
@@ -156,7 +156,7 @@ export GCM_INTERACTIVE=0 | |
|
|
||
| Defaults to enabled. | ||
|
|
||
| **Also see: [credential.interactive][]** | ||
| **Also see: [credential.interactive][credential-interactive]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -166,7 +166,7 @@ Define the host provider to use when authenticating. | |
|
|
||
| ID|Provider | ||
| -|- | ||
| `auto` _(default)_|_\[automatic\]_ ([learn more][]) | ||
| `auto` _(default)_|_\[automatic\]_ ([learn more][autodetect]) | ||
| `azure-repos`|Azure Repos | ||
| `github`|GitHub | ||
| `gitlab`|GitLab _(supports OAuth in browser, personal access token and Basic Authentication)_ | ||
|
|
@@ -190,15 +190,15 @@ SET GCM_PROVIDER=github | |
| export GCM_PROVIDER=github | ||
| ``` | ||
|
|
||
| **Also see: [credential.provider][]** | ||
| **Also see: [credential.provider][credential-provider]** | ||
|
|
||
| --- | ||
|
|
||
| ### GCM_AUTHORITY _(deprecated)_ | ||
|
|
||
| > This setting is deprecated and should be replaced by `GCM_PROVIDER` with the corresponding provider ID value. | ||
| > | ||
| > See the [migration guide][] for more information. | ||
| > See the [migration guide][migration-guide] for more information. | ||
| Select the host provider to use when authenticating by which authority is supported by the providers. | ||
|
|
||
|
|
@@ -224,7 +224,7 @@ SET GCM_AUTHORITY=github | |
| export GCM_AUTHORITY=github | ||
| ``` | ||
|
|
||
| **Also see: [credential.authority][]** | ||
| **Also see: [credential.authority][credential-authority]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -233,7 +233,7 @@ export GCM_AUTHORITY=github | |
| Permit or disable GCM from presenting GUI prompts. If an equivalent terminal/ | ||
| text-based prompt is available, that will be shown instead. | ||
|
|
||
| To disable all interactivity see [GCM_INTERACTIVE][]. | ||
| To disable all interactivity see [GCM_INTERACTIVE][gcm-interactive]. | ||
|
|
||
| #### Example | ||
|
|
||
|
|
@@ -251,7 +251,7 @@ export GCM_GUI_PROMPT=0 | |
|
|
||
| Defaults to enabled. | ||
|
|
||
| **Also see: [credential.guiPrompt][]** | ||
| **Also see: [credential.guiPrompt][credential-guiprompt]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -260,7 +260,7 @@ Defaults to enabled. | |
| Set the maximum length of time, in milliseconds, that GCM should wait for a | ||
| network response during host provider auto-detection probing. | ||
|
|
||
| See [autodetection][] for more information. | ||
| See [autodetection][autodetect] for more information. | ||
|
|
||
| **Note:** Use a negative or zero value to disable probing altogether. | ||
|
|
||
|
|
@@ -280,7 +280,7 @@ SET GCM_AUTODETECT_TIMEOUT=-1 | |
| export GCM_AUTODETECT_TIMEOUT=-1 | ||
| ``` | ||
|
|
||
| **Also see: [credential.autoDetectTimeout][]** | ||
| **Also see: [credential.autoDetectTimeout][credential-autodetecttimeout]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -311,15 +311,15 @@ SET GCM_ALLOW_WINDOWSAUTH=0 | |
| export GCM_ALLOW_WINDOWSAUTH=0 | ||
| ``` | ||
|
|
||
| **Also see: [credential.allowWindowsAuth][]** | ||
| **Also see: [credential.allowWindowsAuth][credential-allowwindowsauth]** | ||
|
|
||
| --- | ||
|
|
||
| ### GCM_HTTP_PROXY _(deprecated)_ | ||
|
|
||
| > This setting is deprecated and should be replaced by the [standard `http.proxy` Git configuration option][]. | ||
| > This setting is deprecated and should be replaced by the [standard `http.proxy` Git configuration option][git-httpproxy]. | ||
| > | ||
| > See the [HTTP proxy configuration][] for more information. | ||
| > See the [HTTP proxy configuration][network-http-proxy] for more information. | ||
| Configure GCM to use the a proxy for network operations. | ||
|
|
||
|
|
@@ -337,7 +337,7 @@ SET GCM_HTTP_PROXY=http://john.doe:[email protected] | |
| export GCM_HTTP_PROXY=http://john.doe:[email protected] | ||
| ``` | ||
|
|
||
| **Also see: [credential.httpProxy][]** | ||
| **Also see: [credential.httpProxy][credential-httpproxy]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -368,7 +368,7 @@ SET GCM_BITBUCKET_AUTHMODES="oauth,basic" | |
| export GCM_BITBUCKET_AUTHMODES="oauth,basic" | ||
| ``` | ||
|
|
||
| **Also see: [credential.bitbucketAuthModes][]** | ||
| **Also see: [credential.bitbucketAuthModes][credential-bitbucketauthmodes]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -401,7 +401,7 @@ export GCM_BITBUCKET_ALWAYS_REFRESH_CREDENTIALS=1 | |
|
|
||
| Defaults to false/disabled. | ||
|
|
||
| **Also see: [credential.bitbucketAlwaysRefreshCredentials][]** | ||
| **Also see: [credential.bitbucketAlwaysRefreshCredentials][credential-bitbucketalwaysrefreshcredentials]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -433,7 +433,7 @@ SET GCM_GITHUB_AUTHMODES="oauth,basic" | |
| export GCM_GITHUB_AUTHMODES="oauth,basic" | ||
| ``` | ||
|
|
||
| **Also see: [credential.gitHubAuthModes][github-auth-modes]** | ||
| **Also see: [credential.gitHubAuthModes][credential-githubauthmodes]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -463,7 +463,7 @@ SET GCM_GITLAB_AUTHMODES="browser" | |
| export GCM_GITLAB_AUTHMODES="browser" | ||
| ``` | ||
|
|
||
| **Also see: [credential.gitLabAuthModes][gitlab-auth-modes]** | ||
| **Also see: [credential.gitLabAuthModes][credential-gitlabauthmodes]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -521,7 +521,7 @@ SET GCM_CREDENTIAL_STORE="gpg" | |
| export GCM_CREDENTIAL_STORE="gpg" | ||
| ``` | ||
|
|
||
| **Also see: [credential.credentialStore][credential-credential-store]** | ||
| **Also see: [credential.credentialStore][credential-credentialstore]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -548,7 +548,7 @@ SET GCM_CREDENTIAL_CACHE_OPTIONS="--timeout 300" | |
| export GCM_CREDENTIAL_CACHE_OPTIONS="--timeout 300" | ||
| ``` | ||
|
|
||
| **Also see: [credential.cacheOptions][credential-cache-options]** | ||
| **Also see: [credential.cacheOptions][credential-cacheoptions]** | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -576,7 +576,7 @@ export GCM_PLAINTEXT_STORE_PATH=/mnt/external-drive/credentials | |
|
|
||
| ### GCM_DPAPI_STORE_PATH | ||
|
|
||
| Specify a custom directory to store DPAPI protected credential files in when [`GCM_CREDENTIAL_STORE`](#GCM_CREDENTIAL_STORE) is set to `dpapi`. | ||
| Specify a custom directory to store DPAPI protected credential files in when [`GCM_CREDENTIAL_STORE`][gcm-credential-store] is set to `dpapi`. | ||
|
|
||
| Defaults to the value `%USERPROFILE%\.gcm\dpapi_store`. | ||
|
|
||
|
|
@@ -696,43 +696,42 @@ export GCM_AZREPOS_CREDENTIALTYPE="oauth" | |
|
|
||
| **Also see: [credential.azreposCredentialType][credential-azrepos-credential-type]** | ||
|
|
||
| [autodetection]: autodetect.md | ||
| [autodetect]: autodetect.md | ||
| [azure-access-tokens]: azrepos-users-and-tokens.md | ||
| [configuration]: configuration.md | ||
| [credential.allowWindowsAuth]: environment.md#credentialallowWindowsAuth | ||
| [credential.authority]: configuration.md#credentialauthority-deprecated | ||
| [credential.autoDetectTimeout]: configuration.md#credentialautodetecttimeout | ||
| [credential-allowwindowsauth]: environment.md#credentialallowWindowsAuth | ||
| [credential-authority]: configuration.md#credentialauthority-deprecated | ||
| [credential-autodetecttimeout]: configuration.md#credentialautodetecttimeout | ||
| [credential-azrepos-credential-type]: configuration.md#azreposcredentialtype | ||
| [credential.bitbucketAlwaysRefreshCredentials]: configuration.md#bitbucketAlwaysRefreshCredentials | ||
| [credential.bitbucketAuthModes]: configuration.md#credentialbitbucketAuthModes | ||
| [credential-cache-options]: configuration.md#credentialcacheoptions | ||
| [credential-credential-store]: configuration.md#credentialcredentialstore | ||
| [credential-bitbucketalwaysrefreshcredentials]: configuration.md#bitbucketAlwaysRefreshCredentials | ||
| [credential-bitbucketauthmodes]: configuration.md#credentialbitbucketAuthModes | ||
| [credential-cacheoptions]: configuration.md#credentialcacheoptions | ||
| [credential-credentialstore]: configuration.md#credentialcredentialstore | ||
| [credential-dpapi-store-path]: configuration.md#credentialdpapistorepath | ||
| [credential.guiPrompt]: configuration.md#credentialguiprompt | ||
| [credential.httpProxy]: configuration.md#credentialhttpProxy-deprecated | ||
| [credential.interactive]: configuration.md#credentialinteractive | ||
| [credential-githubauthmodes]: configuration.md#credentialgitHubAuthModes | ||
| [credential-gitlabauthmodes]: configuration.md#credentialgitLabAuthModes | ||
| [credential-guiprompt]: configuration.md#credentialguiprompt | ||
| [credential-httpproxy]: configuration.md#credentialhttpProxy-deprecated | ||
| [credential-interactive]: configuration.md#credentialinteractive | ||
| [credential-namespace]: configuration.md#credentialnamespace | ||
| [credential-msauth-flow]: configuration.md#credentialmsauthflow | ||
| [credential-msauth-usebroker]: configuration.md#credentialmsauthusebroker-experimental | ||
| [credential-plain-text-store]: configuration.md#credentialplaintextstorepath | ||
| [credential.provider]: configuration.md#credentialprovider | ||
| [credential-provider]: configuration.md#credentialprovider | ||
| [credential-stores]: credstores.md | ||
| [default values]: enterprise-config.md | ||
| [default-values]: enterprise-config.md | ||
| [freedesktop-ss]: https://specifications.freedesktop.org/secret-service/ | ||
| [GCM_INTERACTIVE]: #gcm_interactive | ||
| [gcm]: usage.md | ||
| [gcm-interactive]: #gcm_interactive | ||
| [gcm-credential-store]: #GCM_CREDENTIAL_STORE | ||
| [gcm-dpapi-store-path]: #gcm_dpapi_store_path | ||
| [gcm-plaintext-store-path]: #gcm_plaintext_store_path | ||
| [gcm-msauth-usebroker]: #gcm_msauth_usebroker-experimental | ||
| [git-cache-options]: https://git-scm.com/docs/git-credential-cache#_options | ||
| [Git Credential Manager]: usage.md | ||
| [git-credential-cache]: https://git-scm.com/docs/git-credential-cache | ||
| [github-auth-modes]: configuration.md#credentialgitHubAuthModes | ||
| [gitlab-auth-modes]: configuration.md#credentialgitLabAuthModes | ||
| [HTTP proxy configuration]: netconfig.md#http-proxy | ||
| [learn more]: autodetect.md | ||
| [git-httpproxy]: https://git-scm.com/docs/git-config#Documentation/git-config.txt-httpproxy | ||
| [network-http-proxy]: netconfig.md#http-proxy | ||
| [libsecret]: https://wiki.gnome.org/Projects/Libsecret | ||
| [migration guide]: migration.md#gcm_authority | ||
| [migration-guide]: migration.md#gcm_authority | ||
| [passwordstore]: https://www.passwordstore.org/ | ||
| [standard `http.proxy` Git configuration option]: https://git-scm.com/docs/git-config#Documentation/git-config.txt-httpproxy | ||
| [windows-broker]: windows-broker.md | ||