Skip to content

gaskaj/node-red-contrib-ftp-sftp

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-red-contrib-ftp-sftp

A Node-RED node to FTP and SFTP Client. Please log issues in the repo for assistance. (https://github.com/HardingPoint/node-red-contrib-ftp-sftp)

Install

Run the following command in the root directory of your Node-RED install

npm install node-red-contrib-ftp-sftp

Configuration

process.env.SFTP_SSH_KEY_FILE - If you want to use private SSH key set this environment variable

SFTP & FTP

PUT - Set msg.payload.filedata to the file contents you want pushed and will be uploaded to {GUID}.FileExtension. If you need more changes file request to github.

GET - Set msg.payload.filename to get the file or will use Workdir + Filename in configuration. Leave configuration blank to set in code.

DELETE - Set msg.payload.filename to delete the file or will use Workdir + Filename in configuration. Leave configuration blank to set in code.

LIST - Uses the workdir

Sample Function Node

// ----------------------------------------------------
//      All functions above use information.
//      Sample Javascript Used In Function Node
// ----------------------------------------------------
msg.payload = {};
msg.payload.filename="./SAMPLE_FILE.txt"; // Full Path
msg.payload.filedata='{}'; // Needs to be a string
return msg;
// ----------------------------------------------------

Acknowledgements

The node-red-contrib-force uses the following open source software:

  • node-ftp-sftp: node-ftp is an FTP and SFTP client module for node.js that provides an asynchronous interface for communicating with an FTP and SFTP servers.

License

See license (Apache License Version 2.0).

Packages

No packages published

Languages

  • JavaScript 51.3%
  • HTML 48.7%