Deploy your files to a FTP server.
npm install grunt-ftp-push> Deploy your files to a FTP server
> Notice: Currently SFTP is not supported
~0.4.1If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
``shell`
npm install grunt-ftp-push --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-ftp-push');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
ftp_push: {
your_target: {
options: {
authKey: "serverA",
host: "sample.server.com",
dest: "/html/test/",
port: 21
},
files: [
{
expand: true,
cwd: '.',
src: [
".gitignore",
"package.json",
"README.md",
"test/**"
]
}
]
}
}
})
`$3
#### authKey
Type:
Default:
Required: falseName of authKey that will be used for your credentials to access the FTP server. This name should match the name of the credentials you want to use in the
file.#### host
Type:
String
Default:
Required: trueURL host of your FTP Server.
#### dest
Type:
Default:
Required: trueDestination of where you want your files pushed to, relative to the host.
#### port
Type:
Default:
Required: falsePort for accessing the FTP server.
#### username
Type:
Default:
Required: falseIf no authKey and .ftpauth file is provided, you can specify username here.
You also have the option of specifying the username in your run command. This is especially useful when
you have multiple users on your project, or you don't wish to store the credentials.
Gruntfile.js:
js
username: grunt.option('ftp-user') || 'anonymous',
`Command line:
shell
grunt --ftp-user=myUser
`#### password
Type:
Default:
Required: falseIf no authKey and .ftpauth file is provided, you can specify password here.
You also have the option of specifying the password in your run command. This is especially useful when
you have multiple users on your project, or you don't wish to store the credentials.
Gruntfile.js:
js
password: grunt.option('ftp-pass') || '@anonymous',
`Command line:
shell
grunt --ftp-pass=myPassWord1
`#### keepAlive
Type:
Default:
Required: falseDuration of JSFTP's keep alive to avoid session timeouts.
#### debug
Type:
Default:
Required: falseEnable debug mode for the JSFTP module to allow for verbose console messages.
#### incrementalUpdates
Type:
Default:
Required: falseAllows for files to be incrementally pushed based on their modified times.
#### hideCredentials
Type:
Default:
Required: falseDoes not show credentials in the console output. NOTE: debug mode runs jsftp in debug mode and this has no affect on that.
$3
#### Sample .ftpauth file
This file should be named
and be in the same directory as your Gruntfile.js. It is a JSON object with an "authKey" that has a username and password for it's value. Use the following as a guide for setting up your file.`js
{
"serverA":{
"username":"myUserName@gmail.com",
"password":"password123456"
},
"serverB":{
"username":"myOtherUsername@gmail.com",
"password":"12345Pass"
}
}
`#### Required Options
Currently the
and dest options are the only two required for this plugin to function correctly. If any of the required options are omitted, the plugin will abort with a warning informing you that you did not specify all the necessary requirements.#### Optional Options
In your options, you may choose not to set up an .ftpauth file and not have an authKey present in your options. You will probably then need to specify the username and password in the options object instead. If you don't, the plugin will attempt to use an anonymous login.
Specifying the username and password within the options object would look like the following:
`js
options: {
username: "myUsername",
password: "myPassword",
host: "sample.server.com",
dest: "/html/test/",
port: 21
}
`
#### Extras
You can now specify a destination inside your files objects like so:
js
{expand: true,cwd: 'test',src: ['*/']},
{expand: true,cwd: 'tasks',src: ['*/'], dest: 'test/' }
`
This will allow you to configure where you push your code in case you want to push to a diretory structure that is different from your local one. The dest here MUST be relative to the root destination.Dependencies
This plugin uses Sergi Mansilla's jsftp node.js module.Coming Soon
Adding in Unit Tests for my sanity
More Examples in the README to show different ways of using it
Possibly adding in support for SFTPContributing
Please add unit tests in the root of the test folder for any new or changed functionality and please try to make sure that