bundle-config(1)
NAME
bundle-config - Set bundler configuration options
SYNOPSIS
bundle config [name [value]]
DESCRIPTION
This command allows you to interact with bundlers configuration system. Bundler retrieves its configuration from the local application (app/.bundle/config), environment variables, and the users home directory (~/.bundle/config), in that order of priority. Executing bundle config with no parameters will print a list of all bundler configuration for the current bundle, and where that configuration was set. Executing bundle config <name> will print the value of that configuration setting, and where it was set. Executing bundle config <name> <value> will set that configuration to the value specified for all bundles executed as the current user. The configuration will be stored in ~/.bundle/config. If name already is set, name will be overridden and user will be warned. Executing bundle config --global <name> <value> works the same as above. Executing bundle config --local <name> <value> will set that configuration to the local application. The configuration will be stored in app/.bundle/config. Executing bundle config --delete <name> will delete the configuration in both local and global sources. Not compatible with --global or --local flag. Executing bundle with the BUNDLE_IGNORE_CONFIG environment variable set will cause it to ignore all configuration. Executing bundle config disable_multisource true upgrades the warning about the Gemfile containing multiple primary sources to an error. Executing bundle config --delete disable_multisource downgrades this error to a warning.
REMEMBERING OPTIONS
Flags passed to bundle install or the Bundler runtime, such as --path
foo or --without production, are not remembered between commands. If
these options must be remembered,they must be set using bundle config
(e.g., bundle config path foo).
The options that can be configured are:
binstubs
Creates a directory (defaults to ~/bin) and place any
executables from the gem there. These executables run in
Bundlers context. If used, you might add this directory to your
environments PATH variable. For instance, if the rails gem
comes with a rails executable, this flag will create a bin/rails
executable that ensures that all referred dependencies will be
resolved using the bundled gems.
deployment
In deployment mode, Bundler will roll-out the bundle for
production use. Please check carefully if you want to have this
option enabled in development or test environments.
path The location to install the specified gems to. This defaults to
Rubygems setting. Bundler shares this location with Rubygems,
gem install ... will have gem installed there, too. Therefore,
gems installed without a --path ... setting will show up by
calling gem list. Accordingly, gems installed to other locations
will not get listed.
without
A space-separated list of groups referencing gems to skip during
installation.
BUILD OPTIONS
You can use bundle config to give bundler the flags to pass to the gem
installer every time bundler tries to install a particular gem.
A very common example, the mysql gem, requires Snow Leopard users to
pass configuration flags to gem install to specify where to find the
mysql_config executable.
gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
Since the specific location of that executable can change from machine
to machine, you can specify these flags on a per-machine basis.
bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
After running this command, every time bundler needs to install the
mysql gem, it will pass along the flags you specified.
CONFIGURATION KEYS
Configuration keys in bundler have two forms: the canonical form and the environment variable form. For instance, passing the --without flag to bundle install(1) bundle-install.1.html prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler persists this value in app/.bundle/config so that calls to Bundler.setup do not try to find gems from the Gemfile that you didnt install. Additionally, subsequent calls to bundle install(1) bundle-install.1.html remember this setting and skip those groups. The canonical form of this configuration is "without". To convert the canonical form to the environment variable form, capitalize it, and prepend BUNDLE_. The environment variable form of "without" is BUNDLE_WITHOUT. Any periods in the configuration keys must be replaced with two underscores when setting it via environment variables. The configuration key local.rack becomes the environment variable BUNDLE_LOCAL__RACK.
LIST OF AVAILABLE KEYS
The following is a list of all configuration keys and their purpose. You can learn more about their operation in bundle install(1) bundle-install.1.html. * path (BUNDLE_PATH): The location on disk where all gems in your bundle will be located regardless of $GEM_HOME or $GEM_PATH values. Bundle gems not found in this location will be installed by bundle install. Defaults to Gem.dir. When --deployment is used, defaults to vendor/bundle. * frozen (BUNDLE_FROZEN): Disallow changes to the Gemfile. Defaults to true when --deployment is used. * without (BUNDLE_WITHOUT): A :-separated list of groups whose gems bundler should not install * bin (BUNDLE_BIN): Install executables from gems in the bundle to the specified directory. Defaults to false. * gemfile (BUNDLE_GEMFILE): The name of the file that bundler should use as the Gemfile. This location of this file also sets the root of the project, which is used to resolve relative paths in the Gemfile, among other things. By default, bundler will search up from the current working directory until it finds a Gemfile. * ssl_ca_cert (BUNDLE_SSL_CA_CERT): Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format. * ssl_client_cert (BUNDLE_SSL_CLIENT_CERT): Path to a designated file containing a X.509 client certificate and key in PEM format. * cache_path (BUNDLE_CACHE_PATH): The directory that bundler will place cached gems in when running bundle package, and that bundler will look in when installing gems. * disable_multisource (BUNDLE_DISABLE_MULTISOURCE): When set, Gemfiles containing multiple sources will produce errors instead of warnings. Use bundle config --delete disable_multisource to unset. * ignore_messages (BUNDLE_IGNORE_MESSAGES): When set, no post install messages will be printed. To silence a single gem, use dot notation like ignore_messages.httparty true. * retry (BUNDLE_RETRY): The number of times to retry failed network requests. Defaults to 3. * redirect (BUNDLE_REDIRECT): The number of redirects allowed for network requests. Defaults to 5. * timeout (BUNDLE_TIMEOUT): The seconds allowed before timing out for network requests. Defaults to 10. In general, you should set these settings per-application by using the applicable flag to the bundle install(1) bundle-install.1.html or bundle package(1) bundle-package.1.html command. You can set them globally either via environment variables or bundle config, whichever is preferable for your setup. If you use both, environment variables will take preference over global settings.
LOCAL GIT REPOS
Bundler also allows you to work against a git repository locally
instead of using the remote version. This can be achieved by setting up
a local override:
bundle config local.GEM_NAME /path/to/local/git/repository
For example, in order to use a local Rack repository, a developer could
call:
bundle config local.rack ~/Work/git/rack
Now instead of checking out the remote git repository, the local
override will be used. Similar to a path source, every time the local
git repository change, changes will be automatically picked up by
Bundler. This means a commit in the local git repo will update the
revision in the Gemfile.lock to the local git repo revision. This
requires the same attention as git submodules. Before pushing to the
remote, you need to ensure the local override was pushed, otherwise you
may point to a commit that only exists in your local machine.
Bundler does many checks to ensure a developer wont work with invalid
references. Particularly, we force a developer to specify a branch in
the Gemfile in order to use this feature. If the branch specified in
the Gemfile and the current branch in the local git repository do not
match, Bundler will abort. This ensures that a developer is always
working against the correct branches, and prevents accidental locking
to a different branch.
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 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.SOURCE_URL MIRROR_URL
For example, to use a mirror of rubygems.org hosted at
bundle config mirror.http://rubygems.org http://rubygems-mirror.org
CREDENTIALS FOR GEM SOURCES
Bundler allows you to configure credentials for any gem source, which
allows you to avoid putting secrets into your Gemfile.
bundle config SOURCE_HOSTNAME USERNAME:PASSWORD
For example, to save the credentials of user claudette for the gem
source at gems.longerous.com, you would run:
bundle config gems.longerous.com claudette:s00pers3krit
Or you can set the credentials as an environment variable like this:
export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
December 2016 BUNDLE-CONFIG(1)
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
