Creating a Local Server Configuration
A local server is a server that is running in a local or a mounted folder and whose document root is NOT the parent of the project root.
To configure access to the server in this set-up, you need to specify the following:
- The server configuration root folder and the URL address to access it.
- Correspondence between the project root folder, the folder on the server to copy the data from the project root folder to, and the URL address to access the copied data on the server. This correspondence is called mapping.
Creating a server configuration: specifying its name, type, and visibility
- Open the Deployment page by doing one of the following:
- Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing for Windows and Linux or for macOS, and click Deployment under Build, Execution, Deployment.
- Choose on the main menu.
- In the left-hand pane, that shows a list of all the existing server configurations, click the Add toolbar button . The Add Server dialog box opens.
- Specify the server configuration name in the Name text box. From the Type drop-down list, choose the server configuration type Local or mounted folder.
When editing the server configuration name in the Name text box, use the Up and Down keys on your keyboard to change the preselected server access to type in the Type drop-down list.
- Use the Visible only for this project checkbox to configure the visibility of the server access configuration (deployment configuration).
- Select the checkbox to restrict the use of the configuration to the current project. Such configurations cannot be reused outside the current project, they do not appear in the list of available configurations in other projects.
- When the checkbox is cleared, the configuration is visible in all PyCharm projects and the settings from, including SSH credentials, can be reused.
- Click OK. The Add Server dialog box closes and you return to the Connection tab of the Deployment node.
Click the Use as Default toolbar button to have PyCharm silently apply the current configuration in the following cases:
Specifying the server configuration root and the URL address to access it
- In the Folder text box of the Upload/download project files area, specify the server configuration root.
The server configuration root is the highest folder in the file tree on the server that can be accessed through the server configuration. The easiest way is to use the document root of your Web server as defined in the Web server configuration file. However you can appoint any other existing folder under the document root.
- In the Web server root URL text box of the Browse files on server area, specify the URL address of the server configuration root. This URL address will be the starting point for building the URL address of your application. Depending on your choice of the server configuration root, do one of the following:
- Type the URL address associated with the document root of your Web server as defined in the Web server configuration file.
- Type the URL address in the format
<URL of the server document root>/<path to the relevant folder relative to the server document root>.
To access a server through HTTPS, you need to acquire a certificate file
<certificate_name>.certsigned by a recognized authority and import this certificate in the truststore/keystore of the Oracle JRE (Java Runtime Environment) on which PyCharm runs. Note that self-signed certificates are rejected as unsafe.
To import a certificate in Oracle JRE:
- Open the embedded Terminal and type the following command: If you are using the Oracle JRE bundled with PyCharm, the default path to the truststore/keystore is
<jre_home>/bin/keytool.exe -importcert -keystore <path to jre truststore/keystore> -file <full_path_to_<cert_name>.cert>
Otherwise it is
- When asked to enter a password for the truststore/keystore, specify the default one
- Open the
PyCharm.exe.vmoptionsfile in the
<PyCharm_installation_folder>/binand add the following line to it:
-Djavax.net.ssl.keyStore=<path to keystore>
- Restart PyCharm.
Example of specifying a server configuration root
For example, the Apache httpd server configuration file is
httpd.conf, according to it, the default document root is the
htdocs folder, and the default URL address to access the data in it is
http://localhost. For the sake of simplicity, let's suppose that you are using the XAMPP package and it is installed in the root of the
So if you decide to copy your project files directly under the server document root, your server configuration root will be
C:\xampp\htdocs and its URL will be
You can establish a more complicated folder structure on the server, for example, to have
MySite2 folders under the server document root. In this case the you will have to decide which of these folders you will use in the current configuration, let it be
MySite2. Accordingly, the server configuration root will be
C:\xampp\htdocs\MySite2 and its URL address will be
Mapping project folders with folders on the server and the URL addresses to access themConfigure mappings, that is, set correspondence between the project folders, the folders on the server to copy project files to, and the URL addresses to access the copied data on the server. The easiest way is to map the entire project root folder to a folder on the server, whereupon the project folder structure will be repeated on the server, provided that you have selected the Create Empty directories checkbox in the Options dialog box. "For more details, see Customizing Upload/Download.
- Switch to the Mappings tab.
- In the Local Path text box, specify the full path to the desired folder in the project tree. In the simplest case it is the project root.
- In the Deployment Path text box, specify the folder on the server where PyCharm will upload the data from the folder specified in the Local Path text box. Type the path to the folder relative to the server configuration root. If the folder with the specified name does not exist yet, PyCharm will create it, provided that you have selected the Create Empty directories checkbox in the Options dialog box. For more details, see Customizing Upload/Download.
- In the Web Path text box, type the path to the folder on the server relative to the server configuration root. Actually, type the relative path you typed in the Deployment Path text box.
Example of mapping project folders with folders on the server
For example, if your project is
C:\My_Projects\Mapping_project, the server document root is
C:\xampp\htdocs, the server configuration root is
C:\xampp\htdocs\MySite2, and its URL address is
http://localhost:<port>\MySite2, fill in the fields as follows:
- In the Local Path text box, type
- In the Deployment Path text box, type
- In the Web Path text box, type