On this page:
- Setting common upload/download options
- Specifying additional protocol-specific customization options for FTP/SFTP/FTPS servers
In addition to the mandatory settings that ensure successful upload and download in various project - server set-ups, you can choose additional options to customize interaction with the server. Most of these options apply to all types of server access configuration. For FTP/FTPS/SFTP server configurations, you can specify additional protocol-specific options.
Setting common upload/download options
Open the Options dialog box by doing one of the following:
- On the main menu, choose .
- Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing for Windows and Linux or for macOS. Expand the Build, Execution, Deployment node, and then click Options under Deployment.
In the Options dialog box that opens, specify additional settings:
To have PyCharm skip specific files or entire folders during upload/download, in the Exclude items by name text box,
specify the patterns that define the names of these files and folders.
Use semicolons as delimiters. Wildcards are welcome.
The exclusion is applied recursively. This means that if a matching folder has subfolders, the contents of these subfolders are not deployed either.For more details about excluding files and folders from upload/download, see Excluding Files and Folders from Upload/Download.
- Specify the details of the upload/download procedure by selecting or clearing the corresponding check boxes.
- To have PyCharm skip specific files or entire folders during upload/download, in the Exclude items by name text box, specify the patterns that define the names of these files and folders. Use semicolons as delimiters. Wildcards are welcome.
Specifying additional protocol-specific customization options for FTP/SFTP/FTPS servers
Open the Deployment dialog box by doing one of the following:
- Choose on the main menu.
- 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.
In the Deployment dialog box,
click the Advanced Options button and specify additional uploading settings
in the Advanced Options dialog box that opens:
- To set the client to the passive mode, select the Passive mode check box. In this mode, the client on your machine connects to the server to inform about being in the passive mode, receives the port number to listen to, and established data connection through the port with the received number. This mode is helpful when your machine is behind a firewall.
To have the hidden files and directories (those with names that start with a dot
.) shown in the Server Browser Tool Window, select the Show Hidden Files check box.
Select the Compatibility mode check box
to ensure compatibility in child file naming with your FTP server.
Selecting this option may slow down synchronization with the server.
Invalid descendant file name <file name>
Use the Retrieve accurate files timestamps drop-down list
to specify the MDTM FTP command calling policy
to retrieve the last-modified time of a given file on the remote host. The available options are:
- Always - select this option to have MDTM called for every file shown in the Remote Host tool window.
On copy - select this option to have MDTM called in the following cases:
- To check whether a file is up to date when the Overwrite up-to-date files check box in the Options dialog box is cleared.
- To preserve the actual time stamp of a file during download.
- Never - select this option to suppress calling MDTM.
- Select the Limit concurrent connections check box to have PyCharm restrict the number of connections to be supported simultaneously and specify the maximum number of allowed connections in the text box.
- In the Control encoding text box, specify the encoding that matches the encoding used by your server. Accept the default value if you are not sure that it supports UTF-8 encoding.
Select the Always use LIST command check box
to use the standard
LISTcommand for listing instead of the
MLSDcommand. This lets you avoid problems, for example, failure during upload with the Invalid descendent file name exception if the FTP server supports
- In the Send keep alive message each text box, specify how often you want PyCharm to send commands to the server to reset the timeout and thus preserve the connection.
- From the Use keep alive command drop-down list, choose the commands to be sent to the server to reset the timeout and thus preserve the connection.
- On some SFTP servers, the SSH banner may be enabled. Every time a connection is established, a pop-up window with an information message may be shown and to continue you would need to click OK.