AppCode 2019.2 Help

Deployment


On this page, create, edit, and delete server access configurations and server groups that give you control over interaction between AppCode and servers. Anytime you are going to use a server, you need to define a server access configuration, no matter whether your server is on a remote host or on your computer. See Configuring Synchronization with a Web Server for details on working with server access configurations and Organizing Servers Into Groups for details on working with server groups.

Toolbar icons and context menu commands

Use the toolbar buttons and context menu commands to manage the list of configurations and server groups.

The left-hand pane shows a list of all the server access configurations and server groups available in AppCode. When you select an item, the right-hand pane shows the configuration details.

Item

Tooltip and shortcut

Description

Add button

Add

Insert (^N for macOS)

Click this button and select the desired item from the list to define a new configuration or server group.

Remove button

Delete ( for macOS)

Click this button to remove the selected configuration or server group from the list. Note that removing a server group also removes the contained servers.

icon_use_web_server_configuration_as_default

Use as Default

Click this button to have AppCode apply the settings of the selected configuration or server group by default during automatic upload of changed files.

Duplicate button

Duplicate

⌃D

Select this command from the context menu to duplicate the selected configuration or server group.

Rename

Shift+F6

Select this command from the context menu to rename the selected configuration or server group.

Connection tab

Use this tab to choose the way to access the Web server and specify the connection settings.

Item

Description

Name

The field shows the configuration name specified in the Add Server dialog box. Edit the configuration name, if necessary.

Visible only for this project

Use this checkbox to configure the visibility of the server access configuration or server group.

  • Select the checkbox to restrict the use of the configuration to the current project. Such configuration cannot be reused outside the current project. It does not appear in the list of available configurations in other projects. For example, if this checkbox is selected in an SFTP configuration, you cannot use its SSH credentials for configuring a remote interpreter.

  • When the checkbox is cleared, the configuration is visible in all AppCode projects. Its settings, including SSH credentials for SFTP servers, can be reused across several projects.

Access type

From this list, choose the way to access the server. Use the Up and Down keyboard keys to scroll through the list of server configuration types.

The available options are:

  • FTP: choose this option to have AppCode access the server via the FTP file transfer protocol.

  • SFTP: choose this option to have AppCode access the server via the SFTP file transfer protocol.

  • FTPS: choose this option to have AppCode access the server via the FTP file transfer protocol over SSL (the FTPS extension).

  • Local or mounted folder: choose this option if the Web server is running in a local or a mounted folder and its document root is NOT the parent of the project root.

  • In-place: choose this option if the Web server is running on your computer, your project is under its document root, and you do your development directly on the server.

Upload/Download Project Files

In this area, specify the settings for accessing the server to upload and download files to and from.

The set of controls in the area depends on the chosen server access type.

Item

Description

Available for

FTP/FTPS/SFTP host

In this field, specify the host name of the FTP/SFTP server to upload the files to.

FTP, FTPS, SFTP

Port

In this field, specify the port to use. The default values are:
  • 21 for FTP and FTPS

  • 22 for SFTP

FTP, FTPS, SFTP

Root Path

In this field, specify the server configuration root relative to the root folder on the server. This folder will be the highest one in the folder structure accessible through the current server configuration.

Do one of the following:

  • Accept the default / path, which points at the root folder on the server.

  • Type the path manually.

  • Click Browse button and select the desired folder in the Choose Root Path dialog that opens.

  • Click the Autodetect button and have AppCode detect the user home folder settings on the FTP/SFTP server and set up the root path according to them. The button is only enabled when you have specified your credentials.

FTP, FTPS, SFTP

Autodetect

Click this button to have AppCode detect the user home folder settings on the FTP/SFTP server and set up the root path according to them.

FTP, FTPS, SFTP

User name

In this field, type your user name for authentication to the server.

FTP, FTPS, SFTP

Log in as anonymous

Select this checkbox to enable anonymous access to the server with your email address as password.

FTP, FTPS, SFTP

Password

In this field, type your password for authentication to the server.

FTP, FTPS, SFTP

Save password

Select this checkbox to have AppCode remember the specified password.

FTP, FTPS, SFTP

Advanced options

Expand this are to specify additional uploading settings.

FTP, FTPS, SFTP

Web server root URL

In this field, specify the URL address of the Web server root folder.

Both the HTTP and the HTTPS protocols are supported.

All

Mappings tab

In this tab, configure 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. The project folder structure in this case will be repeated on the server, provided that you have selected the Create Empty directories checkbox in the Options dialog. For more details, see Configuring Synchronization with a Web Server and Customizing Upload/Download. Below are definitions of terms used in this topic in the context of of synchronization between AppCode and servers.

  • 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. You do your development, then copy the sources to the server.

  • A remote server is a server running on another computer (remote host). Files on the server are accessible via the FTP/SFTP/FTPS protocol.

  • The server configuration root is the highest folder in the file tree on the local or remote server accessible through the server configuration. For in-place servers, it is the project root.

  • A local file/folder is any file or folder under the project root.

  • A remote file/folder is any file or folder on the server.

Item

Description

Use this server as default

Click this button to have AppCode apply the settings of the selected configuration by default during automatic upload of changed files. This button is only enabled for the non-default servers; for the server used as default, this button is disabled.

Local Path

In this field, specify the full path to the desired local folder. In the simplest case it is the project root.

Type the path manually or click Browse the Browse button and select the desired location in the Choose Local Path dialog box that opens.

Deployment Path

In this field, specify the folder on the server where AppCode will upload the data from the folder specified in the Local Path field. Type the path to the folder relative to the server configuration root.

If the folder with the specified name does not exist yet, AppCode will create it, provided that you have selected the Create Empty directories checkbox in the Options dialog. For more details, see Customizing Upload/Download.

The field is not available for server configurations of the type In-place.

Web Path

In this field, 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 field.

Add another mapping

Click this button to have a new line added to the list of mappings.

Excluded Paths

Use this tab to configure a list of local and remote folders that you do not want to be involved in upload/download.

Item

Description

Add local path

Click this button to have an empty line added to the list and specify the location of the folder to be protected against upload/download. Type the path manually or click Browse the Browse button and choose the required folder in the dialog that opens.

Add deployment path

Click this button to have an empty line added to the list. Click Browse the Browse button. The Select remote excluded path dialog box that opens shows the data on the host accessed through the selected server configuration. Select the required folder.

Remove path

Click this button to remove the selected item from the list. The button is only available when a line is selected.

Last modified: 10 October 2019