summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThe Bundler Bot <bot@bundler.io>2017-02-18 09:54:54 +0000
committerThe Bundler Bot <bot@bundler.io>2017-02-18 09:54:54 +0000
commitf23034bf4c48a69fd2250cd7717eeedb4ac85216 (patch)
treebd55fd5321364ca72223d6d38325fed5d2f375c0
parent14bfe7a9321b319abd24bfe6dfbb128d71e26e79 (diff)
parentac9c12285c22a5639b36295e32d2cce2a6263669 (diff)
downloadbundler-f23034bf4c48a69fd2250cd7717eeedb4ac85216.tar.gz
Auto merge of #5417 - seban:document-mirror-fallback-timeout-option, r=segiddins
Add documentation for mirror.fallback_timeout option. As suggested in https://github.com/bundler/bundler/pull/5403#issuecomment-278384552 instead of changing parsing `mirror.fallback_timeout` I added documentation for it. Pull request https://github.com/bundler/bundler/pull/5403 can be closed.
-rw-r--r--man/bundle-config.ronn15
1 files changed, 14 insertions, 1 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
index a77ee331d4..fbfe9c971b 100644
--- a/man/bundle-config.ronn
+++ b/man/bundle-config.ronn
@@ -268,10 +268,23 @@ mirror to fetch gems.
bundle config mirror.SOURCE_URL MIRROR_URL
-For example, to use a mirror of rubygems.org hosted at
+For example, to use a mirror of rubygems.org hosted at rubygems-mirror.org:
bundle config mirror.http://rubygems.org http://rubygems-mirror.org
+Each mirror also provides a fallback timeout setting. If the mirror does not
+respond within the fallback timeout, Bundler will try to use the original
+server instead of the mirror.
+
+ bundle config mirror.SOURCE_URL.fallback_timeout TIMEOUT
+
+For example, to fall back to rubygems.org after 3 seconds:
+
+ bundle config mirror.https://rubygems.org.fallback_timeout 3
+
+The default fallback timeout is 0.1 seconds, but the setting can currently
+only accept whole seconds (for example, 1, 15, or 30).
+
## CREDENTIALS FOR GEM SOURCES
Bundler allows you to configure credentials for any gem source, which allows