RubyMine 2017.2 Help


File | Settings | Vagrant for Windows and Linux
RubyMine | Preferences | Vagrant for macOS

Use this page to:

  • Enable Vagrant support in RubyMine by specifying the Vagrant executable file.
  • Specify the location of the VagrantFile that determines creation of virtual boxes (instances) by provisioning predefined Vagrant base boxes through the vagrant up command.
  • Handle the list of Vagrant base boxes to use in creation of virtual boxes (instances).

Before you start working with Vagrant, make sure that:

  1. Vagrant is downloaded and installed.
  2. Before you start working with Vagrant, make sure that the Vagrant plugin is enabled. The plugin is bundled with RubyMine and is activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Vagrant executableSpecify the fully qualified address of the executable file: vagrant.bat for Windows, vagrant for Unix and macOS. Type the path manually, or click the browse button and locate the desired file in the Select vagrant executable dialog box.
Instance folderSpecify here the fully qualified path to the directory, where the task vagrant init has been executed, and the VagrantFile is initialized and stored.

Note that you can create an instance folder in any location, for example, in a project root. When a new remote interpreter is created, this project root location will be suggested by default as the instance folder.

A VagrantFile is a configuration file that defines the instance (virtual machine) you need. The file contains the virtual IP address, port mappings, and the memory size to assign. The file can specify which folders are shared and which third-party software should be installed. According to the VagrantFile your instance (virtual machine) is configured, provisioned against the relevant Vagrant base box, and deployed on your computer. A VagrantFile is created through the vagrant init command.

When creation of an instance (virtual machine) is invoked either through the vagrant up command or through the Tools | Vagrant | Up menu option, RubyMine looks for the VagrantFile in the directory specified in the Instance folder field. For more information, see

You can create a VagrantFile in any directory and appoint it as instance folder. If the field is empty, RubyMine will treat the project root as the instance folder and look for a VagrantFile in it.

ProviderUse this field to specify the provider to be used by vagrant up command. If this field is left blank, the default provider is used.
Environment variableClick the ellipsis button or press Shift+Enter to specify the shell variables to be used to configure the providers' behavior.
Boxes and Plugins tabs
BoxesThis list shows the predefined Vagrant base boxes available in RubyMine. Each item presents a Vagrant base box on which Vagrant configures and launches its instances (virtual machines). The entries of this list correspond to the output of the command vagrant box list.
/help/img/idea/2017.2/new.pngAlt+InsertClick this button to download a new base box. This command corresponds to vagrant box add <name> <URL>. By default, RubyMine suggests the URL to the lucid32 box
/help/img/idea/2017.2/delete.pngAlt+DeleteClick this button to remove the selected Vagrant base box. So doing, the box and the nested files are physically deleted from the disk. This command corresponds to vagrant box remove <name>
PluginsUse this table to view and change the list of available plugins.
/help/img/idea/2017.2/new.pngAlt+InsertClick this button to install a new Vagrant plugin.
/help/img/idea/2017.2/delete.pngAlt+DeleteClick this button to remove the selected plugin.
/help/img/idea/2017.2/update_icon.pngClick this button to update the selected plugin.
/help/img/idea/2017.2/attach_license.pngUse this button to attach a license to the selected plugin.
Last modified: 26 October 2017

See Also