Child pages
  • Deployer plugin

Versions Compared

Key

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

The plugin is bundled since TeamCity 10.0. The recent version is described in the online documentation for the latest TeamCity version.

 

General Info

Vendor

Nikita Skvortsov

License

Apache 2.0

Type

open-source

Status

alfa beta

Download

Latest releaseLast stand-alone version: deploy-runner.zip

Description

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

...

Follow the TeamCity documentation on installing additional plugins.

Usage

After successful installation, new Build Runners will be available in the Build Step selector of a build configuration.
Most of deployers use TeamCity artifact paths to define which files will be deployed. Artifacts paths 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.

Refer to the TeamCity documentation for details.

SMB Deployer

Allows uploading files to Windows shares via the SMB protocol.
Implementation relies on the JCIFS library. To configure the JCIFS client using system properties, update the TeamCity Agent startup properties Configuring Build Agent Startup Properties.

Target URL should point to a host + share at least. Subdirectories are allowed here and will be created if missing. Valid examples:

Code Block

\\host\share_name
\\host\share_name\some\path
\\host\c$\Temp

Name resolution (advanced option) - allows to switch JCIFS to "DNS-only" mode. May fix perfomance or out of memory exceptions (see this bitbucket issue for details). Is equivalent to following JCIFS settings:

Code Block

-Djcifs.resolveOrder=DNS
-Djcifs.smb.client.dfs.disabled=true

...

Allows 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:

Code Block

ftp://hostname.com/
hostname.com:34445/subdir
127.0.0.1/%2Fetc/

...

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

Code Block

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

...

  • "Default private key" will try to 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 perform private key authentication using the given public key file with given passphrase
  • "Password" - simple password authentication.
  • "SSH-Agent" - use ssh-agent for authentication. To be used in combination with TeamCity SSH-Agent build feature. Available since 9.1
Note
titleLimited security note

Current secure connection implementation accepts any certificate provided by remote host. No trust checks are performed!

...

  • "Default private key" - will try to 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 perform private key authentication using a given public key file with a given passphrase
  • "Password" - simple password authentication.
  • "SSH-Agent" - use ssh-agent for authentication. To be used in combination with TeamCity SSH-Agent build feature. Available since 9.1
Note
titleLimited security note

Current secure connection implementation accepts any certificate provided by remote host. No trust checks are performed!

...

Requires Manager webapp installed in the target Tomcat instance and a user with the "manager-script" role.

Compatibility

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

...