Skip to content
This repository has been archived by the owner on Sep 2, 2021. It is now read-only.

Latest commit

 

History

History
147 lines (100 loc) · 4 KB

README.md

File metadata and controls

147 lines (100 loc) · 4 KB
Raw

Filesync

Filesync is a utility written in Golang which helps you to keep the files on the client up to date with the files on the server. Only the changed parts of files on the server are downloaded. Therefore it's great to synchronize your huge, and frequently changing files.

Forked from github.com/elgs/filesync/gsync

Requirements

Needs access to glibc to compile properly, and so busybox:ubuntu-14.04 is the selected base image.

Local Usage

Install dependencies:

make deps

Run locally with config files (modify paths before running):

# Server
go run gsync.go gsync/server.json

# Client
go run gsync.go gsync/client.json

Alternatively, set environment variables (examples in /.env-sample):

# Server
export FILESYNC_MODE=server
export FILESYNC_PORT=6776
export FILESYNC_IP=0.0.0.0
export FILESYNC_PATH=/tmp/share

go run gsync.go

Build package (requires glibc, won't work on OSX):

make build

Build Docker image:

make dev-image
make image

Options

Configuration can be defined by JSON or ENV variables. Priority (from high to low) is JSON config file, ENV variables, then defaults. See the Init() method in vars.go for details.

JSON Configuration

Sample:

{
  "mode": "client",
    "ip": "127.0.0.1",
    "port": 6776,
    "monitors": {
        "home_elgs_desktop_a": "/home/elgs/Desktop/c",
        "home_elgs_desktop_b": "/home/elgs/Desktop/d"
    }
}
  • mode: "client" or "server"
  • ip: Address or hostname of server
  • port: Port for traffic
  • monitors: key-value pairs of directories to watch. The "key" of these gets treated as the unique directory to be synchronized, while the "value" is the file system location for this key.

ENVironment Variable Configuration

  • FILESYNC_MODE: "client" or "server"
  • FILESYNC_PORT
  • FILESYNC_IP
  • FILESYNC_PATH: A singular directory to watch. If multiple directories are required, use the JSON config. If not specified, defaults to /share/.

Demo

The docker-compose.yml details a setup with a server and 2 clients. It will create a ./demo/ directory with 3 subfolders: server, client1, and client2. Each subfolder is volumed as /share/ inside each container.

As files in ./demo/server are modified, they will be altered in ./demo/client1 and ./demo/client2.

Run Docker-Compose cluster:

docker-compose up -d

Check directories:

ls -al ./demo/server
ls -al ./demo/client1
ls -al ./demo/client2

Add a file to server volume:

echo "testing 123" > ./demo/server/test1

Check directories again:

ls -al ./demo/server
ls -al ./demo/client1
ls -al ./demo/client2

At this point, the ./demo/client* directories should contain a test1 file.

Notes

Docker Environment

While the server configuration can be set to an IP of 0.0.0.0 (accepts traffic from anywhere), the clients need a specific address to connect to. If running locally, the clients can be set to connect to 127.0.0.1 - but this will not work in a Dockerized environment.

The Docker-Compose.yml file contains links: [fs-server:fs-server] which enables the clients to contact the server container at http://fs-server. This is supported in a Rancher environment as well.

Rancher Environment

Filesync can be used as a way to share files between hosts. Container deployment can be controlled by assigning labels and using the Rancher scheduling system.

By labelling the primary host with filesync=server, these labels can be used to add a Filesync server and multiple clients:

# Server
  labels:
    io.rancher.scheduler.affinity:host_label: filesync=server

# Client
  labels:
    io.rancher.scheduler.global: 'true'
    io.rancher.scheduler.affinity:host_label_ne: filesync=server

The host labelled with filesync=server will receive a Filesync server container, and all other hosts (io.rancher.scheduler.global: 'true') not labelled with this (host_label_ne: filesync=server) will receive a client container.