File: bundle-config.ronn

package info (click to toggle)
bundler 1.13.6-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 3,096 kB
  • sloc: ruby: 40,688; sh: 34; makefile: 18
file content (225 lines) | stat: -rw-r--r-- 10,062 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
bundle-config(1) -- Set bundler configuration options
=====================================================

## SYNOPSIS

`bundle config` [<name> [<value>]]

## DESCRIPTION

This command allows you to interact with bundler's configuration system.
Bundler retrieves its configuration from the local application (`app/.bundle/config`),
environment variables, and the user's 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 Bundler's context. If used, you might add
  this directory to your environment's `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]
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 didn't install. Additionally,
subsequent calls to [bundle install(1)][bundle-install] 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].

* `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 <code>bundle package</code>, 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] or [bundle package(1)][bundle-package] 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 won't 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"