Child pages
  • Deployer plugin

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Follow the TeamCity documentation on installing additional plugins.

Usage

After successfull successful installation, new Build Runners will be available in the Build Steps Step selector of a build configuration.
Most of deployers use TeamCity artifact paths to define which files will be deployed. Artifacts paths has have the following syntax:

Code Block
file_name|directory_name|wildcard [ => target_directory|target_archive ]
Info
titlePlease note:

target_directory and target_archive are always treated as relative to a remote location specified in the Target parameter of the runner parameter.

Refer to the TeamCity documentation for details.

SMB Deployer

Allows to upload uploading files to Windows shares via the SMB protocol. Configuration The configuration includes a domain, username and password.
Target URL should point to a host + share at least. Subdirectories are allowed here and will be created if missing. Valid examples:

...

Implementation relies on JCIFS library. To configure JSCIFS client using system properties, update the TeamCity Agent startup properties (see this documentation page for details).

FTP Deployer

Allows to upload uploading files to an FTP server.
Target host should point to an FTP server (by hostname or IP address) and a remote directory (relative to the FTP user's home). To use absolute *nix path, use %2F as the forward slash. For example:

...

Authentication method is either Anonymous (will submit username "anonymous" and single space as password) or username/password (for custom credentials)
Transfer Mode allows to you force the ASCII or Binary FTP transfer modes (if the automatically detected mode leads to broken files transfer)

SSH Deployer

Allows to upload uploading files via SSH (using SCP or SFTP protocols)
Target should poing point to an SSH server location. Syntax The syntax is similar to the one used by the *nix scp command:

Code Block
{hostname|IP_address}[:targer_dir[/sub_path]]

where target_dir can be absolute or relative; sub_path can have any depth.

Transport allows to choose choosing a protocol to transfer data over SSH. Options are: SCP and SFTP

Authentication method allows to choose choosing an SSH authentication method.

  • "Default private key" - will try to do perform private key authentication using the ~/.ssh/config settings. If no settings file exists, will try to use the ~/.ssh/rsa_pub public key file. No passphrases should be set.
  • "Custom private key" - will try to do perform private key authentication using the given public key file with given passphrase
  • "Password" - simple password authentication.
SSH Exec

Allows to execute executing arbitrary remote commands using SSH

...

Authentication method allows to choose choosing an SSH authentication method.

  • "Default private key" - will try to do perform private key authentication using the ~/.ssh/config settings. If no settings file exists, will try to use the ~/.ssh/rsa_pub public key file. No passphrases should be set.
  • "Custom private key" - will try to do perform private key authentication using a given public key file with a given passphrase
  • "Password" - simple password authentication.

Commands is a new-line delimeted delimited set of commands , that will be executed in the remote shell. Remote The remote shell will be started in a the home directory of an authenticated user. Shell The shell output will be available in the TeamCity build log.

Tomcat Deployer

Deprecated, will be replaced in future versions.
Allows to deploy deploying WAR application archives to a remote Tomcat 6.x instance (requires Manager webapp installed in the target Tomcat server)

...