FTP Task for Bamboo Documentation

Upload and download files from FTP servers

1. Overview

With this addon (plugin) you can easily upload and download files from FTP 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.0.x => Bamboo 5.0-5.x
• Version 1.1.x => Bamboo 6.0-8.x

For download and purchasing details visit Atlassian Marketplace.

2. Installation

1. Log into your Bamboo instance as an admin.
2. Click the admin dropdown and choose Add-ons. The Manage add-ons screen loads.
3. Click Find new add-ons from the left-hand side of the page.
4. Locate FTP Task via search. The appropriate add-on version appears in the search results.
5. Click Try free to begin a new trial or Buy now to purchase a license for FTP Task. You're prompted to log into MyAtlassian. FTP Task begins to download.
6. Enter your information and click Generate license when redirected to MyAtlassian.
7. Click Apply license. If you're using an older version of UPM, you can copy and paste the license into your Bamboo instance.

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:

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. Use shared credentials (since version 1.1.0)

This option controls whether to use shared credentials or specify credentials in the task. Shared credentials (username and password) can be configured on Bamboo administration page in Shared credentials section.

3.4. Shared credentials (since version 1.1.0)

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

3.5. Username

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

3.6. Password

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

3.7. 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.8. 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.9. 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.10. Retry count

Number of retry attempts before failing the task.

3.11. Retry delay

Delay between retry attempts, in seconds.

4. Release Notes

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

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 support@stellaritysoftware.com and visit our website.