socket-file-sync
Sync files to server using socket.io
Last updated 2 years ago by laggingreflex .
Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install socket-file-sync 
SYNC missed versions from official npm registry.

socket-file-sync

Watch and sync files from client to server using NodeJS Socket.io.

Simple to configure - doesn't use SSH, just a secret text.

A single server can be connected to from multiple clients.

Install

Install it both on client and the server:

npm install socket-file-sync

Usage

sfs [mode] <[options]>
  • mode [string](required) One of two:

    • server s Host where files are uploaded to
    • client c Host where files are uploaded from, and watched for changes

    This can also be provided as as a switch: --mode server (instead of the 1st argument)

  • secret [string](required) Secret to use for authentication.

client related options:

  • cwd [string](default:process.cwd()) Current directory (on client) where files are watched on
  • server [string](required) The server address to which the client connects to
  • serverDir [string](required) Base dir on the server w.r.t. to which files uploaded are written to

Common to both: These settings are common to both server and client and the roles of remotes are interchangeable - any one can send/receive a file.

  • twoWay [boolean] Enable two-way sync - server also watches for and pushes the file changes from its end.

    Note: With this enabled you may see "Skipping copying... Same contents" warnings which are an unfortunate by-product of preventing the file-watchers running on both ends to go in a feedback loop of re-sending the same file over and over again.

    It needs to be enabled by both the server and the client.

  • deleteOnRemote [boolean] Enable deleting a file on the remote. The remote needs to have deleteByRemote enabled.

  • deleteByRemote [boolean] Enable the remote to delete a local file.

Note: Necessary options are prompted if not provided.

Config is stored in two places:

  • ~/.socket-file-sync Main config that applies across all projects

  • <current-dir>/.socket-file-sync An optional per-project config whose values override those in the main one.

Example

  • On Server:

    sfs server
    
  • On Client:

    sfs client --server my-linode.com --server-dir ~/project
    

Current Tags

  • 0.7.3                                ...           latest (2 years ago)

15 Versions

  • 0.7.3                                ...           2 years ago
  • 0.7.2                                ...           2 years ago
  • 0.7.1                                ...           2 years ago
  • 0.7.0                                ...           2 years ago
  • 0.6.0                                ...           2 years ago
  • 0.5.2                                ...           3 years ago
  • 0.5.1                                ...           3 years ago
  • 0.3.3                                ...           3 years ago
  • 0.3.2                                ...           3 years ago
  • 0.3.1                                ...           3 years ago
  • 0.3.0                                ...           3 years ago
  • 0.2.2                                ...           3 years ago
  • 0.2.1                                ...           3 years ago
  • 0.2.0                                ...           3 years ago
  • 0.1.1                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 5
Last Day 0
Last Week 3
Last Month 1
Dependencies (16)
Dev Dependencies (4)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |