https://github.com/runnerty/executor-ftp
Runnerty module: FTP executor
https://github.com/runnerty/executor-ftp
executor ftp ftp-client runnerty
Last synced: 11 months ago
JSON representation
Runnerty module: FTP executor
- Host: GitHub
- URL: https://github.com/runnerty/executor-ftp
- Owner: runnerty
- License: mit
- Created: 2018-04-13T10:59:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-10T04:31:22.000Z (over 3 years ago)
- Last Synced: 2024-04-25T07:02:42.675Z (about 2 years ago)
- Topics: executor, ftp, ftp-client, runnerty
- Language: JavaScript
- Size: 88.9 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Smart Processes Management
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]
# FTP executor for [Runnerty]:
### Installation:
```bash
npm i @runnerty/executor-ftp
```
### Configuration sample:
```json
{
"id": "ftp_default",
"type": "@runnerty-executor-ftp",
"host": "host.com",
"port": "21",
"user": "user",
"password": "1234"
}
```
```json
{
"id": "ftp_default",
"type": "@runnerty-executor-ftp",
"host": "host.com",
"port": "21",
"user": "user",
"privateKey": "/privateKeys/myPrivateKey.pem"
}
```
### Plan sample:
```json
{
"id": "ftp_default",
"command": "PUT",
"sourcePath": "./sample.txt",
"destinationPath": "/remote/sample_file.txt"
}
```
```json
{
"id": "ftp_default",
"command": "LIST",
"sourcePath": "./remoteDir/"
}
```
### Connection:
Connection config you will see [here](https://github.com/mscdex/ssh2#user-content-client-methods)
### Commands
* get: download a file.
* put: upload a file.
* mkdir: create a new directory.
* rmdir: remove the directory or file.
* delete: delete file.
* rename: rename sourcePath to destinationPath.
* chmod: modify rights to destinationPath file.
* list: retrieves a directory listing.
### Output (Process values):
* `PROCESS_EXEC_DATA_OUTPUT`: Response output data.
* `EXTRA_DATA`: It is possible to work with the parsed values of the response.
`LIST` command return a JSON with this properties:
```bash
type: // file type(-, d, l)
name: // file name
size: // file size
modifyTime: // file timestamp of modified time
accessTime: // file timestamp of access time
rights: {
user:
group:
other:
},
owner: // user ID
group: // group ID
```
[Runnerty]: http://www.runnerty.io
[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-ftp.svg
[npm-url]: https://www.npmjs.com/package/@runnerty/executor-ftp
[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-ftp.svg
[david-badge]: https://david-dm.org/runnerty/executor-ftp.svg
[david-badge-url]: https://david-dm.org/runnerty/executor-ftp
[config.json]: http://docs.runnerty.io/config/
[plan.json]: http://docs.runnerty.io/plan/