Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jakob Borg b60251b960 Show node name in title/header (fixes #221) 2014-05-16 14:24:32 +02:00
Godeps Update saved dependencies 2014-05-02 10:05:48 +02:00
assets Logo 2014-02-07 22:33:58 +01:00
auto Show node name in title/header (fixes #221) 2014-05-16 14:24:32 +02:00
beacon Repair test suite 2014-05-15 09:09:21 -03:00
buffers Package descriptions for godoc 2014-03-12 06:32:26 +01:00
cid The Great Rewrite (fixes #36, #61, #94, #101) 2014-03-29 13:47:21 +01:00
cmd Repair test suite 2014-05-15 09:09:21 -03:00
config Repair test suite 2014-05-15 09:09:21 -03:00
discover Rename mc -> beacon 2014-05-15 00:33:40 -03:00
files Refactor logging into separate package 2014-05-14 21:08:56 -03:00
gui Show node name in title/header (fixes #221) 2014-05-16 14:24:32 +02:00
integration Refactor model into separate package 2014-05-15 00:33:40 -03:00
lamport Package level comments 2014-05-15 00:40:17 -03:00
logger Package level comments 2014-05-15 00:40:17 -03:00
model Don't spam console with debug 2014-05-16 14:24:31 +02:00
protocol Increase file limit from 100.000 to 1.000.000 2014-05-13 10:05:36 -03:00
scanner Refactor model into separate package 2014-05-15 00:33:40 -03:00
upnp Refactor logging into separate package 2014-05-14 21:08:56 -03:00
xdr Enable discovery gossiping 2014-05-11 19:55:43 -03:00
.gitignore The Great Rewrite (fixes #36, #61, #94, #101) 2014-03-29 13:47:21 +01:00
CONTRIBUTING.md Links to discourse 2014-04-30 15:14:42 +02:00
CONTRIBUTORS Add jedie 2014-05-14 09:53:10 -03:00
LICENSE Add licensing and contribution info 2014-03-24 14:57:14 +01:00
README.md Update README.md 2014-05-13 14:46:58 +02:00
build.sh Add guidev build mode 2014-05-12 20:04:49 -03:00

README.md

syncthing

This is the syncthing project. The following are the project goals:

  1. Define a protocol for synchronization of a file repository between a number of collaborating nodes. The protocol should be well defined, unambiguous, easily understood, free to use, efficient, secure and language neutral. This is the Block Exchange Protocol.

  2. Provide the reference implementation to demonstrate the usability of said protocol. This is the syncthing utility. It is the hope that alternative, compatible implementations of the protocol will come to exist.

The two are evolving together; the protocol is not to be considered stable until syncthing 1.0 is released, at which point it is locked down for incompatible changes.

Syncthing does not use the BitTorrent protocol. The reasons for this are

  1. we don't know if BitTorrent Sync does either, so there's nothing to be compatible with, 2) BitTorrent includes a lot of functionality for making sure large swarms of selfish agents behave and somehow work towards a common goal. Here we have a much smaller swarm of cooperative agents and a simpler approach will suffice.

Getting Started

Take a look at the getting started guide.

Signed Releases

As of v0.7.0 and onwards, git tags and release binaries are GPG signed with the key BCE524C7 (http://nym.se/gpg.txt). The signature is included in the normal release bundle as syncthing.asc or syncthing.exe.asc.

Documentation

The syncthing documentation is on the discourse site.

License

All documentation and protocol specifications are licensed under the Creative Commons Attribution 4.0 International License.

All code is licensed under the MIT License.