summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHarald Wartig <hwartig@gmail.com>2014-08-03 21:48:10 +0200
committerTim Moore <tmoore@incrementalism.net>2014-10-12 16:10:37 +1100
commit9100c39dcad1675c481a9f3eda6a2c1dd9754826 (patch)
tree0d0a30394bbac93b6c588c63021924d899deb4be
parentaa6d8cfba2e6ae9c14d72373d7c133b604332610 (diff)
downloadbundler-9100c39dcad1675c481a9f3eda6a2c1dd9754826.tar.gz
Document config for HTTPs source credentials
-rw-r--r--man/bundle-config.ronn12
-rw-r--r--man/gemfile.5.ronn13
2 files changed, 25 insertions, 0 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
index d6dfaf505c..f01144edfa 100644
--- a/man/bundle-config.ronn
+++ b/man/bundle-config.ronn
@@ -153,3 +153,15 @@ mirror to fetch gems.
bundle config mirror.http://rubygems.org http://rubygems-mirror.org
+## CREDENTIALS FOR PRIVATE REPOSITORIES
+
+Bundler allows you to configure credentials for private repositories on a per
+source basis.
+
+ bundle config REMOTE_URI USERNAME:PASSWORD
+
+For example to use your company geminabox server you can call:
+
+ bundle config https://gems.example.com/ username:password
+
+This way you can avoid putting secrets into your Gemfile.
diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn
index f94273af97..c01c0df9f7 100644
--- a/man/gemfile.5.ronn
+++ b/man/gemfile.5.ronn
@@ -33,6 +33,19 @@ be selected for gems that need to use a non-standard repository, suppressing
this warning, by using the [`:source` option](#SOURCE-source-) or a
[`source` block](#BLOCK-FORM-OF-SOURCE-GIT-PATH-GROUP-and-PLATFORMS).
+### PRIVATE REPOSITORIES
+
+To access private repositories you can use `bundle config` to set user and
+password on a per source basis.
+
+ bundle config https://gems.example.com/ user:password
+
+As alternative you can provide credentials directly in the source URI.
+
+ source "https://user:passowrd@gems.example.com"
+
+Credentials provided in the source URI will take presedence.
+
## RUBY (#ruby)
If your application requires a specific Ruby version or engine, specify your