Merge branch 'rc/maint-http-wrong-free' into next
[git] / Documentation / git-credential-store.txt
1 git-credential-store(1)
2 =======================
3
4 NAME
5 ----
6 git-credential-store - helper to store credentials on disk
7
8 SYNOPSIS
9 --------
10 -------------------
11 git config credential.helper 'store [options]'
12 -------------------
13
14 DESCRIPTION
15 -----------
16
17 NOTE: Using this helper will store your passwords unencrypted on disk,
18 protected only by filesystem permissions. If this is not an acceptable
19 security tradeoff, try linkgit:git-credential-cache[1], or find a helper
20 that integrates with secure storage provided by your operating system.
21
22 This command requests credentials from the user and stores them
23 indefinitely on disk for use by future git programs.
24
25 You probably don't want to invoke this command directly; it is meant to
26 be used as a credential helper by other parts of git. See
27 linkgit:gitcredentials[7] or `EXAMPLES` below.
28
29 OPTIONS
30 -------
31
32 --store=<path>::
33
34         Use `<path>` to store credentials. The file will have its
35         filesystem permissions set to prevent other users on the system
36         from reading it, but will not be encrypted or otherwise
37         protected.
38
39 --chain <helper>::
40
41         Specify an external helper to use for retrieving credentials
42         from the user, instead of the default method. The resulting
43         credentials are then stored as normal. This option can be
44         given multiple times; each chained helper will be tried until
45         credentials are received.
46
47 Git may provide other options to the program when it is called as a
48 credential helper; see linkgit:gitcredentials[7].
49
50 EXAMPLES
51 --------
52
53 The point of this helper is to reduce the number of times you must type
54 your username or password. For example:
55
56 ------------------------------------
57 $ git config credential.helper store
58 $ git push http://example.com/repo.git
59 Username: <type your username>
60 Password: <type your password>
61
62 [several days later]
63 $ git push http://example.com/repo.git
64 [your credentials are used automatically]
65 ------------------------------------
66
67 GIT
68 ---
69 Part of the linkgit:git[1] suite