bhanditz / rsynk

rsync ssh server for JVM in Kotlin

Rsynk

What it is

An embeddable ssh server for rsync client with additional features.

What it is not

Not an rsync re-implementation. Unlike server, client functionality is not an aim of the project.

Goals

The goal is to make a server for rsync client that supports rich files content manipulations which are not implemented in vanilla rsync. Rsynk supplied with API to dynamically select which files are downloadable and set the bounds on those files - offset and length, dynamically as well.

Compatible rsync clients

Minimal client version is 3.1.0 (released September 28th, 2013, see versions), newer versions of rsync can be used. If you're using another rsync protocol implementation - the version of protocol must be 31 or newer.

Building project

Gradle is used to build and test. JDK 1.8 and Kotlin 1.1.1 are required. To build the project, run:

./gradlew

To execute the tests, run:

./gradlew test

Some test suits run vanilla rsync client commands against rsynk server. Those integration tests require an rsync client installed. To run tests in docker container with all necessary dependencies provided, run:

cd docker/integration-tests && ./build-and-run.sh