summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorAndre Arko <andre@arko.net>2014-08-04 14:26:38 -0700
committerTim Moore <tmoore@incrementalism.net>2014-10-12 16:41:43 +1100
commit783af9b7571009fbd08e94bc26756f5b1c7739db (patch)
treee75b9658526d4fb00edb636c65db2b8511ce62f7 /man
parentc8c58671ae5ba58490dd83e5f721c489914bd64f (diff)
downloadbundler-783af9b7571009fbd08e94bc26756f5b1c7739db.tar.gz
Reword credential docs for consistency and spelling
Diffstat (limited to 'man')
-rw-r--r--man/bundle-config.ronn21
-rw-r--r--man/gemfile.5.ronn14
2 files changed, 21 insertions, 14 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
index f01144edfa..d158f5b02d 100644
--- a/man/bundle-config.ronn
+++ b/man/bundle-config.ronn
@@ -145,23 +145,26 @@ Finally, Bundler also ensures that the current revision in the
`Gemfile.lock` exists in the local git repository. By doing this, Bundler
forces you to fetch the latest changes in the remotes.
-## MIRRORS OF GEM REPOSITORIES
+## MIRRORS OF GEM SOURCES
Bundler supports overriding gem sources with mirrors. This allows you to
configure rubygems.org as the gem source in your Gemfile while still using your
mirror to fetch gems.
- bundle config mirror.http://rubygems.org http://rubygems-mirror.org
+ bundle config mirror.SOURCE_URL MIRROR_URL
+
+For example, to use a mirror of rubygems.org hosted at
-## CREDENTIALS FOR PRIVATE REPOSITORIES
+ bundle config mirror.http://rubygems.org http://rubygems-mirror.org
-Bundler allows you to configure credentials for private repositories on a per
-source basis.
+## CREDENTIALS FOR GEM SOURCES
- bundle config REMOTE_URI USERNAME:PASSWORD
+Bundler allows you to configure credentials for any gem source, which allows
+you to avoid putting secrets into your Gemfile.
-For example to use your company geminabox server you can call:
+ bundle config SOURCE_URL USERNAME:PASSWORD
- bundle config https://gems.example.com/ username:password
+For example, to save the credentials of user `claudette` for the gem source at
+`gems.longerous.com`, you would run:
-This way you can avoid putting secrets into your Gemfile.
+ bundle config https://gems.longerous.com/ claudette:s00pers3krit
diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn
index 6161b12e84..0187329730 100644
--- a/man/gemfile.5.ronn
+++ b/man/gemfile.5.ronn
@@ -26,18 +26,22 @@ 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
+### CREDENTIALS (#credentials)
-To access private repositories you can use `bundle config` to set user and
-password on a per source basis.
+Some gem sources require a username and password. Use `bundle config` to set
+the username and password for any sources that need it. The command must be run
+once on each computer that will install the Gemfile, but this keeps the
+credentials from being stored in plain text in version control.
bundle config https://gems.example.com/ user:password
-As alternative you can provide credentials directly in the source URI.
+For some sources, like a company Gemfury account, it may be easier to simply
+include the credentials in the Gemfile as part of the source URL.
source "https://user:password@gems.example.com"
-Credentials provided in the source URI will take presedence.
+Credentials in the source URL will take precedence over credentials set using
+`config`.
## RUBY (#ruby)