summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHarald Wartig <hwartig@gmail.com>2014-08-03 21:48:10 +0200
committerHarald Wartig <hwartig@gmail.com>2014-08-03 21:48:10 +0200
commitf8935b465ea39020356e79d7e934c86d48dac005 (patch)
treeee19b8edeec700a886f7ace13e82a08805f4754e
parent8559404e087034b444c331b3b21a24667ae75cbe (diff)
downloadbundler-f8935b465ea39020356e79d7e934c86d48dac005.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 9f5ac2c266..01b0d2e633 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 d8e95f1e1a..7b992365ba 100644
--- a/man/gemfile.5.ronn
+++ b/man/gemfile.5.ronn
@@ -26,6 +26,19 @@ might contain the gems listed in the `Gemfile`.
Each of these _source_s `MUST` be a valid Rubygems repository. Sources are
checked for gems following the heuristics described in [SOURCE PRIORITY][].
+### 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