Skip to content

Commit

Permalink
Update sftp.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksa-krolls authored Dec 7, 2024
1 parent eb5c48b commit e4aae80
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion adaptors/sftp.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ title: SFTP Adaptor

[SFTP (Secure File Transfer Protocol)](https://www.techtarget.com/searchcontentmanagement/definition/Secure-File-Transfer-Protocol-SSH-File-Transfer-Protocol) is a secure method for transferring files between systems over an encrypted SSH connection. It is widely used for securely uploading, downloading, and managing files on remote servers.

Using this adaptor, you can read and write files (e.g., `csv`, `xls`, `json` files) saved on a SFTP server.

## Integration Options

**Direct File Transfers:** SFTP allows users to manually or programmatically transfer files between a local and remote system. See [functions](/adaptors/packages/sftp-docs) for more on how to use this adaptor to work with an SFTP server.

## Authentication

When integrating with an SFTP server via OpenFn, **password authentication** is supported. See this adaptor's [Configuration docs](/adaptors/packages/sftp-configuration-schema) for more on the required authentication parameters.
When integrating with a SFTP server via OpenFn, you can provide a `username` and `password` for an authorized user to authenticate. See this adaptor's [Configuration docs](/adaptors/packages/sftp-configuration-schema) for more on the required authentication parameters.

See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

Expand Down

0 comments on commit e4aae80

Please sign in to comment.