Martchus
/
syncthing
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
186 Commits 69 Branches 0 Tags 113 MiB
Go 81.9%
HTML 7.5%
JavaScript 5.3%
TypeScript 2.6%
Shell 1.7%
Other 0.9%
Go to file
Jakob Borg 0618e2b9b4 Don't include timestamp in auto generated files 2014-03-02 23:15:56 +01:00
assets Logo 2014-02-07 22:33:58 +01:00
auto Don't include timestamp in auto generated files 2014-03-02 23:15:56 +01:00
buffers Memory usage optimizations 2013-12-29 20:33:57 -05:00
cid Add some support packages 2014-03-01 11:11:37 +01:00
discover golint 2014-02-24 13:29:30 +01:00
files Add some support packages 2014-03-01 11:11:37 +01:00
gui Add peer node sync status in GUI (fixes #46) 2014-02-13 12:51:55 +01:00
integration Synchronize zero sized files (fixes #44) 2014-01-29 21:52:27 +01:00
protocol golint 2014-02-24 13:29:30 +01:00
xdr golint 2014-02-24 13:29:30 +01:00
.gitignore Move build artefacts dir 2014-01-06 06:11:19 +01:00
CONTRIBUTING.md CONTRIBUTING.md 2014-01-28 19:10:39 +01:00
LICENSE Rework XDR encoding 2014-02-20 17:42:17 +01:00
README.md drone.io badge 2014-02-24 14:06:22 +01:00
assets.sh Don't include timestamp in auto generated files 2014-03-02 23:15:56 +01:00
build.sh Move cmd files into subdir 2014-03-02 23:13:04 +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.

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.