Skip to content

Commit f5ea6fc

Browse files
wolf99wolf99
committed
Switch to reference style links
1 parent 6975eea commit f5ea6fc

File tree

1 file changed

+80
-39
lines changed

1 file changed

+80
-39
lines changed

‎docs/environment.md‎

Lines changed: 80 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Environment variables
22

3-
[Git Credential Manager](usage.md) works out of the box for most users. Configuration options are available to customize or tweak behavior.
3+
[Git Credential Manager][] works out of the box for most users. Configuration options are available to customize or tweak behavior.
44

5-
Git Credential Manager (GCM) can be configured using environment variables. **Environment variables take precedence over [configuration](configuration.md) options and enterprise system administrator [default values](enterprise-config.md)**.
5+
Git Credential Manager (GCM) can be configured using environment variables. **Environment variables take precedence over [configuration][] options and enterprise system administrator [default values][]**.
66

77
For the complete list of environment variables GCM understands, see the list below.
88

@@ -156,7 +156,7 @@ export GCM_INTERACTIVE=0
156156

157157
Defaults to enabled.
158158

159-
**Also see: [credential.interactive](configuration.md#credentialinteractive)**
159+
**Also see: [credential.interactive][]**
160160

161161
---
162162

@@ -166,7 +166,7 @@ Define the host provider to use when authenticating.
166166

167167
ID|Provider
168168
-|-
169-
`auto` _(default)_|_\[automatic\]_ ([learn more](autodetect.md))
169+
`auto` _(default)_|_\[automatic\]_ ([learn more][])
170170
`azure-repos`|Azure Repos
171171
`github`|GitHub
172172
`gitlab`|GitLab _(supports OAuth in browser, personal access token and Basic Authentication)_
@@ -190,15 +190,15 @@ SET GCM_PROVIDER=github
190190
export GCM_PROVIDER=github
191191
```
192192

193-
**Also see: [credential.provider](configuration.md#credentialprovider)**
193+
**Also see: [credential.provider][]**
194194

195195
---
196196

197197
### GCM_AUTHORITY _(deprecated)_
198198

199199
> This setting is deprecated and should be replaced by `GCM_PROVIDER` with the corresponding provider ID value.
200200
>
201-
> Click [here](https://aka.ms/gcm/authority) for more information.
201+
> See the [migration guide][] for more information.
202202
203203
Select the host provider to use when authenticating by which authority is supported by the providers.
204204

@@ -224,7 +224,7 @@ SET GCM_AUTHORITY=github
224224
export GCM_AUTHORITY=github
225225
```
226226

227-
**Also see: [credential.authority](configuration.md#credentialauthority-deprecated)**
227+
**Also see: [credential.authority][]**
228228

229229
---
230230

@@ -233,7 +233,7 @@ export GCM_AUTHORITY=github
233233
Permit or disable GCM from presenting GUI prompts. If an equivalent terminal/
234234
text-based prompt is available, that will be shown instead.
235235

236-
To disable all interactivity see [GCM_INTERACTIVE](#gcm_interactive).
236+
To disable all interactivity see [GCM_INTERACTIVE][].
237237

238238
#### Example
239239

@@ -251,7 +251,7 @@ export GCM_GUI_PROMPT=0
251251

252252
Defaults to enabled.
253253

254-
**Also see: [credential.guiPrompt](configuration.md#credentialguiprompt)**
254+
**Also see: [credential.guiPrompt][]**
255255

256256
---
257257

@@ -260,7 +260,7 @@ Defaults to enabled.
260260
Set the maximum length of time, in milliseconds, that GCM should wait for a
261261
network response during host provider auto-detection probing.
262262

263-
See [here](autodetect.md) for more information.
263+
See [autodetection][] for more information.
264264

265265
**Note:** Use a negative or zero value to disable probing altogether.
266266

@@ -280,7 +280,7 @@ SET GCM_AUTODETECT_TIMEOUT=-1
280280
export GCM_AUTODETECT_TIMEOUT=-1
281281
```
282282

283-
**Also see: [credential.autoDetectTimeout](configuration.md#credentialautodetecttimeout)**
283+
**Also see: [credential.autoDetectTimeout][]**
284284

285285
---
286286

@@ -311,15 +311,15 @@ SET GCM_ALLOW_WINDOWSAUTH=0
311311
export GCM_ALLOW_WINDOWSAUTH=0
312312
```
313313

314-
**Also see: [credential.allowWindowsAuth](environment.md#credentialallowWindowsAuth)**
314+
**Also see: [credential.allowWindowsAuth][]**
315315

316316
---
317317

318318
### GCM_HTTP_PROXY _(deprecated)_
319319

320-
> This setting is deprecated and should be replaced by the [standard `http.proxy` Git configuration option](https://git-scm.com/docs/git-config#Documentation/git-config.txt-httpproxy).
320+
> This setting is deprecated and should be replaced by the [standard `http.proxy` Git configuration option][].
321321
>
322-
> Click [here](https://aka.ms/gcm/httpproxy) for more information.
322+
> See the [HTTP proxy configuration][] for more information.
323323
324324
Configure GCM to use the a proxy for network operations.
325325

@@ -337,7 +337,7 @@ SET GCM_HTTP_PROXY=http://john.doe:[email protected]
337337
export GCM_HTTP_PROXY=http://john.doe:[email protected]
338338
```
339339

340-
**Also see: [credential.httpProxy](configuration.md#credentialhttpProxy-deprecated)**
340+
**Also see: [credential.httpProxy][]**
341341

342342
---
343343

@@ -368,7 +368,7 @@ SET GCM_BITBUCKET_AUTHMODES="oauth,basic"
368368
export GCM_BITBUCKET_AUTHMODES="oauth,basic"
369369
```
370370

371-
**Also see: [credential.bitbucketAuthModes](configuration.md#credentialbitbucketAuthModes)**
371+
**Also see: [credential.bitbucketAuthModes][]**
372372

373373
---
374374

@@ -401,7 +401,7 @@ export GCM_BITBUCKET_ALWAYS_REFRESH_CREDENTIALS=1
401401

402402
Defaults to false/disabled.
403403

404-
**Also see: [credential.bitbucketAlwaysRefreshCredentials](configuration.md#bitbucketAlwaysRefreshCredentials)**
404+
**Also see: [credential.bitbucketAlwaysRefreshCredentials][]**
405405

406406
---
407407

@@ -433,7 +433,7 @@ SET GCM_GITHUB_AUTHMODES="oauth,basic"
433433
export GCM_GITHUB_AUTHMODES="oauth,basic"
434434
```
435435

436-
**Also see: [credential.gitHubAuthModes](configuration.md#credentialgitHubAuthModes)**
436+
**Also see: [credential.gitHubAuthModes][github-auth-modes]**
437437

438438
---
439439

@@ -463,7 +463,7 @@ SET GCM_GITLAB_AUTHMODES="browser"
463463
export GCM_GITLAB_AUTHMODES="browser"
464464
```
465465

466-
**Also see: [credential.gitLabAuthModes](configuration.md#credentialgitLabAuthModes)**
466+
**Also see: [credential.gitLabAuthModes][gitlab-auth-modes]**
467467

468468
---
469469

@@ -486,7 +486,7 @@ SET GCM_NAMESPACE="my-namespace"
486486
export GCM_NAMESPACE="my-namespace"
487487
```
488488

489-
**Also see: [credential.namespace](configuration.md#credentialnamespace)**
489+
**Also see: [credential.namespace][credential-namespace]**
490490

491491
---
492492

@@ -496,18 +496,18 @@ Select the type of credential store to use on supported platforms.
496496

497497
Default value on Windows is `wincredman`, on macOS is `keychain`, and is unset on Linux.
498498

499-
**Note:** See more information about configuring secret stores [here](credstores.md).
499+
**Note:** For more information about configuring secret stores see the [credential stores documentation][credential-stores].
500500

501501
Value|Credential Store|Platforms
502502
-|-|-
503503
_(unset)_|Windows: `wincredman`, macOS: `keychain`, Linux: _(none)_|-
504504
`wincredman`|Windows Credential Manager (not available over SSH).|Windows
505-
`dpapi`|DPAPI protected files. Customize the DPAPI store location with [`GCM_DPAPI_STORE_PATH`](#gcm_dpapi_store_path)|Windows
505+
`dpapi`|DPAPI protected files. Customize the DPAPI store location with [`GCM_DPAPI_STORE_PATH`][gcm-dpapi-store-path]|Windows
506506
`keychain`|macOS Keychain.|macOS
507-
`secretservice`|[freedesktop.org Secret Service API](https://specifications.freedesktop.org/secret-service/) via [libsecret](https://wiki.gnome.org/Projects/Libsecret) (requires a graphical interface to unlock secret collections).|Linux
508-
`gpg`|Use GPG to store encrypted files that are compatible with the [`pass` utility](https://www.passwordstore.org/) (requires GPG and `pass` to initialize the store).|macOS, Linux
509-
`cache`|Git's built-in [credential cache](https://git-scm.com/docs/git-credential-cache).|Windows, macOS, Linux
510-
`plaintext`|Store credentials in plaintext files (**UNSECURE**). Customize the plaintext store location with [`GCM_PLAINTEXT_STORE_PATH`](#gcm_plaintext_store_path).|Windows, macOS, Linux
507+
`secretservice`|[freedesktop.org Secret Service API][freedesktop-ss] via [libsecret][libsecret] (requires a graphical interface to unlock secret collections).|Linux
508+
`gpg`|Use GPG to store encrypted files that are compatible with the [`pass` utility][passwordstore] (requires GPG and `pass` to initialize the store).|macOS, Linux
509+
`cache`|Git's built-in [credential cache][git-credential-cache].|Windows, macOS, Linux
510+
`plaintext`|Store credentials in plaintext files (**UNSECURE**). Customize the plaintext store location with [`GCM_PLAINTEXT_STORE_PATH`][gcm-plaintext-store-path].|Windows, macOS, Linux
511511

512512
#### Windows
513513

@@ -521,14 +521,14 @@ SET GCM_CREDENTIAL_STORE="gpg"
521521
export GCM_CREDENTIAL_STORE="gpg"
522522
```
523523

524-
**Also see: [credential.credentialStore](configuration.md#credentialcredentialstore)**
524+
**Also see: [credential.credentialStore][credential-credential-store]**
525525

526526
---
527527

528528
### GCM_CREDENTIAL_CACHE_OPTIONS
529529

530-
Pass [options](https://git-scm.com/docs/git-credential-cache#_options)
531-
to the Git credential cache when [`GCM_CREDENTIAL_STORE`](#GCM_CREDENTIAL_STORE)
530+
Pass [options][git-cache-options]
531+
to the Git credential cache when [`GCM_CREDENTIAL_STORE`][gcm-credential-store]
532532
is set to `cache`. This allows you to select a different amount
533533
of time to cache credentials (the default is 900 seconds) by passing
534534
`"--timeout <seconds>"`. Use of other options like `--socket` is untested
@@ -548,13 +548,13 @@ SET GCM_CREDENTIAL_CACHE_OPTIONS="--timeout 300"
548548
export GCM_CREDENTIAL_CACHE_OPTIONS="--timeout 300"
549549
```
550550

551-
**Also see: [credential.cacheOptions](configuration.md#credentialcacheoptions)**
551+
**Also see: [credential.cacheOptions][credential-cache-options]**
552552

553553
---
554554

555555
### GCM_PLAINTEXT_STORE_PATH
556556

557-
Specify a custom directory to store plaintext credential files in when [`GCM_CREDENTIAL_STORE`](#GCM_CREDENTIAL_STORE) is set to `plaintext`.
557+
Specify a custom directory to store plaintext credential files in when [`GCM_CREDENTIAL_STORE`][gcm-credential-store] is set to `plaintext`.
558558

559559
Defaults to the value `~/.gcm/store` or `%USERPROFILE%\.gcm\store`.
560560

@@ -570,7 +570,7 @@ SETX GCM_PLAINTEXT_STORE_PATH=D:\credentials
570570
export GCM_PLAINTEXT_STORE_PATH=/mnt/external-drive/credentials
571571
```
572572

573-
**Also see: [credential.plaintextStorePath](configuration.md#credentialplaintextstorepath)**
573+
**Also see: [credential.plaintextStorePath][credential-plain-text-store]**
574574

575575
---
576576

@@ -586,7 +586,7 @@ Defaults to the value `%USERPROFILE%\.gcm\dpapi_store`.
586586
SETX GCM_DPAPI_STORE_PATH=D:\credentials
587587
```
588588

589-
**Also see: [credential.dpapiStorePath](configuration.md#credentialdpapistorepath)**
589+
**Also see: [credential.dpapiStorePath][credential-dpapi-store-path]**
590590

591591
---
592592

@@ -612,7 +612,7 @@ Specify which authentication flow should be used when performing Microsoft authe
612612

613613
Defaults to `auto`.
614614

615-
**Note:** If [`GCM_MSAUTH_USEBROKER`](#gcm_msauth_usebroker-experimental) is set to `true`
615+
**Note:** If [`GCM_MSAUTH_USEBROKER`][gcm-msauth-usebroker] is set to `true`
616616
and the operating system authentication broker is available, all flows will be
617617
delegated to the broker. If both of those things are true, then the value of
618618
`GCM_MSAUTH_FLOW` has no effect.
@@ -636,7 +636,7 @@ SET GCM_MSAUTH_FLOW="devicecode"
636636
export GCM_MSAUTH_FLOW="devicecode"
637637
```
638638

639-
**Also see: [credential.msauthFlow](configuration.md#credentialmsauthflow)**
639+
**Also see: [credential.msauthFlow][credential-msauth-flow]**
640640

641641
---
642642

@@ -646,7 +646,7 @@ Use the operating system account manager where available.
646646

647647
Defaults to `false`. This default is subject to change in the future.
648648

649-
_**Note:** before you enable this option on Windows, please [review the details](windows-broker.md) about what this means to your local Windows user account._
649+
_**Note:** before you enable this option on Windows, please [review the details][windows-broker] about what this means to your local Windows user account._
650650

651651
Value|Description
652652
-|-
@@ -665,7 +665,7 @@ SET GCM_MSAUTH_USEBROKER="true"
665665
export GCM_MSAUTH_USEBROKER="false"
666666
```
667667

668-
**Also see: [credential.msauthUseBroker](configuration.md#credentialmsauthusebroker-experimental)**
668+
**Also see: [credential.msauthUseBroker][credential-msauth-usebroker]**
669669

670670
---
671671

@@ -680,7 +680,7 @@ Value|Description
680680
`pat` _(default)_|Azure DevOps personal access tokens
681681
`oauth`|Microsoft identity OAuth tokens (AAD or MSA tokens)
682682

683-
More information about Azure Access tokens can be found [here](azrepos-users-and-tokens.md).
683+
More information about Azure Access tokens can be found [here][azure-access-tokens].
684684

685685
#### Windows
686686

@@ -694,4 +694,45 @@ SET GCM_AZREPOS_CREDENTIALTYPE="oauth"
694694
export GCM_AZREPOS_CREDENTIALTYPE="oauth"
695695
```
696696

697-
**Also see: [credential.azreposCredentialType](configuration.md#azreposcredentialtype)**
697+
**Also see: [credential.azreposCredentialType][credential-azrepos-credential-type]**
698+
699+
[autodetection]: autodetect.md
700+
[azure-access-tokens]: azrepos-users-and-tokens.md
701+
[configuration]: configuration.md
702+
[credential.allowWindowsAuth]: environment.md#credentialallowWindowsAuth
703+
[credential.authority]: configuration.md#credentialauthority-deprecated
704+
[credential.autoDetectTimeout]: configuration.md#credentialautodetecttimeout
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
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
714+
[credential-namespace]: configuration.md#credentialnamespace
715+
[credential-msauth-flow]: configuration.md#credentialmsauthflow
716+
[credential-msauth-usebroker]: configuration.md#credentialmsauthusebroker-experimental
717+
[credential-plain-text-store]: configuration.md#credentialplaintextstorepath
718+
[credential.provider]: configuration.md#credentialprovider
719+
[credential-stores]: credstores.md
720+
[default values]: enterprise-config.md
721+
[freedesktop-ss]: https://specifications.freedesktop.org/secret-service/
722+
[GCM_INTERACTIVE]: #gcm_interactive
723+
[gcm-credential-store]: #GCM_CREDENTIAL_STORE
724+
[gcm-dpapi-store-path]: #gcm_dpapi_store_path
725+
[gcm-plaintext-store-path]: #gcm_plaintext_store_path
726+
[gcm-msauth-usebroker]: #gcm_msauth_usebroker-experimental
727+
[git-cache-options]: https://git-scm.com/docs/git-credential-cache#_options
728+
[Git Credential Manager]: usage.md
729+
[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
734+
[libsecret]: https://wiki.gnome.org/Projects/Libsecret
735+
[migration guide]: migration.md#gcm_authority
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+
[windows-broker]: windows-broker.md

0 commit comments

Comments
 (0)