Create an in-place server configuration

In an in-place server configuration, you are using a local web server, but unlike with the local server configuration, don't upload/download or synchronize files between the PyCharm project and the project folder in the server file structure. Instead, you open the project folder from the server document root directly in PyCharm, and thus do the development on the server directly.

To create an in-place server configuration in PyCharm, you only need to specify the web server URL mapped to the server document root and the URL path to your project.

1. Specify the name, type, and visibility of a server configuration

Press Ctrl+Alt+S to open settings and then select Build, Execution, Deployment | Deployment.
Alternatively, go to Tools | Deployment | Configuration in the main menu.
In the left-hand pane that lists all the existing server configurations, click Add and select In place in the popup menu.
In the Create new server dialog that opens, type the name of the server to create and click OK. The Create new server dialog closes and you return to the Connection tab of the Deployment node.
Click on the toolbar to mark the server as default.
Clear the Visible only for this project checkbox to enable reuse of this server access configuration in other projects.
The server configuration settings are stored in the .idea directory together with the project, which allows sharing them between team members through a VCS.

2. Specify the URL address of the server document root

In the Connection tab (Ctrl+Alt+S | Build, Execution, Deployment | Deployment), specify:

Web server URL: the URL address (hostname and (optionally) port) mapped to the server document root in the server configuration file. This is the base URL for your application's web address. Both HTTP and HTTPS are supported.
Examples:
- http://localhost:80
- http://localhost:80/MySite1 (if you choose to establish a more complicated folder structure under the server document root and use only one of the subfolders in the current configuration)
Click Browse in the right-hand corner of the field to open and check the provided web server URL.

3. Specify the URL path mapped to the project folder

In the Mappings tab (Ctrl+Alt+S | Build, Execution, Deployment | Deployment), specify:

Local path: the absolute path to the local project folder. PyCharm automatically fills out this field with the path to the currently opened project.
Web path: the URL path to the project folder specified in Local path. In most cases, it's the same as the folder name provided in the Local path field.
PyCharm appends Web path to the Web server URL specified in the Connection tab.

Now that you have the server configuration added, you can access the server's files and folders in the Remote Host tool window. Go to Tools | Deployment | Browse Remote Host in the main menu, and in the tool window that opens, select the configured server from the drop-down list.

Open the Remote Host tool window and select the server

Last modified: 08 October 2024