| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 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 stores credentials indefinitely on disk for use by future |
| 23 | 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. Defaults to `~/.git-credentials`. |
| 38 | |
| 39 | EXAMPLES |
| 40 | -------- |
| 41 | |
| 42 | The point of this helper is to reduce the number of times you must type |
| 43 | your username or password. For example: |
| 44 | |
| 45 | ------------------------------------------ |
| 46 | $ git config credential.helper store |
| 47 | $ git push http://example.com/repo.git |
| 48 | Username: <type your username> |
| 49 | Password: <type your password> |
| 50 | |
| 51 | [several days later] |
| 52 | $ git push http://example.com/repo.git |
| 53 | [your credentials are used automatically] |
| 54 | ------------------------------------------ |
| 55 | |
| 56 | STORAGE FORMAT |
| 57 | -------------- |
| 58 | |
| 59 | The `.git-credentials` file is stored in plaintext. Each credential is |
| 60 | stored on its own line as a URL like: |
| 61 | |
| 62 | ------------------------------ |
| 63 | https://user:pass@example.com |
| 64 | ------------------------------ |
| 65 | |
| 66 | When git needs authentication for a particular URL context, |
| 67 | credential-store will consider that context a pattern to match against |
| 68 | each entry in the credentials file. If the protocol, hostname, and |
| 69 | username (if we already have one) match, then the password is returned |
| 70 | to git. See the discussion of configuration in linkgit:gitcredentials[7] |
| 71 | for more information. |
| 72 | |
| 73 | GIT |
| 74 | --- |
| 75 | Part of the linkgit:git[1] suite |
