Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jakob Borg bcd3fd40e4 Add licensing and contribution info 2014-03-24 14:57:14 +01:00
Godeps Update dependencies 2014-03-22 21:58:10 +01:00
assets Logo 2014-02-07 22:33:58 +01:00
auto Fast building assets 2014-03-17 22:57:19 +01:00
buffers Package descriptions for godoc 2014-03-12 06:32:26 +01:00
cid Package descriptions for godoc 2014-03-12 06:32:26 +01:00
cmd Prevent zombie connections due to simultaneous connect 2014-03-23 08:53:34 +01:00
discover Fix local announce (IPv6 multicast, include all listen addresses) 2014-03-19 13:57:19 +01:00
gui Option to not start browser (fixes #84) 2014-03-08 23:19:33 +01:00
integration Harsher integration test 2014-03-23 09:08:48 +01:00
protocol Ensure that we make progress on the read side of a connection 2014-03-23 08:44:27 +01:00
scanner Enforce correct filename normalization (fixes #96) 2014-03-21 09:09:01 +01:00
xdr Package descriptions for godoc 2014-03-12 06:32:26 +01:00
.gitignore Sign builds, upload signatures with release artefacts (fixes #97) 2014-03-20 17:55:16 +01:00
CONTRIBUTING.md Add licensing and contribution info 2014-03-24 14:57:14 +01:00
CONTRIBUTORS Add licensing and contribution info 2014-03-24 14:57:14 +01:00
LICENSE Add licensing and contribution info 2014-03-24 14:57:14 +01:00
README.md Include signature in release bundle (ref #97) 2014-03-21 07:40:48 +01:00
build.sh Don't use 'which' to check for godep 2014-03-24 07:37:26 +01:00

README.md

syncthing Build Status

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, unambigous, easily understood, free to use, efficient, secure and languange 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.

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 kept on the GitHub Wiki.

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.