2014-04-27 04:37:53 -07:00
|
|
|
syncthing
|
2013-12-15 03:43:31 -07:00
|
|
|
=========
|
|
|
|
|
|
2014-02-20 09:40:15 -07:00
|
|
|
This is the `syncthing` project. The following are the project goals:
|
2013-12-15 03:43:31 -07:00
|
|
|
|
2014-02-20 09:40:15 -07:00
|
|
|
1. Define a protocol for synchronization of a file repository between a
|
|
|
|
|
number of collaborating nodes. The protocol should be well defined,
|
2014-05-13 05:46:58 -07:00
|
|
|
unambiguous, easily understood, free to use, efficient, secure and
|
|
|
|
|
language neutral. This is the [Block Exchange
|
2014-02-20 09:40:15 -07:00
|
|
|
Protocol](https://github.com/calmh/syncthing/blob/master/protocol/PROTOCOL.md).
|
2013-12-15 03:43:31 -07:00
|
|
|
|
|
|
|
|
2. Provide the reference implementation to demonstrate the usability of
|
2014-02-20 09:40:15 -07:00
|
|
|
said protocol. This is the `syncthing` utility. It is the hope that
|
|
|
|
|
alternative, compatible implementations of the protocol will come to
|
|
|
|
|
exist.
|
2013-12-15 03:43:31 -07:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2014-04-30 07:13:29 -07:00
|
|
|
Getting Started
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Take a look at the [getting started guide](http://discourse.syncthing.net/t/getting-started/46).
|
|
|
|
|
|
2014-03-20 23:40:48 -07:00
|
|
|
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`.
|
|
|
|
|
|
2014-01-07 04:07:56 -07:00
|
|
|
Documentation
|
|
|
|
|
=============
|
2013-12-15 03:43:31 -07:00
|
|
|
|
2014-04-30 06:14:42 -07:00
|
|
|
The [syncthing
|
|
|
|
|
documentation](http://discourse.syncthing.net/category/documentation) is
|
|
|
|
|
on the discourse site.
|
2014-01-06 13:17:18 -07:00
|
|
|
|
2013-12-15 03:43:31 -07:00
|
|
|
License
|
|
|
|
|
=======
|
|
|
|
|
|
2014-02-20 09:40:15 -07:00
|
|
|
All documentation and protocol specifications are licensed
|
|
|
|
|
under the [Creative Commons Attribution 4.0 International
|
|
|
|
|
License](http://creativecommons.org/licenses/by/4.0/).
|
2013-12-15 03:43:31 -07:00
|
|
|
|
2014-02-20 09:40:15 -07:00
|
|
|
All code is licensed under the [MIT
|
|
|
|
|
License](https://github.com/calmh/syncthing/blob/master/LICENSE).
|
