WebStorm 8.0.0 Web Help

File | Settings | Vagrant

settings

Use this page to:

  • Enable Vagrant support in WebStorm 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).

Note

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 Vagrant plugin is enabled.

    The plugin is bundled with WebStorm and activated by default. If not, enable the plugin as described in Enabling and Disabling Plugins.

  3. The Vagrant plugin is enabled.

    The plugin is not bundled with WebStorm, but it is available from the WebStorm plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your WebStorm projects. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

Item Description
Vagrant executable Specify the fully qualified address of the executable file: vagrant.bat for Windows, vagrant for Unix and Mac OS. Type the path manually, or click the browse button and locate the desired file in the Select vagrant executable dialog box.
Instance folder Specify the fully qualified path to the directory where the VagrantFile is initialized and stored. 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, WebStorm looks for the VagrantFile in the directory specified in the Instance folder field. For more information, see http://docs.vagrantup.com/v2/vagrantfile/.

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

Provider Use 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 variable Click the ellipsis button or press Shift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift EnterShift EnterShift Enter to specify the shell variables to be used to configure the providers' behavior.
Boxes and Plugins tabs
Boxes This list shows the predefined Vagrant base boxes available in WebStorm. 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.
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this button to download a new base box. This command corresponds to vagrant box add <name> <URL>. By default, WebStorm suggests the URL to the lucid32 box
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click 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>
Plugins Use this table to view and change the list of available plugins.
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this button to install a new Vagrant plugin.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this button to remove the selected plugin.
update_icon Click this button to update the selected plugin.
attach_license Use this button to attach a license to the selected plugin.

See Also

Procedures:

External Links:

Web Resources: