Skip to content

Commit 177681a

Browse files
peffgitster
authored andcommitted
gitcredentials(7): make shell-snippet example more realistic
There's an example of using your own bit of shell to act as a credential helper, but it's not very realistic: - It's stupid to hand out your secret password to _every_ host. In the real world you'd use the config-matcher to limit it to a particular host. - We never provided a username. We can easily do that in another config option (you can do it in the helper, too, but this is much more readable). - We were sending the secret even for store/erase operations. This is OK because Git would just ignore it, but a real system would probably be unlocking a password store, which you wouldn't want to do more than necessary. Signed-off-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent dbe80f9 commit 177681a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Documentation/gitcredentials.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,9 @@ Here are some example specifications:
233233
helper = "/path/to/my/helper --with-arguments"
234234

235235
# or you can specify your own shell snippet
236-
[credential]
237-
helper = "!f() { echo \"password=$(cat $HOME/.secret)\"; }; f"
236+
[credential "https://example.com"]
237+
username = your_user
238+
helper = "!f() { test \"$1\" = get && echo \"password=$(cat $HOME/.secret)\"; }; f"
238239
----------------------------------------------------
239240

240241
Generally speaking, rule (3) above is the simplest for users to specify.

0 commit comments

Comments
 (0)