Skip to content

pulcy/correlation

Repository files navigation

Correlation

Correlation is a smart folder synchronizer. It uses syncthing to synchronize files and ETCD to find others that want to synchronize the same folder.

Usage

Flags Description
--log-level Minimum log level (debug
--etcd-addr Address of etcd backend (e.g. "http://localhost:4001/pulcy/correlation/myfolder")
--sync-port Port number used by syncthing to synchronize on
--http-port Port number used by syncthing to listen for GUI & REST API on
--announce-ip IP address to announce that we're running on
--announce-port Port number to announce that syncthing is listening on (defaults to --sync-port)
--syncthing-path Full path of syncthing (defaults to /app/syncthing)
--sync-dir Full path of the folder to synchronize
--config-dir Full path of the folder to store the synchronization database & config files in
--gui-user Username used to access the syncthing GUI
--gui-password Password used to access the syncthing GUI
--rescan-interval Time between scans of the sync-dir
--master If set my folder will be considered the master and will not receive updates from others
--docker-endpoint If set, contains endpoint where to reach docker. (defaults to unix:///var/run/docker.sock)
--container Name of the container running this process. Use to set announce-ip & announce-port
--no-watcher If set, no filesystem watcher is launched and only timer based scanning is used

Example:

docker run -it -p 5812:5812 -p 5808:5808 \
    -v /var/lib/test1:/sync -v /var/lib/test1-cfg:/config \
    correlation \
    --etcd-addr=http://${HOSTIP}:4001/pulcy/correlation/myfolder \
    --announce-ip=${HOSTIP} \
    --http-port=5812 \
    --sync-port=5808 \
    --sync-dir=/sync \
    --config-dir=/config
docker run -it -P \
    -v /var/lib/test1:/sync -v /var/lib/test1-cfg:/config -v /var/run/docker.sock:/var/run/docker.sock \
    --name=test1 --rm \
    correlation \
    --etcd-addr=http://${HOSTIP}:4001/pulcy/correlation/myfolder \
    --announce-ip=${HOSTIP} \
    --sync-dir=/sync \
    --config-dir=/config
    --container=test1

About

Correlation is a smart folder synchronizer.

Resources

Stars

Watchers

Forks

Packages

No packages published