SFTP/SSH targets

The SFTP/SSH target in Buddy enables secure connections to a server using SFTP (Secure File Transfer Protocol) or SSH (Secure Shell). This allows both file transfers and task execution on a remote server while ensuring the highest level of security.

Adding new target

To add new target, navigate to the Targets tab where you'll find all the globally defined connections.

Image loading...

Click the New target button and select SFTP/SSH from the dropdown menu.

Image loading...

Configuring SFTP/SSH target

After selecting the SFTP/SSH option, a configuration form will open with the following fields:

  • Name - The target name generates a unique ID for identification, which can be manually edited to fit your workflow.
  • Scope - Specifies which pipelines have access to the target.
  • Proxy - You can add a proxy to the target to connect to the server through it or use it as a standard SFTP/SSH target.

Image loading...Formularz konfiguracji targetu SFTP/SSH

Authentication Credentials Source

The SFTP/SSH target offers various authentication methods, which you can select in the Authentication Credentials Source field:

  • Inline password - Login using a username and password.
  • Inline SSH key - Authentication using a manually entered SSH key.
  • SSH key from Assets - Selecting a key from the Assets section in Buddy.

Image loading...

  • Address & port - Enter the server address in the format. You can use a domain name (e.g., sftp.example.com) or an IP address (e.g., 192.168.1.1). If the server uses the default port, you can omit it.
  • Enter the server login credentials. A password is required only for username-based authentication. You can also use variables, e.g., ${SFTP_USER} and ${SFTP_PASSWORD}.
  • Private SSH Key i Passphrase - If using an SSH key, enter its content in the Private SSH Key field and, if required, the key's passphrase in the Passphrase field.

Image loading...

  • Target Path - Specify the target directory path on the server where operations will be performed. You can use variables, e.g., ${TARGET_PATH}.
  • Tags - Assign tags to the target.
Hint
Path set in the target configuration will be the default server path, however it can be overwritten in the action.

Proxy target

The SFTP/SSH target allows you to add a proxy, which can be used to connect to the server through an intermediary.

Click the + icon and select one of the options:

  • New SFTP/SSH target - Creates proxy as a SFTP/SSH target.
  • New inline proxy - Configures proxy directly in the current target.

Image loading...Proxy configuration options

A proxy can be configured using the same authentication methods as SFTP/SSH targets. It is worth noting that a target configured as a PROXY is a fully functional SFTP/SSH target. This means you can use it not only as an intermediary but also as a standard target for actions such as SSH connections or file transfers directly to the proxy server.

After configuring and saving the proxy, it will be assigned to your SFTP/SSH target. As shown in the screenshot, the proxy is located in the "Proxy" section of the target form and can be edited or removed at any time.

Image loading...

After filling in the required fields and testing the proxy, click Add this target to save the settings.

Last modified on Dec 19, 2024