Deployer plugin

General Info

Description

Enables TeamCity to upload artifacts to external locations in a number of ways.

Installation

Follow the TeamCity documentation on installing additional plugins.

Usage

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

Refer to TeamCity documentation for details.

SMB Deployer

Allows to upload files to Windows shares via SMB protocol. Configuration includes 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 TeamCity Agent startup properties (see this documentation page for details).

FTP Deployer - upload files to FTP servers.

Allows to upload files to FTP server.
Target host should point to an FTP server (by hostname or IP address) and remote directory (relative to 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 force ASCII or Binary FTP transfer modes (if automatically detected mode leads to broken files transfer)

SSH Deployer

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

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

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

Authentication method allows to choose SSH authentication method.

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

SSH Exec

Allows to execute arbitrary remote commands using SSH

Target should point to an SSH server.

Authentication method allows to choose SSH authentication method.

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

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

Tomcat Deployer

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

Compatibility

TeamCity 7.0+
Oracle JDK 1.6 or OpenJDK 1.7.0_07 and later.

Sources

https://bitbucket.org/nskvortsov/deployer/src

Issue tracker

https://bitbucket.org/nskvortsov/deployer/issues

Continuous Integration

Current build status is
Detailed CI status page

Download

Latest release: deploy-runner.zip