File | Settings | Vagrant
Use this page to:
- Enable Vagrant support in PhpStorm 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 Vagrant plugin is enabled.
The plugin is bundled with PhpStorm and activated by default. If it is not, enable the plugin.
|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.|
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 menu option, PhpStorm 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, PhpStorm will treat the project root as the instance folder and look for a VagrantFile in it.
|Vagrant Boxes||This list shows the predefined Vagrant base boxes available in PhpStorm. 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.|
|Click this button to download a new base box. This command corresponds to vagrant box add <name> <URL>. By default, PhpStorm suggests the URL to the lucid32 box|
|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>|