Giter Club home page Giter Club logo

grunt-webdav-sync's Introduction

grunt-webdav-sync

Synchronizes a local folder to a remote webdav folder

Getting Started

This plugin requires Grunt ~0.4.1

If 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:

npm install grunt-webdav-sync --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-webdav-sync');

The "webdav_sync" task

Overview

In your project's Gruntfile, add a section named webdav_sync to the data object passed into grunt.initConfig().

grunt.initConfig({
  webdav_sync: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.local_path

Type: String Default value: none

A local path pattern to load files from. the local_path is relative from the Gruntfile.js root. The files from local_path will be copied from the ** directory so if upload contains for example test.json and the remote_path is http://user:password@localhost:9001/path/to it will upload to http://user:password@localhost:9001/path/to/test.json.

options.remote_path

Type: String Default value: none

The server to upload the file to. This accepts all default URL's so you can add username, password or a port.

options.sendImmediately

Type: Boolean Default value: false

sendImmediately defaults to false, which means request will retry with a proper authentication header after receiving a 401 response from the server (which must contain a WWW-Authenticate header indicating the required authentication method). When setting it to true a basic authentication header is sent.

options.strictSSL

Type: Boolean Default value: false

If true, requires SSL certificates be valid. Note: to use your own certificate authority, you need to specify an agent that was created with that CA as an option.

Usage Examples

Default Options

In this example, the default options are used to copy files from a directory to a remote webdav server.

grunt.initConfig({
  webdav_sync: {
    default: {
        options: {
           local_path: 'test/assets/upload/**',
           remote_path: 'http://user:password@localhost:9001/path/to'
           sendImmediately: true,
           strictSSL: false
        }
    }
  },
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.2.10

  • Add support for grunt 1.0

0.2.9

  • Bugfix: fixes #18

0.2.8

  • Added configuration options to enforce digest authentication, and skip the validity check for SSL certificates

0.2.7

  • Removed the hardcoded extensions to detect binary files and added isbinaryfile lib to detect this.

0.2.6

  • Fix issue with binary encoded files.

0.2.5

  • Added digest authentication.
  • Added support for windows paths.
  • Fixed a bug with deleting non-existing folders.

grunt-webdav-sync's People

Contributors

jfix avatar mitchelkuijpers avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

grunt-webdav-sync's Issues

Sync issues with sub folders

Hi. Trying Grunt for the first time and need to sync folders on my local and a webdav server. single file uploads are working perfectly. When I try to sync folders and sub folders, according to webdav_sync.js (lines 178 to 197), deletes any subfolders if exists and creates a new one. I believe synchronization needs to check for folders/subfolders in the entire tree and then check for newer files. I have a big tree both on my local and the webdav server and I need to upload/overwrite only files with newer version. Is it possible to sync the folders like this ? Am I missing any configuration ?
(Hope this is the correct forum to ask this question. Let me know if otherwise)

Thanks,
Augustine

Create directories as needed

It would be nice if the plugin would not complain if a remote directory does not exist, but instead created needed directories like mkdirp does. If this is not possible due to access-right problems, an exception would be fine.

Support digest authentication

Hi,

first of all thanks for the plugin. I'm attempting to use a WebDAV server using the digest authentication method. The current version of the grunt-webdav-sync task doesn't seem to support this method, because I got the following error message when attempting the creation of a directory:

Resource requires authorization or authorization was denied. For url: http://abc:[email protected]:8887/test

File sync'ing didn't work even though there doesn't seem to be any useful message coming back from the server to indicate that there was a problem because the plugin returns:

Searching for files in: src/**
>> Found 1 files, Start uploading files to http://abc:abc@localhost:8887/

Done, without errors.
Completed in 0.786s at Sun Nov 03 2013 18:27:19 GMT+0100 (CET) - Waiting...
OK

When changing my WebDAV server's authentication method to basic, suddenly everything started working as expected.

I'm not an expert on how to add support for the digest authentication method, but it would be great if it existed. :-)

Thanks,
Jakob.

Latest version not in npm repository

Like the comment says, the latest code (including the fix for windows paths) is not pulled from the npm repository. Probably just need to bump the version number in package.json

Erroring on sync

Hey,
So we're getting a consistent error when we run our grunt sync task

Fatal error: Cannot read property 'statusCode' of undefined

Any ideas?

Best,
Steven

Grunt task fails when trying to target files only, not subfolders

Hi there,

I have a folder which I'm trying to upload via grunt-webdav-sync. The folder contains a mixture of files and subfolders. I'm trying to upload just the files, not the subfolders. I have so far tried the following:

local_path: 'dist/*', and local_path: 'dist/*.*',

A message appears saying 'Found 5 files', but the Grunt task then fails before the uploading begins (despite the 'Start uploading files to' message appearing).

Specifying the default local_path: 'dist/**', (all files and subfolders) works absolutely fine.

Thanks

sendImmediately=false

Hi,

Why is the sendImmediately set to false in the auth settings ?

I can't think of a reason to wait to send the auth header.
Changing it to true solved my webdav uploading issues.

Authentication Error

Thanks for the awesome module! I'm excited to get it working cause it's going to save a lot of work for my team and I with this particular CMS we are using. Unfortunately I'm getting an authorization error when using the module.

I can log in with the same webdav url just fine via Finder.

I'm using https://username:[email protected]/path

Error: Resource requires authorization or authorization was denied For url: ... ...

Any ideas on what could be causing this?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.