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.
On this page:
- Creating a server configuration, specifying its name and type
- Specifying the server configuration root and the URL address to access it
- Example of specifying the server configuration root
- Mapping project folders with folders on the server and the URL addresses to access them
- Example of mapping project folders with folders on the server
Open the Deployment dialog box. Do one of the following:
- Open the project settings ( ), and then click 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.
- Click OK. The Add Server dialog box closes and you return to the Connection tab of the Deployment dialog box.
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 accessible 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>.
Example of specifying the 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 C:/ drive.
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 http://localhost:<port>.
You can establish a more complicated folder structure on the server, for example, to have MySite1 and 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 http://localhost:<port>\MySite2.
- 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 check box 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 C:\My_Projects\Mapping_project.
- In the Deployment Path text box, type Mapping_project.
- In the Web Path text box, type Mapping_project.