ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / share / doc / git-1.8.3.1

gitcredentials(7)
=================

NAME
----
gitcredentials - providing usernames and passwords to Git

SYNOPSIS
--------
------------------
git config credential.https://example.com.username myusername
git config credential.helper "$helper $options"
------------------

DESCRIPTION
-----------

Git will sometimes need credentials from the user in order to perform
operations; for example, it may need to ask for a username and password
in order to access a remote repository over HTTP. This manual describes
the mechanisms Git uses to request these credentials, as well as some
features to avoid inputting these credentials repeatedly.

REQUESTING CREDENTIALS
----------------------

Without any credential helpers defined, Git will try the following
strategies to ask the user for usernames and passwords:

1. If the `GIT_ASKPASS` environment variable is set, the program
   specified by the variable is invoked. A suitable prompt is provided
   to the program on the command line, and the user's input is read
   from its standard output.

2. Otherwise, if the `core.askpass` configuration variable is set, its
   value is used as above.

3. Otherwise, if the `SSH_ASKPASS` environment variable is set, its
   value is used as above.

4. Otherwise, the user is prompted on the terminal.

AVOIDING REPETITION
-------------------

It can be cumbersome to input the same credentials over and over.  Git
provides two methods to reduce this annoyance:

1. Static configuration of usernames for a given authentication context.

2. Credential helpers to cache or store passwords, or to interact with
   a system password wallet or keychain.

The first is simple and appropriate if you do not have secure storage available
for a password. It is generally configured by adding this to your config:

---------------------------------------
[credential "https://example.com"]
	username = me
---------------------------------------

Credential helpers, on the other hand, are external programs from which Git can
request both usernames and passwords; they typically interface with secure
storage provided by the OS or other programs.

To use a helper, you must first select one to use. Git currently
includes the following helpers:

cache::

Cache credentials in memory for a short period of time. See
	linkgit:git-credential-cache[1] for details.

store::

Store credentials indefinitely on disk. See
	linkgit:git-credential-store[1] for details.

You may also have third-party helpers installed; search for
`credential-*` in the output of `git help -a`, and consult the
documentation of individual helpers.  Once you have selected a helper,
you can tell Git to use it by putting its name into the
credential.helper variable.

1. Find a helper.
+
-------------------------------------------
$ git help -a | grep credential-
credential-foo
-------------------------------------------

2. Read its description.
+
-------------------------------------------
$ git help credential-foo
-------------------------------------------

3. Tell Git to use it.
+
-------------------------------------------
$ git config --global credential.helper foo
-------------------------------------------

If there are multiple instances of the `credential.helper` configuration
variable, each helper will be tried in turn, and may provide a username,
password, or nothing. Once Git has acquired both a username and a
password, no more helpers will be tried.

CREDENTIAL CONTEXTS
-------------------

Git considers each credential to have a context defined by a URL. This context
is used to look up context-specific configuration, and is passed to any
helpers, which may use it as an index into secure storage.

For instance, imagine we are accessing `https://example.com/foo.git`. When Git
looks into a config file to see if a section matches this context, it will
consider the two a match if the context is a more-specific subset of the
pattern in the config file. For example, if you have this in your config file:

--------------------------------------
[credential "https://example.com"]
	username = foo
--------------------------------------

then we will match: both protocols are the same, both hosts are the same, and
the "pattern" URL does not care about the path component at all. However, this
context would not match:

--------------------------------------
[credential "https://kernel.org"]
	username = foo
--------------------------------------

because the hostnames differ. Nor would it match `foo.example.com`; Git
compares hostnames exactly, without considering whether two hosts are part of
the same domain. Likewise, a config entry for `http://example.com` would not
match: Git compares the protocols exactly.  However, you may use wildcards in
the domain name and other pattern matching techniques as with the `http.<url>.*`
options.

CONFIGURATION OPTIONS
---------------------

Options for a credential context can be configured either in
`credential.*` (which applies to all credentials), or
`credential.<url>.*`, where <url> matches the context as described
above.

The following options are available in either location:

helper::

