1
1
# Environment variables
2
2
3
- [ Git Credential Manager] [ ] works out of the box for most users. Configuration options are available to customize or tweak behavior.
3
+ [ Git Credential Manager] [ gcm ] works out of the box for most users. Configuration options are available to customize or tweak behavior.
4
4
5
- Git Credential Manager (GCM) can be configured using environment variables. ** Environment variables take precedence over [ configuration] [ ] options and enterprise system administrator [ default values] [ ] ** .
5
+ 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 ] ** .
6
6
7
7
For the complete list of environment variables GCM understands, see the list below.
8
8
@@ -156,7 +156,7 @@ export GCM_INTERACTIVE=0
156
156
157
157
Defaults to enabled.
158
158
159
- ** Also see: [ credential.interactive] [ ] **
159
+ ** Also see: [ credential.interactive] [ credential-interactive ] **
160
160
161
161
---
162
162
@@ -166,7 +166,7 @@ Define the host provider to use when authenticating.
166
166
167
167
ID|Provider
168
168
-|-
169
- ` auto ` _ (default)_ |_ \[ automatic\] _ ([ learn more] [ ] )
169
+ ` auto ` _ (default)_ |_ \[ automatic\] _ ([ learn more] [ autodetect ] )
170
170
` azure-repos ` |Azure Repos
171
171
` github ` |GitHub
172
172
` gitlab ` |GitLab _ (supports OAuth in browser, personal access token and Basic Authentication)_
@@ -190,15 +190,15 @@ SET GCM_PROVIDER=github
190
190
export GCM_PROVIDER=github
191
191
```
192
192
193
- ** Also see: [ credential.provider] [ ] **
193
+ ** Also see: [ credential.provider] [ credential-provider ] **
194
194
195
195
---
196
196
197
197
### GCM_AUTHORITY _ (deprecated)_
198
198
199
199
> This setting is deprecated and should be replaced by ` GCM_PROVIDER ` with the corresponding provider ID value.
200
200
>
201
- > See the [ migration guide] [ ] for more information.
201
+ > See the [ migration guide] [ migration-guide ] for more information.
202
202
203
203
Select the host provider to use when authenticating by which authority is supported by the providers.
204
204
@@ -224,7 +224,7 @@ SET GCM_AUTHORITY=github
224
224
export GCM_AUTHORITY=github
225
225
```
226
226
227
- ** Also see: [ credential.authority] [ ] **
227
+ ** Also see: [ credential.authority] [ credential-authority ] **
228
228
229
229
---
230
230
@@ -233,7 +233,7 @@ export GCM_AUTHORITY=github
233
233
Permit or disable GCM from presenting GUI prompts. If an equivalent terminal/
234
234
text-based prompt is available, that will be shown instead.
235
235
236
- To disable all interactivity see [ GCM_INTERACTIVE] [ ] .
236
+ To disable all interactivity see [ GCM_INTERACTIVE] [ gcm-interactive ] .
237
237
238
238
#### Example
239
239
@@ -251,7 +251,7 @@ export GCM_GUI_PROMPT=0
251
251
252
252
Defaults to enabled.
253
253
254
- ** Also see: [ credential.guiPrompt] [ ] **
254
+ ** Also see: [ credential.guiPrompt] [ credential-guiprompt ] **
255
255
256
256
---
257
257
@@ -260,7 +260,7 @@ Defaults to enabled.
260
260
Set the maximum length of time, in milliseconds, that GCM should wait for a
261
261
network response during host provider auto-detection probing.
262
262
263
- See [ autodetection] [ ] for more information.
263
+ See [ autodetection] [ autodetect ] for more information.
264
264
265
265
** Note:** Use a negative or zero value to disable probing altogether.
266
266
@@ -280,7 +280,7 @@ SET GCM_AUTODETECT_TIMEOUT=-1
280
280
export GCM_AUTODETECT_TIMEOUT=-1
281
281
```
282
282
283
- ** Also see: [ credential.autoDetectTimeout] [ ] **
283
+ ** Also see: [ credential.autoDetectTimeout] [ credential-autodetecttimeout ] **
284
284
285
285
---
286
286
@@ -311,15 +311,15 @@ SET GCM_ALLOW_WINDOWSAUTH=0
311
311
export GCM_ALLOW_WINDOWSAUTH=0
312
312
```
313
313
314
- ** Also see: [ credential.allowWindowsAuth] [ ] **
314
+ ** Also see: [ credential.allowWindowsAuth] [ credential-allowwindowsauth ] **
315
315
316
316
---
317
317
318
318
### GCM_HTTP_PROXY _ (deprecated)_
319
319
320
- > This setting is deprecated and should be replaced by the [ standard ` http.proxy ` Git configuration option] [ ] .
320
+ > This setting is deprecated and should be replaced by the [ standard ` http.proxy ` Git configuration option] [ git-httpproxy ] .
321
321
>
322
- > See the [ HTTP proxy configuration] [ ] for more information.
322
+ > See the [ HTTP proxy configuration] [ network-http-proxy ] for more information.
323
323
324
324
Configure GCM to use the a proxy for network operations.
325
325
337
337
export GCM_HTTP_PROXY=http://john.doe:
[email protected]
338
338
```
339
339
340
- ** Also see: [ credential.httpProxy] [ ] **
340
+ ** Also see: [ credential.httpProxy] [ credential-httpproxy ] **
341
341
342
342
---
343
343
@@ -368,7 +368,7 @@ SET GCM_BITBUCKET_AUTHMODES="oauth,basic"
368
368
export GCM_BITBUCKET_AUTHMODES=" oauth,basic"
369
369
```
370
370
371
- ** Also see: [ credential.bitbucketAuthModes] [ ] **
371
+ ** Also see: [ credential.bitbucketAuthModes] [ credential-bitbucketauthmodes ] **
372
372
373
373
---
374
374
@@ -401,7 +401,7 @@ export GCM_BITBUCKET_ALWAYS_REFRESH_CREDENTIALS=1
401
401
402
402
Defaults to false/disabled.
403
403
404
- ** Also see: [ credential.bitbucketAlwaysRefreshCredentials] [ ] **
404
+ ** Also see: [ credential.bitbucketAlwaysRefreshCredentials] [ credential-bitbucketalwaysrefreshcredentials ] **
405
405
406
406
---
407
407
@@ -433,7 +433,7 @@ SET GCM_GITHUB_AUTHMODES="oauth,basic"
433
433
export GCM_GITHUB_AUTHMODES=" oauth,basic"
434
434
```
435
435
436
- ** Also see: [ credential.gitHubAuthModes] [ github-auth-modes ] **
436
+ ** Also see: [ credential.gitHubAuthModes] [ credential-githubauthmodes ] **
437
437
438
438
---
439
439
@@ -463,7 +463,7 @@ SET GCM_GITLAB_AUTHMODES="browser"
463
463
export GCM_GITLAB_AUTHMODES=" browser"
464
464
```
465
465
466
- ** Also see: [ credential.gitLabAuthModes] [ gitlab-auth-modes ] **
466
+ ** Also see: [ credential.gitLabAuthModes] [ credential-gitlabauthmodes ] **
467
467
468
468
---
469
469
@@ -521,7 +521,7 @@ SET GCM_CREDENTIAL_STORE="gpg"
521
521
export GCM_CREDENTIAL_STORE=" gpg"
522
522
```
523
523
524
- ** Also see: [ credential.credentialStore] [ credential-credential-store ] **
524
+ ** Also see: [ credential.credentialStore] [ credential-credentialstore ] **
525
525
526
526
---
527
527
@@ -548,7 +548,7 @@ SET GCM_CREDENTIAL_CACHE_OPTIONS="--timeout 300"
548
548
export GCM_CREDENTIAL_CACHE_OPTIONS=" --timeout 300"
549
549
```
550
550
551
- ** Also see: [ credential.cacheOptions] [ credential-cache-options ] **
551
+ ** Also see: [ credential.cacheOptions] [ credential-cacheoptions ] **
552
552
553
553
---
554
554
@@ -576,7 +576,7 @@ export GCM_PLAINTEXT_STORE_PATH=/mnt/external-drive/credentials
576
576
577
577
### GCM_DPAPI_STORE_PATH
578
578
579
- Specify a custom directory to store DPAPI protected credential files in when [ ` GCM_CREDENTIAL_STORE ` ] ( #GCM_CREDENTIAL_STORE ) is set to ` dpapi ` .
579
+ Specify a custom directory to store DPAPI protected credential files in when [ ` GCM_CREDENTIAL_STORE ` ] [ gcm-credential-store ] is set to ` dpapi ` .
580
580
581
581
Defaults to the value ` %USERPROFILE%\.gcm\dpapi_store ` .
582
582
@@ -696,43 +696,42 @@ export GCM_AZREPOS_CREDENTIALTYPE="oauth"
696
696
697
697
** Also see: [ credential.azreposCredentialType] [ credential-azrepos-credential-type ] **
698
698
699
- [ autodetection ] : autodetect.md
699
+ [ autodetect ] : autodetect.md
700
700
[ azure-access-tokens ] : azrepos-users-and-tokens.md
701
701
[ configuration ] : configuration.md
702
- [ credential.allowWindowsAuth ] : environment.md#credentialallowWindowsAuth
703
- [ credential. authority ] : configuration.md#credentialauthority-deprecated
704
- [ credential.autoDetectTimeout ] : configuration.md#credentialautodetecttimeout
702
+ [ credential-allowwindowsauth ] : environment.md#credentialallowWindowsAuth
703
+ [ credential- authority ] : configuration.md#credentialauthority-deprecated
704
+ [ credential-autodetecttimeout ] : configuration.md#credentialautodetecttimeout
705
705
[ credential-azrepos-credential-type ] : configuration.md#azreposcredentialtype
706
- [ credential.bitbucketAlwaysRefreshCredentials ] : configuration.md#bitbucketAlwaysRefreshCredentials
707
- [ credential.bitbucketAuthModes ] : configuration.md#credentialbitbucketAuthModes
708
- [ credential-cache-options ] : configuration.md#credentialcacheoptions
709
- [ credential-credential-store ] : configuration.md#credentialcredentialstore
706
+ [ credential-bitbucketalwaysrefreshcredentials ] : configuration.md#bitbucketAlwaysRefreshCredentials
707
+ [ credential-bitbucketauthmodes ] : configuration.md#credentialbitbucketAuthModes
708
+ [ credential-cacheoptions ] : configuration.md#credentialcacheoptions
709
+ [ credential-credentialstore ] : configuration.md#credentialcredentialstore
710
710
[ credential-dpapi-store-path ] : configuration.md#credentialdpapistorepath
711
- [ credential.guiPrompt ] : configuration.md#credentialguiprompt
712
- [ credential.httpProxy ] : configuration.md#credentialhttpProxy-deprecated
713
- [ credential.interactive ] : configuration.md#credentialinteractive
711
+ [ credential-githubauthmodes ] : configuration.md#credentialgitHubAuthModes
712
+ [ credential-gitlabauthmodes ] : configuration.md#credentialgitLabAuthModes
713
+ [ credential-guiprompt ] : configuration.md#credentialguiprompt
714
+ [ credential-httpproxy ] : configuration.md#credentialhttpProxy-deprecated
715
+ [ credential-interactive ] : configuration.md#credentialinteractive
714
716
[ credential-namespace ] : configuration.md#credentialnamespace
715
717
[ credential-msauth-flow ] : configuration.md#credentialmsauthflow
716
718
[ credential-msauth-usebroker ] : configuration.md#credentialmsauthusebroker-experimental
717
719
[ credential-plain-text-store ] : configuration.md#credentialplaintextstorepath
718
- [ credential. provider ] : configuration.md#credentialprovider
720
+ [ credential- provider ] : configuration.md#credentialprovider
719
721
[ credential-stores ] : credstores.md
720
- [ default values ] : enterprise-config.md
722
+ [ default- values ] : enterprise-config.md
721
723
[ freedesktop-ss ] : https://specifications.freedesktop.org/secret-service/
722
- [ GCM_INTERACTIVE ] : #gcm_interactive
724
+ [ gcm ] : usage.md
725
+ [ gcm-interactive ] : #gcm_interactive
723
726
[ gcm-credential-store ] : #GCM_CREDENTIAL_STORE
724
727
[ gcm-dpapi-store-path ] : #gcm_dpapi_store_path
725
728
[ gcm-plaintext-store-path ] : #gcm_plaintext_store_path
726
729
[ gcm-msauth-usebroker ] : #gcm_msauth_usebroker-experimental
727
730
[ git-cache-options ] : https://git-scm.com/docs/git-credential-cache#_options
728
- [ Git Credential Manager ] : usage.md
729
731
[ git-credential-cache ] : https://git-scm.com/docs/git-credential-cache
730
- [ github-auth-modes ] : configuration.md#credentialgitHubAuthModes
731
- [ gitlab-auth-modes ] : configuration.md#credentialgitLabAuthModes
732
- [ HTTP proxy configuration ] : netconfig.md#http-proxy
733
- [ learn more ] : autodetect.md
732
+ [ git-httpproxy ] : https://git-scm.com/docs/git-config#Documentation/git-config.txt-httpproxy
733
+ [ network-http-proxy ] : netconfig.md#http-proxy
734
734
[ libsecret ] : https://wiki.gnome.org/Projects/Libsecret
735
- [ migration guide ] : migration.md#gcm_authority
735
+ [ migration- guide ] : migration.md#gcm_authority
736
736
[ passwordstore ] : https://www.passwordstore.org/
737
- [ standard `http.proxy` Git configuration option ] : https://git-scm.com/docs/git-config#Documentation/git-config.txt-httpproxy
738
737
[ windows-broker ] : windows-broker.md
0 commit comments