PhpStorm 2016.1 Help

Run/Debug Configuration: PHP Built-in Web Server

Use this dialog box to configure running PHP applications on a local built-in Web server.

Click here for the description of the options that are common for all run/debug configurations.

The dialog box consists of the following areas:

Server Configuration

In this area, configure the access to the built-in Web server.

ItemDescription
Host In this text box, type localhost, because the built-in server is located on your machine.
Port Use this spin box to specify the number of the port where the built-in web server runs. The port number should be set to 1024 or higher. By default this port is set to the default PhpStorm port through which PhpStorm accepts connections from services (63342).
Document root In this text box, type the full path to the folder that will be considered server document root. This can be either the project root or any other folder under it. All the folders under the document root will be recursively submitted to the PHP interpreter.

The server document root folder will be accessed through HTTP at the above specified host:port. URL addresses for other pages of your applications will be composed based on this mapping.

Type the path manually or click the Browse button browseButton.png and choose the relevant folder in the dialog box, that opens.

Use router script Select this check box to have a PHP router script executed at every HTTP request start-up. The script is run for each HTTP request. If this script returns FALSE, the requested resource is returned as-is. Otherwise the script output is returned to the browser.

In the text box, specify the location of the script to run. Type the path manually or click the Browse button browseButton.png and choose the file in the dialog box, that opens.

Command Line

In this area, customize the behavior of the current PHP interpreter by specifying the options and arguments to be passed to the PHP executable file.

ItemDescription
Interpreter options In this text box, specify the options to be passed to the PHP executable file. They override the default behavior of the PHP interpreter and/or ensure that additional activities are performed.

If necessary, click shift-enter-button and type the desired options in the Command Line Options dialog box. Type each option on a new line. When you close the dialog box, they are all displayed in the Command line options text box with spaces as separators.

Custom working directory In this text box, specify the location of the files that are outside the folder with your sources and are referenced through relative paths. Type the path manually or click the Browse button browseButton and select the desired folder in the dialog that opens.
Environment variables In this field, specify the environment variables be passed to the built-in server. See Environment Variables in Apache for details.

Toolbar

ItemShortcutDescription
add Alt+Insert Click this button to add a new configuration to the list.
delete Alt+Delete Click this button to remove the selected configuration from the list.
copy Ctrl+D Click this button to create a copy of the selected configuration.
settings Edit defaultsClick this button to edit the default configuration templates. The defaults are used for newly created configurations.
arrowUp or arrowDown Alt+Up or Alt+Down Use these buttons to move the selected configuration or folder up and down in the list.

The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar.

sortAlphabetically Sort configurations Click this button to sort configurations in alphabetical order.

Common options

ItemDescription
NameIn this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.
Defaults This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.
Share Select this check box to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

This check box is not available when editing the run/debug configuration defaults.

Single instance onlyIf this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new run/debug configuration is launched, PhpStorm checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.

This makes sense when the usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.

If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.

Before launchSpecify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
ItemKeyboard shortcutDescription
add Alt+Insert Click this icon to add a task to the list. Select the task to be added:
  • Run External tool. Select this option to run an application which is external to PhpStorm. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in PhpStorm yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to run.

    This option is available only if you have already at least one run/debug configuration in the current project.

  • Run File Watchers. Select this option to have PhpStorm apply all the currently active file watchers, see Using File Watchers for details.
  • Generate CoffeeScript Source Maps. Select this option to have the source maps for your CoffeeScript sources generated. In the dialog that opens, specify where your CoffeeScript source files are located. For more information, see CoffeeScript Support.
  • Run Phing target: Add this task to execute the specified Phing target prior to running or debugging. To appoint a Phing target, click the Browse button browse and select the desired target in the Choose Phing Target to Execute dialog box, that opens.
  • Run Remote External tool: Add a remote SSH external tool. Refer to the section Remote SSH External Tools for details.
  • Upload files to Remote Host. Select this option to have the application files automatically uploaded to the server according to the default server access configuration. For more information, see Configuring Synchronization with a Web Server and Uploading and Downloading Files.
delete Alt+Delete Click this icon to remove the selected task from the list.
edit1 Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp Alt+Up Click this icon to move the selected task one line up in the list.
arrowDown Alt+Down Click this icon to move the selected task one line down in the list.
Show this page Select this check box to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.
Active tool windowSelect this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.

See Also

Last modified: 12 July 2016