Run/Debug Configuration: PHP Built-in Web Server

This feature is supported in the Ultimate edition only.

Use this dialog box to configure running PHP applications on a local built-in Web server. Note that this configuration is not intended for starting a debugging session. To debug an application running on the built-in server, start the application through this configuration and then connect to the running application as described in Zero-Configuration Debugging.

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 area
Command Line area
Toolbar
Common options

Server Configuration area

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

Item	Description
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 port on which the built-in web server runs. By default this port is set to the default IntelliJ IDEA port `63342` through which IntelliJ IDEA accepts connections from services. You can set the port number to any other value starting with 1024 and higher.
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 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 and choose the file in the dialog box, that opens.

Command Line area

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.

Item	Description
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 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 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

Item	Shortcut	Description
	`Alt+Insert`	Click this button to add a new configuration to the list.
	`Alt+Delete`	Click this button to remove the selected configuration from the list.
	`Ctrl+D`	Click this button to create a copy of the selected configuration.
	Edit defaults	Click this button to edit the default configuration templates. The defaults are used for newly created configurations.
or	`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.
	Move into new folder / Create new folder	Use this button to create a new folder. If one or more run/debug configurations are in focus, the selected run/debug configurations are automatically moved to the newly created folder. If only a category is in focus, an empty folder is created. Move run/debug configurations to a folder using drag-and-drop, or the buttons.
	Sort configurations	Click this button to sort configurations in alphabetical order.

Common options

Item Description

Name In 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.

Select this check box to make the run/debug configuration available to other team members.

If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.

If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.

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

Single instance only

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

Every time a new run/debug configuration is launched, IntelliJ IDEA 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 launch

Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.

Item	Keyboard shortcut	Description
	`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 IntelliJ IDEA. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools. Build Artifacts. Select this option to have an artifact or artifacts built. In the dialog that opens, select the artifact or artifacts that should be built. See also, Working with Artifacts. 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 Ant target. Select this option to have an Ant target run. In the dialog that opens, select the target to be run. For more information, see Ant. Run Grunt task. Select this option to run a Grunt task. In the Grunt task dialog box that opens, specify the `Gruntfile.js` where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the `grunt-cli` package. Run Gulp task. Select this option to run a Grunt task. In the Gulp task dialog box that opens, specify the `Gulpfile.js` where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the `gulp` package. Run npm Script. Select this check box to execute an npm script. In the NPM Script dialog box that opens, specify the `package.json` file where the required script is defined, select the script to execute, choose the command to apply to it, and specify the arguments to execute the script with. Specify the location of the Node.js interpreter and the parameters to pass to it. Compile TypeScript. Select this option to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors check box to configure the behaviour of the compiler in case any errors are detected: If the Check errors check box is selected, the compiler will show all the errors and the run configuration will not start. If the Check errors check box is cleared, the compiler will show all the detected errors but the run configuration still will be launched. 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 Maven Goal. Select this option to have a Maven goal run. In the dialog that opens, select the goal to be run. For more information, see Maven. 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.
	`Alt+Delete`	Click this icon to remove the selected task from the list.
	`Enter`	Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
	`Alt+Up`	Click this icon to move the selected task one line up in the list.
	`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 window		Select 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.

Procedures:

Reference:

Run Tool Window

Concepts:

Run/Debug Configuration

Last modified: 18 July 2017

IntelliJ IDEA 2017.1 Help