The name of an external credential helper, and any associated options.
	If the helper name is not an absolute path, then the string `git
	credential-` is prepended. The resulting string is executed by the
	shell (so, for example, setting this to `foo --option=bar` will execute
	`git credential-foo --option=bar` via the shell. See the manual of
	specific helpers for examples of their use.

username::

A default username, if one is not provided in the URL.

useHttpPath::

By default, Git does not consider the "path" component of an http URL
	to be worth matching via external helpers. This means that a credential
	stored for `https://example.com/foo.git` will also be used for
	`https://example.com/bar.git`. If you do want to distinguish these
	cases, set this option to `true`.

CUSTOM HELPERS
--------------

You can write your own custom helpers to interface with any system in
which you keep credentials. See the documentation for Git's
link:technical/api-credentials.html[credentials API] for details.

GIT
---
Part of the linkgit:git[1] suite

[+] ..
[-] gitworkflows.txt [edit]
[-] git-name-rev.txt [edit]
[-] git-status.html [edit]
[-] git-difftool.txt [edit]
[-] git-blame.html [edit]
[-] git-rebase.html [edit]
[-] git-push.html [edit]
[-] git-count-objects.txt [edit]
[-] mergetools-merge.txt [edit]
[-] git-show-index.txt [edit]
[-] gitcredentials.txt [edit]
[-] git-status.txt [edit]
[-] cmds-plumbinginterrogators.txt [edit]
[-] git.txt [edit]
[-] COPYING [edit]
[-] git-replace.txt [edit]
[-] git-cvsserver.txt [edit]
[-] git-apply.html [edit]
[-] gitweb.html [edit]
[-] git-rm.html [edit]
[-] git-cvsserver.html [edit]
[-] git-fetch.html [edit]
[-] git-daemon.html [edit]
[-] mailmap.txt [edit]
[-] git-for-each-ref.html [edit]
[-] gitk.txt [edit]
[-] diff-format.txt [edit]
[-] git-parse-remote.html [edit]
[-] gittutorial-2.html [edit]
[-] git-repack.txt [edit]
[-] gitcvs-migration.html [edit]
[-] gitrevisions.txt [edit]
[-] git-ls-files.html [edit]
[-] git-rev-parse.html [edit]
[-] git-show-ref.html [edit]
[-] blame-options.txt [edit]
[-] git-rev-list.txt [edit]
[-] git-index-pack.txt [edit]
[-] git-credential-cache.txt [edit]
[-] git-show-ref.txt [edit]
[-] pretty-formats.txt [edit]
[-] git-shortlog.txt [edit]
[-] pull-fetch-param.txt [edit]
[-] git-rev-list.html [edit]
[-] git-fmt-merge-msg.html [edit]
[-] git-clean.txt [edit]
[-] git-notes.txt [edit]
[-] git-count-objects.html [edit]
[-] git-clean.html [edit]
[-] git.html [edit]
[-] git-show-index.html [edit]
[-] git-fsck.html [edit]
[-] gitrepository-layout.html [edit]
[-] git-cvsimport.txt [edit]
[-] git-commit.html [edit]
[-] git-tag.html [edit]
[-] git-reflog.txt [edit]
[-] git-sh-i18n.txt [edit]
[-] git-stripspace.html [edit]
[-] gitweb.txt [edit]
[-] gitglossary.txt [edit]
[-] git-shell.txt [edit]
[-] git-prune.txt [edit]
[-] gitignore.html [edit]
[-] git-fast-export.html [edit]
[-] git-get-tar-commit-id.html [edit]
[-] git-http-fetch.html [edit]
[-] gitweb.conf.html [edit]
[-] git-notes.html [edit]
[-] git-update-index.html [edit]
[-] git-mailsplit.txt [edit]
[-] cmds-synchingrepositories.txt [edit]
[-] git-unpack-file.txt [edit]
[-] git-verify-tag.html [edit]
[-] gitdiffcore.html [edit]
[-] git-branch.txt [edit]
[-] git-request-pull.html [edit]
[-] git-diff-files.txt [edit]
[-] git-log.html [edit]
[-] git-check-ignore.html [edit]
[-] git-checkout-index.txt [edit]
[-] git-cherry.html [edit]
[-] git-diff-files.html [edit]
[-] git-receive-pack.txt [edit]
[-] git-mktree.html [edit]
[-] git-instaweb.html [edit]
[-] git-merge-file.html [edit]
[-] README [edit]
[-] git-stage.html [edit]
[+] howto
[-] git-tools.html [edit]
[-] fetch-options.txt [edit]
[-] git-remote.txt [edit]
[-] git-merge-base.txt [edit]
[-] git-pull.html [edit]
[-] git-merge-index.html [edit]
[-] githooks.txt [edit]
[-] git-svn.txt [edit]
[-] git-repo-config.html [edit]
[-] git-instaweb.txt [edit]
[+] contrib
[-] git-describe.html [edit]
[-] gitattributes.html [edit]
[-] gitcli.html [edit]
[-] git-fast-import.txt [edit]
[-] git-checkout.html [edit]
[-] merge-config.txt [edit]
[-] revisions.txt [edit]
[-] git-gc.txt [edit]
[-] git-credential-store.txt [edit]
[-] git-update-server-info.txt [edit]
[-] git-rm.txt [edit]
[-] cmds-ancillarymanipulators.txt [edit]
[-] git-mailsplit.html [edit]
[-] git-merge-one-file.txt [edit]
[-] git-help.html [edit]
[-] git-sh-i18n--envsubst.html [edit]
[-] git-reflog.html [edit]
[-] git-http-fetch.txt [edit]
[-] git-check-ref-format.html [edit]
[-] git-commit.txt [edit]
[-] git-p4.txt [edit]
[-] git-rev-parse.txt [edit]
[-] git-check-ref-format.txt [edit]
[-] git-merge-tree.html [edit]
[-] git-read-tree.txt [edit]
[-] git-check-attr.html [edit]
[-] git-mailinfo.txt [edit]
[-] git-mv.html [edit]
[-] git-quiltimport.txt [edit]
[-] git-daemon.txt [edit]
[-] git-ls-files.txt [edit]
[-] git-web--browse.txt [edit]
[-] git-patch-id.txt [edit]
[-] git-bisect-lk2009.html [edit]
[-] git-stripspace.txt [edit]
[-] gitmodules.html [edit]
[-] git-archive.html [edit]
[-] git-gc.html [edit]
[-] git-gui.txt [edit]
[-] pretty-options.txt [edit]
[-] git-column.txt [edit]
[-] git-fetch-pack.txt [edit]
[-] git-log.txt [edit]
[-] gitworkflows.html [edit]
[-] gitcore-tutorial.html [edit]
[-] git-prune.html [edit]
[-] git-cvsexportcommit.txt [edit]
[-] git-rerere.txt [edit]
[-] gitremote-helpers.html [edit]
[-] git-quiltimport.html [edit]
[-] git-fsck.txt [edit]
[-] git-peek-remote.txt [edit]
[-] git-imap-send.txt [edit]
[-] gitk.html [edit]
[-] git-hash-object.html [edit]
[-] git-push.txt [edit]
[-] git-blame.txt [edit]
[-] git-upload-archive.html [edit]
[-] git-replace.html [edit]
[+] technical
[-] git-upload-pack.html [edit]
[-] git-sh-i18n.html [edit]
[-] git-init.html [edit]
[-] git-bisect.txt [edit]
[-] git-http-push.html [edit]
[-] git-diff-index.html [edit]
[-] git-lost-found.html [edit]
[-] git-http-backend.html [edit]
[-] date-formats.txt [edit]
[-] git-mailinfo.html [edit]
[-] git-show-branch.html [edit]
[-] gitnamespaces.txt [edit]
[-] git-cherry.txt [edit]
[-] git-grep.html [edit]
[-] git-repo-config.txt [edit]
[-] git-ls-tree.html [edit]
[-] git-bisect.html [edit]
[-] git-send-email.txt [edit]
[-] git-credential-store.html [edit]
[-] git-rerere.html [edit]
[-] git-var.html [edit]
[-] git-remote.html [edit]
[-] git-tools.txt [edit]
[-] git-pack-objects.txt [edit]
[-] git-credential-cache--daemon.html [edit]
[-] git-update-index.txt [edit]
[-] git-gui.html [edit]
[-] git-svn.html [edit]
[-] gitweb.conf.txt [edit]
[-] gitignore.txt [edit]
[-] git-http-backend.txt [edit]
[-] howto-index.html [edit]
[-] git-stash.html [edit]
[-] git-mergetool.html [edit]
[-] git-relink.txt [edit]
[-] git-for-each-ref.txt [edit]
[-] cmds-foreignscminterface.txt [edit]
[-] git-shortlog.html [edit]
[-] cmds-ancillaryinterrogators.txt [edit]
[-] git-credential.txt [edit]
[-] git-mergetool--lib.html [edit]
[-] git-submodule.txt [edit]
[-] git-repack.html [edit]
[-] git-merge.html [edit]
[-] git-show.txt [edit]
[-] gitcvs-migration.txt [edit]
[-] diff-options.txt [edit]
[-] git-sh-setup.html [edit]
[-] git-config.html [edit]
[-] git-annotate.txt [edit]
[-] gitglossary.html [edit]
[-] git-pull.txt [edit]
[-] git-mergetool--lib.txt [edit]
[-] rev-list-options.txt [edit]
[-] git-fetch.txt [edit]
[-] gitcli.txt [edit]
[-] git-fsck-objects.html [edit]
[-] git-stash.txt [edit]
[-] git-pack-refs.html [edit]
[-] git-reset.txt [edit]
[-] cmds-mainporcelain.txt [edit]
[-] git-hash-object.txt [edit]
[-] gitmodules.txt [edit]
[-] git-cat-file.html [edit]
[-] git-bisect-lk2009.txt [edit]
[-] git-receive-pack.html [edit]
[-] git-p4.html [edit]
[-] mergetools-diff.txt [edit]
[-] git-cvsimport.html [edit]
[-] gitremote-helpers.txt [edit]
[-] git-column.html [edit]
[-] git-prune-packed.html [edit]
[-] glossary-content.txt [edit]
[+] RelNotes
[-] git-rebase.txt [edit]
[-] git-config.txt [edit]
[-] git-pack-refs.txt [edit]
[-] git-merge-index.txt [edit]
[-] git-add.html [edit]
[-] gitrevisions.html [edit]
[-] git-cherry-pick.txt [edit]
[-] git-symbolic-ref.txt [edit]
[-] git-annotate.html [edit]
[-] git-clone.txt [edit]
[-] git-parse-remote.txt [edit]
[-] git-diff.html [edit]
[-] git-diff-index.txt [edit]
[-] git-mergetool.txt [edit]
[-] git-update-ref.txt [edit]
[-] git-lost-found.txt [edit]
[-] git-tar-tree.txt [edit]
[-] git-update-server-info.html [edit]
[-] git-upload-pack.txt [edit]
[-] git-commit-tree.txt [edit]
[-] git-clone.html [edit]
[-] git-help.txt [edit]
[-] git-send-email.html [edit]
[-] everyday.html [edit]
[-] git-index-pack.html [edit]
[-] git-mktree.txt [edit]
[-] git-fast-import.html [edit]
[-] git-bundle.txt [edit]
[-] git-am.txt [edit]
[-] gittutorial-2.txt [edit]
[-] git-remote-testgit.html [edit]
[-] git-diff-tree.txt [edit]
[-] cmds-synchelpers.txt [edit]
[-] git-diff-tree.html [edit]
[-] git-prune-packed.txt [edit]
[-] cmds-plumbingmanipulators.txt [edit]
[-] howto-index.txt [edit]
[-] git-tag.txt [edit]
[-] git-send-pack.html [edit]
[-] git-credential-cache--daemon.txt [edit]
[-] config.txt [edit]
[-] git-remote-fd.html [edit]
[-] git-revert.txt [edit]
[-] gitdiffcore.txt [edit]
[-] git-fast-export.txt [edit]
[-] git-upload-archive.txt [edit]
[-] git-diff.txt [edit]
[-] git-merge-one-file.html [edit]
[-] git-archive.txt [edit]
[-] diff-generate-patch.txt [edit]
[-] git-http-push.txt [edit]
[-] git-init-db.html [edit]
[-] git-cat-file.txt [edit]
[-] git-fetch-pack.html [edit]
[-] git-whatchanged.html [edit]
[-] git-cvsexportcommit.html [edit]
[-] git-patch-id.html [edit]
[-] git-name-rev.html [edit]
[-] git-apply.txt [edit]
[-] gittutorial.txt [edit]
[-] git-shell.html [edit]
[-] git-verify-pack.html [edit]
[-] git-write-tree.html [edit]
[-] git-request-pull.txt [edit]
[-] git-remote-testgit.txt [edit]
[-] merge-strategies.txt [edit]
[-] git-write-tree.txt [edit]
[-] git-init-db.txt [edit]
[-] git-revert.html [edit]
[-] git-remote-ext.html [edit]
[-] urls.txt [edit]
[-] git-credential.html [edit]
[-] git-peek-remote.html [edit]
[-] git-stage.txt [edit]
[-] git-am.html [edit]
[-] git-verify-pack.txt [edit]
[-] git-filter-branch.txt [edit]
[-] git-unpack-objects.html [edit]
[-] git-format-patch.html [edit]
[-] diff-config.txt [edit]
[-] git-remote-helpers.html [edit]
[-] git-pack-redundant.txt [edit]
[-] git-verify-tag.txt [edit]
[-] git-describe.txt [edit]
[-] git-remote-fd.txt [edit]
[-] git-bundle.html [edit]
[-] git-show.html [edit]
[-] gitattributes.txt [edit]
[-] gittutorial.html [edit]
[-] git-ls-tree.txt [edit]
[-] git-get-tar-commit-id.txt [edit]
[-] git-branch.html [edit]
[-] merge-options.txt [edit]
[-] git-filter-branch.html [edit]
[-] i18n.txt [edit]
[-] git-check-ignore.txt [edit]
[-] git-tar-tree.html [edit]
[-] git-sh-i18n--envsubst.txt [edit]
[-] git-whatchanged.txt [edit]
[-] gitcore-tutorial.txt [edit]
[-] gitrepository-layout.txt [edit]
[-] git-mktag.txt [edit]
[-] git-fmt-merge-msg.txt [edit]
[-] git-ls-remote.html [edit]
[-] git-citool.html [edit]
[-] git-citool.txt [edit]
[-] user-manual.html [edit]
[-] git-pack-redundant.html [edit]
[-] git-mv.txt [edit]
[-] git-submodule.html [edit]
[-] git-grep.txt [edit]
[-] git-unpack-file.html [edit]
[-] git-mktag.html [edit]
[-] git-update-ref.html [edit]
[-] git-symbolic-ref.html [edit]
[-] githooks.html [edit]
[-] git-pack-objects.html [edit]
[-] git-cherry-pick.html [edit]
[-] everyday.txt [edit]
[-] git-unpack-objects.txt [edit]
[-] git-read-tree.html [edit]
[-] git-show-branch.txt [edit]
[-] git-merge-tree.txt [edit]
[-] git-merge.txt [edit]
[-] git-ls-remote.txt [edit]
[-] git-merge-base.html [edit]
[-] git-imap-send.html [edit]
[-] gitcredentials.html [edit]
[-] git-commit-tree.html [edit]
[-] git-format-patch.txt [edit]
[-] git-web--browse.html [edit]
[-] git-sh-setup.txt [edit]
[-] git-var.txt [edit]
[-] gitnamespaces.html [edit]
[-] git-add.txt [edit]
[-] git-checkout-index.html [edit]
[-] docbook-xsl.css [edit]
[-] git-merge-file.txt [edit]
[-] git-reset.html [edit]
[-] git-fsck-objects.txt [edit]
[-] git-check-attr.txt [edit]
[-] git-difftool.html [edit]
[-] urls-remotes.txt [edit]
[-] git-send-pack.txt [edit]
[-] git-remote-ext.txt [edit]
[-] git-checkout.txt [edit]
[-] git-relink.html [edit]
[-] user-manual.txt [edit]
[-] sequencer.txt [edit]
[-] git-credential-cache.html [edit]
[-] cmds-purehelpers.txt [edit]
[-] git-init.txt [edit]