S/FTP Connector

What is the S/FTP Connector?s

The SFTP connector can be used to connect to a SFTP service.

Here is an example to use the sftp.list command in a pipeline:

pipeline: - sftp.list: host: "some.sftpserver.tld" path: "/myfolder" secret: "sftp-secret"

Also see these commands:


In order to integrate an SFTP server into testing, you have multiple options:

  • A: Use an external SFTP server

  • B: Use an SFTP server installed locally (makes only sense in case PIPEFORCE can access your local system)

  • C: Use an SFTP server running as a service inside PIPEFORCE

Option C will be described below.

Go to Docker Hub and choose a lightweight SFTP container which fits your needs. For example atmoz/sftp.

Login to the PIPEFORCE portal, go to Services and click START SERVICE. Then, give the service a valid name and set the image name and port and finally click START:

Tip: As an alternative to this you can also use the command service.start to start and service.stop to stop a service.

The image will now be downloaded and installed automatically as service into PIPEFORCE:

After this you can access the service internally inside the PIPEFORCE cluster using its name. For example:

pipeline: - sftp.list: host: sftp-test port: 22 path: / username: foo password: pass

For security reasons the SFTP server cannot be accessed from the internet. Only PIPEFORCE services can use it internally by referring to the internal host name sftp-test in this example (or whatever name you have configured here).

Do not forget to stop the service after you do no longer need it.