Vagrant plugin that configures the virtual machine to use proxies
Ruby Awk
Latest commit c87058d Mar 9, 2016 @tmatilai Merge pull request #143 from mynamewastaken/mynamewastaken-set-window…
…s-system-proxy

Initial add of Windows system proxy settings

README.md

Proxy Configuration Plugin for Vagrant

Gem Version Build Status Dependency Status Code Climate Coverage Status

A Vagrant plugin that configures the virtual machine to use specified proxies. This is useful for example in case you are behind a corporate proxy server, or you have a caching proxy (for example polipo).

The plugin can set:

  • generic http_proxy etc. environment variables that many programs support
  • default proxy configuration for all Chef provisioners
  • proxy configuration for Apt
  • proxy configuration for Docker
  • proxy configuration for Git
  • proxy configuration for npm
  • proxy configuration for PEAR
  • proxy configuration for Subversion
  • proxy configuration for Yum
  • simple proxy configuration for Windows

Quick start

Install the plugin:

vagrant plugin install vagrant-proxyconf

To configure all possible software on all Vagrant VMs, add the following to $HOME/.vagrant.d/Vagrantfile (or to a project specific Vagrantfile):

Vagrant.configure("2") do |config|
  if Vagrant.has_plugin?("vagrant-proxyconf")
    config.proxy.http     = "http://192.168.0.2:3128/"
    config.proxy.https    = "http://192.168.0.2:3128/"
    config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
  end
  # ... other stuff
end

Compatibility

This plugin requires Vagrant 1.2 or newer (downloads).

The plugin is supposed to be compatible with all Vagrant providers and other plugins. Please file an issue if this is not the case. The following providers are confirmed to work: AWS, Digital Ocean, VirtualBox, VMware Fusion.

For the proxy configuration to take effect for vagrant-omnibus plugin, version 1.1.1 or newer of it should be used.

Usage

Install using standard Vagrant plugin installation method: vagrant plugin install vagrant-proxyconf. See the wiki for instructions to install a pre-release version.

The plugin hooks itself to all Vagrant commands triggering provisioning (e.g. vagrant up, vagrant provision, etc.). The proxy configurations are written just before provisioners are run.

Proxy settings can be configured in Vagrantfile. In the common case that you want to use the same configuration in all Vagrant machines, you can use $HOME/.vagrant.d/Vagrantfile or environment variables. Platform specific settings are only used on virtual machines that support them (i.e. Apt configuration on Debian based systems), so there is no harm using global configuration.

Project specific Vagrantfile overrides global settings. Environment variables override both.

It is a good practise to wrap plugin specific configuration with Vagrant.has_plugin? checks so the user's Vagrantfiles do not break if plugin is uninstalled or Vagrantfile shared with people not having the plugin installed. (For Vagrant 1.2 you have to use if defined?(VagrantPlugins::ProxyConf) instead.)

Default/global configuration

It's a common case that you want all possible connections to pass through the same proxy. This will set the default values for all other proxy configuration keys. It also sets default proxy configuration for all Chef Solo and Chef Client provisioners.

Many programs (wget, curl, yum, etc.) can be configured to use proxies with http_proxy or HTTP_PROXY etc. environment variables. This configuration will be written to /etc/profile.d/proxy.sh and /etc/environment on the guest.

Also sudo will be configured to preserve the variables. This requires that sudo in the VM is configured to support "sudoers.d", i.e. /etc/sudoers contains line #includedir /etc/sudoers.d.

Example Vagrantfile

Vagrant.configure("2") do |config|
  if Vagrant.has_plugin?("vagrant-proxyconf")
    config.proxy.http     = "http://192.168.0.2:3128/"
    config.proxy.https    = "http://192.168.0.2:3128/"
    config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
  end
  # ... other stuff
end

Configuration keys

  • config.proxy.http - The proxy for HTTP URIs
  • config.proxy.https - The proxy for HTTPS URIs
  • config.proxy.ftp - The proxy for FTP URIs
  • config.proxy.no_proxy - A comma separated list of hosts or domains which do not use proxies.

Possible values

  • If all keys are unset or nil, no configuration is written.
  • A proxy should be specified in the form of http://[user:pass@]host:port.
  • Empty string ("") or false in any setting also force the configuration files to be written, but without configuration for that key. Can be used to clear the old configuration and/or override a global setting.

Environment variables

  • VAGRANT_HTTP_PROXY
  • VAGRANT_HTTPS_PROXY
  • VAGRANT_FTP_PROXY
  • VAGRANT_NO_PROXY

These also override the Vagrantfile configuration. To disable or remove the proxy use an empty value.

For example to spin up a VM, run:

VAGRANT_HTTP_PROXY="http://proxy.example.com:8080" vagrant up

Disabling the plugin

The plugin can be totally skipped by setting config.proxy.enabled to false or empty string (""). This can be useful to for example disable it for some provider. Specific applications can be skipped by setting config.proxy.enabled to a hash( like { svn: false }). This disabling keeps proxy configurations for applications on the guest. The configurations must be cleared before disabling if needed.

config.proxy.enabled         # => all applications enabled(default)
config.proxy.enabled = true  # => all applications enabled
config.proxy.enabled = { svn: false, docker: false }
                             # => specific applications disabled
config.proxy.enabled = ""    # => all applications disabled
config.proxy.enabled = false # => all applications disabled

Example Vagrantfile

Vagrant.configure("2") do |config|
  config.proxy.http = "http://192.168.0.2:3128/"

  config.vm.provider :my_cloud do |cloud, override|
    override.proxy.enabled = false
  end
  # ... other stuff
end

Configuration for applications

Configures applications to use proxy settings. The configurations will be written to configuration files for each application.

Configurable applications

Following applications can be configured. Configurations are based on default configuration(config.proxy.*) and can be overridden except SVN. SVN configuration is not set if no SVN specific configuration.

Application Base conf. Specific conf. Env. var.
configure_apt_proxy config.proxy.* config.apt_proxy.* VAGRANT_APT_*
configure_git_proxy N/A config.git_proxy.* VAGRANT_GIT_*
configure_svn_proxy N/A config.svn_proxy.* VAGRANT_SVN_*
configure_yum_proxy config.proxy.* config.yum_proxy.* VAGRANT_YUM_*

Example Vagrantfile

Vagrant.configure("2") do |config|
  config.proxy.http     = "http://192.168.0.2:3128/"
  config.proxy.https    = "http://192.168.0.2:3128/"
  config.proxy.no_proxy = "localhost,127.0.0.1,.example.com"
  config.apt_proxy.http = "http://192.168.33.1:3142"
  config.apt_proxy.https = "DIRECT"
  # ... other stuff
end

Environment variables

These also override the Vagrantfile configuration. To disable or remove the proxy use "DIRECT" or an empty value.

For example to spin up a VM, run:

VAGRANT_APT_HTTP_PROXY="http://proxy.example.com:8080" vagrant up

Related plugins and projects

  • apt-cacher-box
    a Vagrant setup for apt-cacher-ng.
  • polipo-box
    a Vagrant setup for polipo caching web proxy.
  • vagrant-cachier
    An excellent Vagrant plugin that shares various cache directories among similar VM instances. Should work fine together with vagrant-proxyconf.