summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Arnold <me@seanarnold.co.nz>2016-11-15 18:08:01 +1300
committerThe Bundler Bot <bot@bundler.io>2016-11-15 05:34:14 +0000
commitf4e8a379e81b8b923283da6c0c31e6a0485c3a2c (patch)
treef8fdc465dd62dac50c331652e9765dcf6b92867d
parentaa9414e78f527ee2066d21783abb7d52a55f68a9 (diff)
downloadbundler-f4e8a379e81b8b923283da6c0c31e6a0485c3a2c.tar.gz
Add documentation around git HTTP(S) credentials configuration.
Closes: #5173 Approved by: indirect
-rw-r--r--man/bundle-config.ronn14
1 files changed, 14 insertions, 0 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
index dc701c584f..5f10aaa658 100644
--- a/man/bundle-config.ronn
+++ b/man/bundle-config.ronn
@@ -223,3 +223,17 @@ For example, to save the credentials of user `claudette` for the gem source at
Or you can set the credentials as an environment variable like this:
export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
+
+For gems with a git source with HTTP(S) URL you can specify credentials like so:
+
+ bundle config https://github.com/bundler/bundler.git username:password
+
+Or you can set the credentials as an environment variable like so:
+
+ export BUNDLE_GITHUB__COM=username:password
+
+This is especially useful for private repositories on hosts such as Github,
+where you can use personal OAuth tokens:
+
+ export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic
+