diff options
Diffstat (limited to 'v1.6/bundle_config.html')
| -rw-r--r-- | v1.6/bundle_config.html | 409 |
1 files changed, 0 insertions, 409 deletions
diff --git a/v1.6/bundle_config.html b/v1.6/bundle_config.html deleted file mode 100644 index b5b34c9b56..0000000000 --- a/v1.6/bundle_config.html +++ /dev/null @@ -1,409 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle config</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Retrieve or set a configuration value - </div> - <pre class="highlight plaintext">$ bundle config [NAME [VALUE]] [--local] [--global] [--delete]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--local</code>: Get/set local configuration - </p> - <p> - <code>--global</code>: Get/set global configuration - </p> - <p> - <code>--delete</code>: Delete <code>NAME</code> value - </p> - </div> - <div class='description'> - <p> - Retrieves or sets a configuration value. If only parameter is provided, - retrieve the value. If two parameters are provided, replace the existing - value with the newly provided one. - </p> - <p> - By default, setting a configuration value sets it for all projects on - the machine. - </p> - <p> - If a global setting is superceded by local configuration, this command - will show the current value, as well as any superceded values and where - they were specified. - </p> - </div> - </div> - <div class='bullet' id='config'> - <div class='description'> - Get your bundle configuration. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config</pre> - <div class='notes'> - Executing <code>bundle config</code> with no parameters will print a - list of all bundler configuration for the current bundle, and where - that configuration was set. - </div> - </div> - </div> - <div class='bullet' id='get'> - <div class='description'> - Get your bundle configuration for <code>NAME</code> variable. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config NAME</pre> - <div class='notes'> - Will print the value of that configuration setting for - <code>NAME</code>, and where it was set. Will print both local and - global configuration. - </div> - </div> - </div> - <div class='bullet' id='set'> - <div class='description'> - Set your bundle configuration for <code>NAME</code> variable to - <code>VALUE</code>. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config NAME VALUE</pre> - <div class='notes'> - Will set <code>NAME</code> to <code>VALUE</code> for all bundles - executed as the current user (i.e. global setting). The configuration - will be stored in <code>~/.bundle/config</code>. If <code>NAME</code> - already is set, <code>NAME</code> will be overridden and user will be - warned. - </div> - </div> - </div> - <div class='bullet' id='global'> - <div class='description'> - Set your bundle global/user configuration for <code>NAME</code> variable - to <code>VALUE</code>. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config --global NAME VALUE</pre> - <div class='notes'> - Works the same as the command above. - </div> - </div> - </div> - <div class='bullet' id='local'> - <div class='description'> - Set your bundle local configuration for <code>NAME</code> variable to - <code>VALUE</code>. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config --local NAME VALUE</pre> - <div class='notes'> - Works the same as the two command above but for the local application. - The configuration will be stored in <code>app/.bundle/config</code>. - </div> - </div> - </div> - <div class='bullet' id='delete'> - <div class='description'> - Delete the configuration for <code>NAME</code> in both local and global sources. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config --delete NAME</pre> - <div class='notes'> - Will delete the configuration for <code>NAME</code> variable in both local and global sources. Not compatible with --global or --local flag. - </div> - </div> - </div> - </div> - <h2>Build options</h2> - <div class='contents'> - <div class='bullet' id='build_options'> - <div class='description'> - <p> - You can use <code>bundle config</code> to give bundler the flags to - pass to the gem installer every time bundler tries to install a - particular gem. - </p> - <p> - A very common example, the <code>mysql</code> gem, requires Snow - Leopard users to pass configuration flags to <code>gem install</code> - to specify where to find the <code>mysql_config</code> executable. - </p> - <div class='how'> - <pre class="highlight plaintext">$ gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
</pre> - </div> - <p> - Since the specific location of that executable can change from machine - to machine, you can specify these flags on a per-machine basis. - </p> - <div class='how'> - <pre class="highlight plaintext">$ bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config</pre> - </div> - <p> - After running this command, every time bundler needs to install the - <code>mysql</code> gem, it will pass along the flags you specified. - </p> - </div> - </div> - </div> - <h2>Configuration keys</h2> - <div class='contents'> - <div class='bullet' id='configuration_keys'> - <div class='description'> - <p> - Configuration keys in bundler have two forms: the canonical form and - the environment variable form. - </p> - <p> - For instance, passing the <code>--without</code> flag to - <code>bundle install</code> prevents Bundler from installing - certain groups specified in the <code>Gemfile</code>. Bundler persists - this value in <code>app/.bundle/config</code> so that calls to - <code>Bundler.setup</code> do not try to find gems from the - <code>Gemfile</code> that you didn't install. Additionally, subsequent - calls to <code>bundle install</code> remember this setting and - skip those groups. - </p> - <p> - The canonical form of this configuration is <code>"without"</code>. To - convert the canonical form to the environment variable form, capitalize - it, and prepend <code>BUNDLE_</code>. The environment variable form of - <code>"without"</code> is <code>BUNDLE_WITHOUT</code>. - </p> - </div> - </div> - </div> - <h2>List of available keys</h2> - <div class='contents'> - <div class='bullet' id='available_keys'> - <div class='description'> - <p> - The following is a list of all configuration keys and their purpose. - You can learn more about their operation in - <code>bundle install</code>. - </p> - <ul> - <li> - <code>auto_install</code> (<code>1</code>): Setting auto_install config - to 1 or any other truthy value will enable automatic installing of gems - instead of raising an error. This behavior applies to the following - commands: <code>show</code>, <code>binstubs</code>, - <code>outdated</code>, <code>exec</code>, <code>open</code>, - <code>console</code>, <code>license</code>, <code>clean</code>. - </li> - <li> - <code>path</code> (<code>BUNDLE_PATH</code>): The location on disk - to install gems. Defaults to <code>$GEM_HOME</code> in development - and <code>vendor/bundle</code> when <code>--deployment</code> is used. - </li> - <li> - <code>frozen</code> (<code>BUNDLE_FROZEN</code>): Disallow changes to - the <code>Gemfile</code>. Defaults to <code>true</code> when - <code>--deployment</code> is used. - </li> - <li> - <code>without</code> (<code>BUNDLE_WITHOUT</code>): A - <code>:</code>-separated list of groups whose gems bundler should not - installer - </li> - <li> - <code>bin</code> (<code>BUNDLE_BIN</code>): Install executables from - gems in the bundle to the specified directory. Defaults to - <code>false</code>. - </li> - <li> - <code>gemfile</code> (<code>BUNDLE_GEMFILE</code>): The name of the - file that bundler should use as the <code>Gemfile</code>. This location - of this file also sets the root of the project, which is used to - resolve relative paths in the <code>Gemfile</code>, among other things. - By default, bundler will search up from the current working directory - until it finds a <code>Gemfile</code>. - </li> - </ul> - <p> - In general, you should set these settings per-application by using the - applicable flag to the <code>bundle install</code> command. - </p> - <p> - You can set them globally either via environment variables or - <code>bundle config</code>, whichever is preferable for your setup. If - you use both, environment variables will take preference over global - settings. - </p> - </div> - </div> - </div> - <h2>Local git repositories</h2> - <div class='contents'> - <div class='bullet' id='local_git_repos'> - <div class='description'> - <p> - 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: - </p> - <pre class="highlight plaintext">$ bundle config local.GEM_NAME /path/to/local/git/repository
</pre> - <p> - For example, in order to use a local Rack repository, a developer - could call: - </p> - <pre class="highlight plaintext">$ bundle config local.rack ~/Work/git/rack
</pre> - <p> - 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 <code>Gemfile.lock</code> 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. - </p> - <p> - Bundler does many checks to ensure a developer won't work with - invalid references. Particularly, we force a developer to specify a - branch in the <code>Gemfile</code> 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. - </p> - <p> - Finally, Bundler also ensures that the current revision in the - <code>Gemfile.lock</code> exists in the local git repository. By doing - this, Bundler forces you to fetch the latest changes in the remotes. - </p> - </div> - </div> - </div> - <h2>Gem Source Mirrors</h2> - <div class='contents'> - <div class='bullet' id='gem-source-mirrors'> - <div class='description'> - <p> - If your environment contains a local mirror of the rubygems.org server, - use the <code>mirror.URL</code> configuration option to supply the URL - of the mirror. At that point, Bundler will download gems and gemspecs - from that mirror instead of the source listed in the Gemfile. - </p> - <pre class="highlight plaintext">$ bundle config mirror.https://rubygems.org https://localgems.lan</pre> - </div> - </div> - </div> - </div> - <div id='sidebar'> - <h2>Would you like to</h2> - <ul> - <li><a href="/#getting-started">Get started</a></li> - <li><a href="/issues.html">Report a bug</a></li> - <li><a href="/v1.6/whats_new.html">See what's new</a></li> - <li><a href="/v1.6/man/bundle.1.html">Read documentation</a></li> - <li><a href="/#get-involved">Discuss and Contribute</a></li> - <li><a href="/v1.6/faq.html">View FAQs</a></li> - </ul> - <div class='shirts'> - <div class='content'> - <p> - Bundler is developed entirely by a team of volunteers. - <a href="http://www.gittip.com/bundler">Support their work</a> - and help make Bundler better for everyone. - </p> - <p> - <script data-gittip-username='bundler' src='//gttp.co/v1.js'></script> - <br> - <br> - </p> - </div> - </div> - <h2>Bundler Commands</h2> - <ul> - <li><a href="/v1.6/bundle_install.html">bundle install</a></li> - <li><a href="/v1.6/bundle_update.html">bundle update</a></li> - <div class='buttons'> - <a href="/v1.6/commands.html">View all commands</a> - </div> - </ul> - <h2>Help With</h2> - <ul> - <li><a href="/v1.6/gemfile.html">Gemfiles</a></li> - <li><a href="/v1.6/groups.html">Groups</a></li> - <li><a href="/v1.6/git.html">Gems from git</a></li> - <li><a href="/v1.6/bundler_setup.html">Bundler.setup</a></li> - <li><a href="/v1.6/deploying.html">Deploying</a></li> - <li><a href="/v1.6/bundler_sharing.html">Sharing</a></li> - <li><a href="/v1.6/updating_gems.html">Updating Gems</a></li> - <li><a href="/compatibility.html">Compatible versions</a></li> - </ul> - <h2>Use Bundler with</h2> - <ul> - <li><a href="/v1.6/rails3.html">Rails 3</a></li> - <li><a href="/v1.6/rails23.html">Rails 2.3</a></li> - <li><a href="/v1.6/sinatra.html">Sinatra</a></li> - <li><a href="/v1.6/rubygems.html">Rubygems</a></li> - <li><a href="/v1.6/rubymotion.html">RubyMotion</a></li> - </ul> - <div class='shirts'> - <div class='content'> - <a class="image" onclick="ga('send', 'devswag');" href="http://www.devswag.com/collections/bundler"><img src="/images/bundler-shirt.png" /> - </a> - - <p> - <a onclick="ga('send', 'devswag');" href="http://www.devswag.com/collections/bundler">Buy Bundler Shirts & Stickers!</a> - </p> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a class="current" href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> |