gulp-fez-sftp
v1.0.1
Published
使用SFTP(SSH)上传文件到远程服务器
Downloads
27
Maintainers
Readme
gulp-fez-sftp
使用SFTP(SSH)上传文件到远程服务器
本插件基于
gulp-sftp
修改,修复了在新版gulp4.0-alpha.3
不能使用的问题。
Install
$ npm install --save-dev gulp-fez-sftp
Usage
var gulp = require('gulp');
var sftp = require('gulp-fez-sftp');
gulp.task('default', function () {
return gulp.src('src/*')
.pipe(sftp({
host: 'xxx.xxx.xxx.xxx',
user: 'user',
pass: 'password'
}));
});
API
sftp(options)
options.host
Required
Type: String
options.port
Type: Number
Default: 22
options.user
Type: String
Default: 'anonymous'
options.pass
Type: String
Default: null
If this option is not set, gulp-fez-sftp assumes the user is using private key authentication and will default to using keys at the following locations:
~/.ssh/id_dsa
and /.ssh/id_rsa
If you intend to use anonymous login, use the value '@anonymous'.
options.remotePath
Type: String
Default: '/'
The remote path to upload to. If this path does not yet exist, it will be created, as well as the child directories that house your files.
options.remotePlatform
Type: String
Default: 'unix'
The remote platform that you are uploading to. If your destination server is a Windows machine, use the value windows
.
options.key
type String
or Object
Default: null
A key file location. If an object, please use the format {location:'/path/to/file',passphrase:'secretphrase'}
options.passphrase
type String
Default: null
A passphrase for secret key authentication. Leave blank if your key does not need a passphrase.
options.keyContents
type String
Default: null
If you wish to pass the key directly through gulp, you can do so by setting it to options.keyContents.
options.auth
type String
Default: null
An identifier to access authentication information from .ftppass
see Authentication for more information.
options.authFile
type String
Default: .ftppass
A path relative to the project root to a JSON formatted file containing auth information.
options.timeout
type int
Default: Currently set by ssh2 as 10000
milliseconds.
An integer in milliseconds specifying how long to wait for a server response.
options.agent
type String
Default: null
Path to ssh-agent's UNIX socket for ssh-agent-based user authentication.
options.agentForward
type bool
Default: false
Set to true to use OpenSSH agent forwarding. Requires that options.agent
is configured.
options.callback
type function
Default: null
Callback function to be called once the SFTP connection is closed.
##Authentication
For better security, save authentication data in a json formatted file named .ftppass
(or to whatever value you set options.authFile to). Be sure to add this file to .gitignore. You do not typically want auth information stored in version control.
var gulp = require('gulp');
var sftp = require('gulp-fez-sftp');
gulp.task('default', function () {
return gulp.src('src/*')
.pipe(sftp({
host: 'website.com',
auth: 'keyMain'
}));
});
.ftppass
{
"keyMain": {
"user": "username1",
"pass": "password1"
},
"keyShort": "username1:password1",
"privateKey": {
"user": "username"
},
"privateKeyEncrypted": {
"user": "username",
"passphrase": "passphrase1"
},
"privateKeyCustom": {
"user": "username",
"passphrase": "passphrase1",
"keyLocation": "/full/path/to/key"
}
}