doc: describe git svn init --ignore-refs
[git/git-svn.git] / Documentation / gitcredentials.txt
blobf970196bc1c52f489538ab515e1640ac435fead3
1 gitcredentials(7)
2 =================
4 NAME
5 ----
6 gitcredentials - providing usernames and passwords to Git
8 SYNOPSIS
9 --------
10 ------------------
11 git config credential.https://example.com.username myusername
12 git config credential.helper "$helper $options"
13 ------------------
15 DESCRIPTION
16 -----------
18 Git will sometimes need credentials from the user in order to perform
19 operations; for example, it may need to ask for a username and password
20 in order to access a remote repository over HTTP. This manual describes
21 the mechanisms Git uses to request these credentials, as well as some
22 features to avoid inputting these credentials repeatedly.
24 REQUESTING CREDENTIALS
25 ----------------------
27 Without any credential helpers defined, Git will try the following
28 strategies to ask the user for usernames and passwords:
30 1. If the `GIT_ASKPASS` environment variable is set, the program
31    specified by the variable is invoked. A suitable prompt is provided
32    to the program on the command line, and the user's input is read
33    from its standard output.
35 2. Otherwise, if the `core.askPass` configuration variable is set, its
36    value is used as above.
38 3. Otherwise, if the `SSH_ASKPASS` environment variable is set, its
39    value is used as above.
41 4. Otherwise, the user is prompted on the terminal.
43 AVOIDING REPETITION
44 -------------------
46 It can be cumbersome to input the same credentials over and over.  Git
47 provides two methods to reduce this annoyance:
49 1. Static configuration of usernames for a given authentication context.
51 2. Credential helpers to cache or store passwords, or to interact with
52    a system password wallet or keychain.
54 The first is simple and appropriate if you do not have secure storage available
55 for a password. It is generally configured by adding this to your config:
57 ---------------------------------------
58 [credential "https://example.com"]
59         username = me
60 ---------------------------------------
62 Credential helpers, on the other hand, are external programs from which Git can
63 request both usernames and passwords; they typically interface with secure
64 storage provided by the OS or other programs.
66 To use a helper, you must first select one to use. Git currently
67 includes the following helpers:
69 cache::
71         Cache credentials in memory for a short period of time. See
72         linkgit:git-credential-cache[1] for details.
74 store::
76         Store credentials indefinitely on disk. See
77         linkgit:git-credential-store[1] for details.
79 You may also have third-party helpers installed; search for
80 `credential-*` in the output of `git help -a`, and consult the
81 documentation of individual helpers.  Once you have selected a helper,
82 you can tell Git to use it by putting its name into the
83 credential.helper variable.
85 1. Find a helper.
87 -------------------------------------------
88 $ git help -a | grep credential-
89 credential-foo
90 -------------------------------------------
92 2. Read its description.
94 -------------------------------------------
95 $ git help credential-foo
96 -------------------------------------------
98 3. Tell Git to use it.
100 -------------------------------------------
101 $ git config --global credential.helper foo
102 -------------------------------------------
105 CREDENTIAL CONTEXTS
106 -------------------
108 Git considers each credential to have a context defined by a URL. This context
109 is used to look up context-specific configuration, and is passed to any
110 helpers, which may use it as an index into secure storage.
112 For instance, imagine we are accessing `https://example.com/foo.git`. When Git
113 looks into a config file to see if a section matches this context, it will
114 consider the two a match if the context is a more-specific subset of the
115 pattern in the config file. For example, if you have this in your config file:
117 --------------------------------------
118 [credential "https://example.com"]
119         username = foo
120 --------------------------------------
122 then we will match: both protocols are the same, both hosts are the same, and
123 the "pattern" URL does not care about the path component at all. However, this
124 context would not match:
126 --------------------------------------
127 [credential "https://kernel.org"]
128         username = foo
129 --------------------------------------
131 because the hostnames differ. Nor would it match `foo.example.com`; Git
132 compares hostnames exactly, without considering whether two hosts are part of
133 the same domain. Likewise, a config entry for `http://example.com` would not
134 match: Git compares the protocols exactly.
137 CONFIGURATION OPTIONS
138 ---------------------
140 Options for a credential context can be configured either in
141 `credential.*` (which applies to all credentials), or
142 `credential.<url>.*`, where <url> matches the context as described
143 above.
145 The following options are available in either location:
147 helper::
149         The name of an external credential helper, and any associated options.
150         If the helper name is not an absolute path, then the string `git
151         credential-` is prepended. The resulting string is executed by the
152         shell (so, for example, setting this to `foo --option=bar` will execute
153         `git credential-foo --option=bar` via the shell. See the manual of
154         specific helpers for examples of their use.
156 If there are multiple instances of the `credential.helper` configuration
157 variable, each helper will be tried in turn, and may provide a username,
158 password, or nothing. Once Git has acquired both a username and a
159 password, no more helpers will be tried.
161 If `credential.helper` is configured to the empty string, this resets
162 the helper list to empty (so you may override a helper set by a
163 lower-priority config file by configuring the empty-string helper,
164 followed by whatever set of helpers you would like).
166 username::
168         A default username, if one is not provided in the URL.
170 useHttpPath::
172         By default, Git does not consider the "path" component of an http URL
173         to be worth matching via external helpers. This means that a credential
174         stored for `https://example.com/foo.git` will also be used for
175         `https://example.com/bar.git`. If you do want to distinguish these
176         cases, set this option to `true`.
179 CUSTOM HELPERS
180 --------------
182 You can write your own custom helpers to interface with any system in
183 which you keep credentials. See the documentation for Git's
184 link:technical/api-credentials.html[credentials API] for details.
188 Part of the linkgit:git[1] suite