summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatti Schneider <hi@mattischneider.fr>2013-06-18 14:10:12 +0200
committerMatti Schneider <hi@mattischneider.fr>2013-06-18 14:10:12 +0200
commita5e4a2c5e5ea4ed9a43f73efde83b0e000759b08 (patch)
tree0caab0f040863c050e029e849b6b1c60ab006021
parent2c81045b533150e8963384a2e812f57e9bfde134 (diff)
downloadpuppet-vcsrepo-a5e4a2c5e5ea4ed9a43f73efde83b0e000759b08.tar.gz
puppet-vcsrepo-a5e4a2c5e5ea4ed9a43f73efde83b0e000759b08.tar.bz2
Improve Git SSH usage documentation
-rw-r--r--README.GIT.markdown12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.GIT.markdown b/README.GIT.markdown
index d6b8afe..846bdcc 100644
--- a/README.GIT.markdown
+++ b/README.GIT.markdown
@@ -76,9 +76,15 @@ Keep the repository at the latest revision (note: this will always overwrite loc
For sources that use SSH (eg, `username@server:...`)
----------------------------------------------------
-Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
-to ensure they are present. For more information, see the `require`
-metaparameter documentation[1].
+If your SSH key is associated with a user, simply fill the `user` parameter to use his keys.
+
+Example:
+
+ user => 'toto' # will use toto's $HOME/.ssh setup
+
+
+Otherwise, manage your SSH keys with Puppet and use `require` in your `vcsrepo` to ensure they are present.
+For more information, see the `require` metaparameter documentation[1].
More Examples
-------------