1. Stellarity Software Avatar Stellarity Software
  2. FTP Task
  3. FTP Task

Wiki

Clone wiki

FTP Task / Home

View History

FTP Task for Bamboo Documentation

Upload and download files from FTP/SFTP servers

1. Overview

With this addon (plugin) you can easily upload and download files from FTP/SFTP servers.

Features

  • Automatic retry in case of network errors
  • Ant pattern to include/exclude files to copy
  • FTP over SSL support (both FTPS and FTPES modes)
  • SFTP support
  • Bamboo variables substitution
  • Can be used in deployment plans

Compatibility

  • Version 1.2.x => Bamboo 8.0-9.x (DC only)
  • Version 1.1.x => Bamboo 6.0-9.5
  • Version 1.0.x => Bamboo 5.0-5.x

For download and purchasing details visit Atlassian Marketplace.

2. Installation

The Universal Plugin Manager (UPM) is a tool for administering apps in Atlassian applications. You can use the UPM to find and install, manage, and configure apps:

3. FTP Task Parameters

Each FTP Task has the following parameters:

  • FTP server URL
  • Username
  • Password
  • Include pattern
  • Exclude pattern
  • Subdirectory
  • Retry count
  • Retry delay

3.1. FTP server URL

This URL must be specified in the form protocol://hostname[:port]/path.

Supported protocols:

Protocol Description Default port
ftp File Transfer Protocol 21
ftpes File Transfer Protocol over SSL (explicit) 21
ftps File Transfer Protocol over SSL (implicit) 990
sftp SSH File Transfer Protocol 22

If the path doesn't exist FTP Upload Task will create it.

Examples:

  • ftp://server.com/artifacts/${bamboo.buildNumber}
  • ftpes://192.168.2.138:21/files

Note: you can use Bamboo variables in the URL.

3.2. Clean up remote directory before upload

If this option is on then remote directory contents will be removed before upload. Default value is off.

3.3 Authentication type

Select password or private key authentication methods.

3.4. Use shared credentials

This option controls whether to use shared credentials or specify credentials in the task.

3.5. Username

This is a username for accessing the server. Leave it empty for anonymous access.

3.6. Shared credentials

Select shared credentials to use. You can manage them on Bamboo administration page.

3.7. Password

This is a password for accessing the server. Passwords are stored in Bamboo encrypted.

3.8. Include pattern

This is a comma separated list of files to be copied (you can use Ant style patterns). Leave it empty to copy everything.

Examples:

  • **/*.zip,**/*.7z
  • **/*release*

3.9. Exclude pattern

This is a comma separated list of files NOT to be copied (you can use Ant style patterns). Exclude pattern is applied after include pattern.

Examples:

  • **/.svn/

3.10. Subdirectory

By default the working directory is a plan directory. However it can be changed to any other relative directory. For example you can set it to the build output directory.

Examples:

  • bin/release

3.11. Retry count

Number of retry attempts before failing the task.

3.12. Retry delay

Delay between retry attempts, in seconds.

4. Release Notes

4.1. Version 1.2.x (for Bamboo 8.0-9.x DC only)

Version 1.2.0 (29 Mar 2024)

  • Fix: Compatibility with Bamboo DC 9.6
  • Fix: Eager user/password autocomplete from browser
  • Fix: Specifying username for SFTP with key authentication
  • Enh: Update jsch to support SFTP with rsa-sha2-256 and rsa-sha2-512 algorithms
  • Enh: Drop Bamboo Server support (only DC now)
  • Enh: Update dependencies

4.2. Version 1.1.x (for Bamboo 6.0-9.5)

Version 1.1.4 (07 Oct 2023)

  • Enh: Update dependencies

Version 1.1.3 (04 Nov 2023)

  • Enh: Add data center compatibility and pass the approval process

Version 1.1.2 (06 May 2022)

  • New: INCOMING DATA CENTER APPROVAL
  • Enh: Update dependencies

Version 1.1.1 (14 Feb 2020)

  • New #11: SSH key authentication for SFTP

Version 1.1.0 (03 Jun 2018)

  • New #10: Shared credentials support

4.3. Version 1.0.x (for Bamboo 5.0-5.x)

Version 1.0.6 (25 Dec 2017)

  • Fix #9: There is no password field on Bamboo 6.3

Version 1.0.5 (13 Nov 2017)

  • Fix #8: Compatibility with freeFTPd sftp server

Version 1.0.4 (05 Aug 2017)

  • New #7: Add option to clean up remote dir before upload

Version 1.0.3 (30 Oct 2016)

  • Fix #5: Use 'anonymous' user when the username field is empty

Version 1.0.2 (18 Sep 2016)

  • New #3: Add support for SFTP
  • New #4: Add progress indicator

Version 1.0.1 (04 Jun 2016)

  • Fix #1: ^ in ftp path causes error
  • Fix #2: Use UTF-8 encoding for filenames

Version 1.0.0 (03 Mar 2016)

  • Initial public release

5. Support

If you find a bug, have a feature request or have an idea how to improve this plugin please post it at the public bug tracker.

6. Contact

Feel free to contact us via email and visit our website.

Updated