Skip to content

Latest commit

 

History

History
358 lines (229 loc) · 12.4 KB

configuration.md

File metadata and controls

358 lines (229 loc) · 12.4 KB

Configuration options

Git Credential Manager Core works out of the box for most users.

Git Credential Manager Core (GCM Core) can be configured using Git's configuration files, and follows all of the same rules Git does when consuming the files. Global configuration settings override system configuration settings, and local configuration settings override global settings; and because the configuration details exist within Git's configuration files you can use Git's git config utility to set, unset, and alter the setting values. All of GCM Core's configuration settings begin with the term credential.

GCM Core honors several levels of settings, in addition to the standard local > global > system tiering Git uses. URL-specific settings or overrides can be applied to any value in the credential namespace with the syntax below.

Additionally, GCM Core respects several GCM-specific environment variables which take precedence over configuration options.

GCM Core will only be used by Git if it is installed and configured. Use git config --global credential.helper manager-core to assign GCM Core as your credential helper. Use git config credential.helper to see the current configuration.

Example:

credential.microsoft.visualstudio.com.namespace is more specific than credential.visualstudio.com.namespace, which is more specific than credential.namespace.

In the examples above, the credential.namespace setting would affect any remote repository; the credential.visualstudio.com.namespace would affect any remote repository in the domain, and/or any subdomain (including www.) of, 'visualstudio.com'; where as the credential.microsoft.visualstudio.com.namespace setting would only be applied to remote repositories hosted at 'microsoft.visualstudio.com'.

For the complete list of settings GCM Core understands, see the list below.

Available settings

credential.interactive

Permit or disable GCM Core from interacting with the user (showing GUI or TTY prompts). If interaction is required but has been disabled, an error is returned.

This can be helpful when using GCM Core in headless and unattended environments, such as build servers, where it would be preferable to fail than to hang indefinitely waiting for a non-existent user.

To disable interactivity set this to false or 0.

Compatibility

In previous versions of GCM this setting had a different behavior and accepted other values. The following table summarizes the change in behavior and the mapping of older values such as never:

Value(s) Old meaning New meaning
auto Prompt if required – use cached credentials if possible (unchanged)
never,
false		 Never prompt – fail if interaction is required (unchanged)
always,
force,
true		 Always prompt – don't use cached credentials Prompt if required (same as the old auto value)

Example

git config --global credential.interactive false

Defaults to enabled.

Also see: GCM_INTERACTIVE

credential.provider

Define the host provider to use when authenticating.

ID Provider
auto (default) [automatic]
azure-repos Azure Repos
github GitHub
bitbucket Bitbucket
generic Generic (any other provider not listed above)

Automatic provider selection is based on the remote URL.

This setting is typically used with a scoped URL to map a particular set of remote URLs to providers, for example to mark a host as a GitHub Enterprise instance.

Example

git config --global credential.ghe.contoso.com.provider github

Also see: GCM_PROVIDER

credential.authority (deprecated)

This setting is deprecated and should be replaced by credential.provider with the corresponding provider ID value.

Click here for more information.

Select the host provider to use when authenticating by which authority is supported by the providers.

Authority Provider(s)
auto (default) [automatic]
msa, microsoft, microsoftaccount,
aad, azure, azuredirectory,
live, liveconnect, liveid		 Azure Repos
(supports Microsoft Authentication)
github GitHub
(supports GitHub Authentication)
bitbucket Bitbucket.org
(supports Basic Authentication and OAuth)
Bitbucket Server
(supports Basic Authentication)
basic, integrated, windows, kerberos, ntlm,
tfs, sso		 Generic
(supports Basic and Windows Integrated Authentication)

Example

git config --global credential.ghe.contoso.com.authority github

Also see: GCM_AUTHORITY

credential.allowWindowsAuth

Allow detection of Windows Integrated Authentication (WIA) support for generic host providers. Setting this value to false will prevent the use of WIA and force a basic authentication prompt when using the Generic host provider.

Note: WIA is only supported on Windows.

Note: WIA is an umbrella term for NTLM and Kerberos (and Negotiate).

Value WIA detection
true (default) Permitted
false Not permitted

Example

git config --global credential.tfsonprem123.allowWindowsAuth false

Also see: GCM_ALLOW_WINDOWSAUTH

credential.httpProxy (deprecated)

This setting is deprecated and should be replaced by the standard http.proxy Git configuration option.

Click here for more information.

Configure GCM Core to use the a proxy for network operations.

Note: Git itself does not respect this setting; this affects GCM only.

Example

git config --global credential.httpsProxy http://john.doe:password@proxy.contoso.com

Also see: GCM_HTTP_PROXY

credential.gitHubAuthModes

