Configuring the SFTP artifact handler
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:
- Select Administration > Plans > Artifact handlers
- Enable the SFTP artifact handler for shared and non-shared artifacts by selecting the appropriate checkbox.
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 type The preferred method of authenticating with the SSH server:
Username and password — use shared credentials or provide a username and password.
- SSH private key — use shared credentials or upload an SSH key and provide a passphrase.
ユーザ名 The username on the remote host to use ホスト Host name or IP address of the SSH server. Remote path The path on the remote file system where Bamboo will store artifacts. 接続時にリモート ホスト フィンガープリントを確認 Enables strict host fingerprint verification when establishing an SSH connection. ホスト フィンガープリント The host fingerprint to use if strict host verification is on. ポート The port number used by the SSH server.
The default value is 22.
Package threshold The 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.
- Optionally, de-select the handlers you want to stop using.
- 保存 を選択します。
- 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.