Publishing Content to SFTP Server
The SFTP connector facilitates publishing deliverable build outputs to the designated SFTP server.
Requirements
To publish content to a SFTP server, you must have the following:
- A running SFTP server that can be accessed by the application.
- An account that will allow you to connect to the SFPT server.
Define the Connector
To configure a SFTP connector, the following fields must be provided:
- Connector Name
- The name of the connector.
- Host Name
- The address of the server where files will be transferred to.
- Port Number
- The network port on which the SFTP server is listening.
- Username
- The username used to log into the SFTP server.
- Authentication
- The SFTP connector offers two authentication types, each with its corresponding
fields.
- Password Authentication - The following field will appear:
- Password
- The password used for authenticating the user.
- SSH Private Key Authentication- The following fields will appear:
- Private Key
- The private key used together with a server public key for authenticating the user.
- Passphrase
- Optional passphrase used for decrypting the private key.
- Password Authentication - The following field will appear:
When configuring the SFTP connector, an initial connection to the server will be
established, and you will receive a prompt to accept the Host Key fingerprint for the SFTP
server.
Important: Make sure you verify that the Host Key
fingerprint matches the one associated with your SFTP server. This verification ensures
that the output is correctly published to the intended SFTP server.
Select the SFPT Connector in the Deliverables Page
To publish the output of a deliverable to an SFTP server, follow these steps:
- After configuring the SFTP connector, navigate to the Deliverables page, then either edit an existing deliverable or create a new one.
- In the resulting configuration page, select the Upload output using a publishing connector option.
- Use the drop-down list below that option to select the SFTP connector that you previously defined.
- Specify the Destination Folder.Note: The Folder where build output files will be stored after the upload process.
- Specify the Temporary Folder.Note: The location where temporary files will be stored during the upload process. The Deliverable build process will upload the files inside the Temporary Folder. After completing the upload, the connector checks for the existence of the Destination Folder and follows one of these scenarios:
- If the Destination Folder does not exist, then the connector will rename the Temporary Folder to the Destination Folder.
- If the Destination Folder exists, then the connector will create a backup for the Destination Folder and then will move the contents from the Temporary Folder to the Destination Folder. If all operations are successful, the backup is deleted. Otherwise, the backup will be restored in the Destination Folder.
- Click Save at the bottom of the configuration page.
- Begin the Deliverable build process. Upon completion, the build output will be published to the configured SFTP server.