Override the available authentication modes presented during GitHub authentication. If this option is not set, then the available authentication modes will be automatically detected.

Note: This setting supports multiple values separated by commas.

Value Authentication Mode
(unset) Automatically detect modes
oauth OAuth-based authentication
basic Basic/PAT-based authentication

Example

git config --global credential.gitHubAuthModes "oauth,basic"

Also see: GCM_GITHUB_AUTHMODES

credential.namespace

Use a custom namespace prefix for credentials read and written in the OS credential store. Credentials will be stored in the format {namespace}:{service}.

Defaults to the value git.

Example

git config --global credential.namespace "my-namespace"

Also see: GCM_NAMESPACE

credential.credentialStore

Select the type of credential store to use on supported platforms.

Default value is unset.

Note: This setting is only supported on Linux platforms. Setting this value on Windows and macOS has no effect. See more information about configuring secret stores on Linux here.

Value Credential Store
(unset) (error)
secretservice freedesktop.org Secret Service API via libsecret (requires a graphical interface to unlock secret collections).
gpg Use GPG to store encrypted files that are compatible with the pass utility (requires GPG and pass to initialize the store).
cache Git's built-in credential cache.
plaintext Store credentials in plaintext files (UNSECURE). Customize the plaintext store location with credential.plaintextStorePath.
Example
git config --global credential.credentialStore gpg

Also see: GCM_CREDENTIAL_STORE

credential.cacheOptions

Pass options to the Git credential cache when credential.credentialStore is set to cache. This allows you to select a different amount of time to cache credentials (the default is 900 seconds) by passing "--timeout <seconds>". Use of other options like --socket is untested and unsupported, but there's no reason it shouldn't work.

Defaults to empty.

Example

git config --global credential.cacheOptions "--timeout 300"

Also see: GCM_CREDENTIAL_CACHE_OPTIONS

credential.plaintextStorePath

Specify a custom directory to store plaintext credential files in when credential.credentialStore is set to plaintext.

Defaults to the value ~/.gcm/store.

Example

git config --global credential.plaintextStorePath /mnt/external-drive/credentials

Also see: GCM_PLAINTEXT_STORE_PATH

credential.msauthFlow

Specify which authentication flow should be used when performing Microsoft authentication and an interactive flow is required.

Defaults to the value auto.

Value Authentication Flow
auto (default) Select the best option depending on the current environment and platform.
embedded Show a window with embedded web view control.
system Open the user's default web browser.
devicecode Show a device code.

Example

git config --global credential.msauthFlow devicecode

Also see: GCM_MSAUTH_FLOW

credential.useHttpPath

Tells Git to pass the entire repository URL, rather than just the hostname, when calling out to a credential provider. (This setting comes from Git itself, not GCM Core.)

Defaults to false.

Note: GCM Core sets this value to true for dev.azure.com (Azure Repos) hosts after installation by default.

This is because dev.azure.com alone is not enough information to determine the correct Azure authentication authority - we require a part of the path. The fallout of this is that for dev.azure.com remote URLs we do not support storing credentials against the full-path. We always store against the dev.azure.com/org-name stub.

In order to use Azure Repos and store credentials against a full-path URL, you must use the org-name.visualstudio.com remote URL format instead.

Value Git Behavior
false (default) Git will use only user and hostname to look up credentials.
true Git will use the full repository URL to look up credentials.

Example

On Windows using GitHub, for a user whose login is alice, and with credential.useHttpPath set to false (or not set), the following remote URLs will use the same credentials:

Credential: "git:https://github.com" (user = alice) 

   https://github.com/foo/bar
   https://github.com/contoso/widgets
   https://alice@github.com/contoso/widgets

Credential: "git:https://bob@github.com" (user = bob)

   https://bob@github.com/foo/bar
   https://bob@github.com/example/myrepo

Under the same user but with credential.useHttpPath set to true, these credentials would be used:

Credential: "git:https://github.com/foo/bar" (user = alice)

   https://github.com/foo/bar

Credential: "git:https://github.com/contoso/widgets" (user = alice)

   https://github.com/contoso/widgets
   https://alice@github.com/contoso/widgets

Credential: "git:https://bob@github.com/foo/bar" (user = bob)

   https://bob@github.com/foo/bar

Credential: "git:https://bob@github.com/example/myrepo" (user = bob)

   https://bob@github.com/example/myrepo

credential.azreposCredentialType (experimental)

Specify the type of credential the Azure Repos host provider should return.

Defaults to the value pat.

Value Description
pat (default) Azure DevOps personal access tokens
oauth Microsoft identity OAuth tokens (AAD or MSA tokens)

More information about Azure Access tokens can be found here.

Example

git config --global credential.azreposCredentialType oauth

Also see: GCM_AZREPOS_CREDENTIALTYPE