Configuring the SFTP artifact handler

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

The SFTP artifact handler can store artifacts on a remote POSIX-compliant (Linux, Unix) SSH server, which helps reduce the load and disk usage on the Bamboo server and improve its performance. This works by allowing Bamboo agents to communicate with the SSH server directly, completely bypassing the Bamboo server during artifact publishing and retrieval.

Artifacts saved to a remote SSH server by the SFTP artifact handler are accessible directly on the SSH server or through the Bamboo interface. In the latter case, the Bamboo server acts as a proxy between the client browser and the SSH server.

Make sure that your SSH server supports the SFTP protocol extension. If you're using OpenSSH, SFTP is enabled by default, and no action is required.

Changing artifact handler configuration details requires Administrator permissions.

To enable and configure the SFTP artifact handler:

  1. Select Administration > Plans > Artifact handlers
  2. Enable the SFTP artifact handler for shared and non-shared artifacts by selecting the appropriate checkbox.
  3. Scroll down to the Handler-specific configuration section and configure the SFTP artifact handler.

    SFTP artifact handler settings...

    The following table describes the available SFTP artifact handler settings:

    Authentication typeThe preferred method of authenticating with the SSH server:
    UsernameThe username on the remote host to use
    HostHost name or IP address of the SSH server.
    Remote pathThe path on the remote file system where Bamboo will store artifacts.
    Verify remote host fingerprint on connectEnables strict host fingerprint verification when establishing an SSH connection.
    Host fingerprintThe host fingerprint to use if strict host verification is on.
    PortThe port number used by the SSH server.

    The default value is 22.

    Package thresholdThe maximum number of files per artifact.

    If the number of files in the artifact exceeds the package threshold, the artifact is automatically compressed into a ZIP archive to reduce resource overhead during upload and download. 

  4. Optionally, de-select the handlers you want to stop using.
  5. Select Save.
  6. If you want to test the connection to the SSH server, select Test connection.
    Bamboo will now attempt to create and immediately remove a file on the SSH server to verify that it's accessible and that file system permissions are set correctly.

Last modified on Nov 23, 2022

Was this helpful?

Provide feedback about this article
Powered by Confluence and Scroll Viewport.