README
¶
syncthing 
This is the syncthing project. The following are the project goals:
-
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.
-
Provide the reference implementation to demonstrate the usability of said protocol. This is the
syncthingutility. 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
- 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.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auto contains auto generated files for web assets.
|
Package auto contains auto generated files for web assets. |
|
Package buffers manages a set of reusable byte buffers.
|
Package buffers manages a set of reusable byte buffers. |
|
Package cid provides a manager for mappings between node ID:s and connection ID:s.
|
Package cid provides a manager for mappings between node ID:s and connection ID:s. |
|
cmd
|
|
|
Package discover implements the node discovery protocol.
|
Package discover implements the node discovery protocol. |
|
Package fileset provides a set type to track local/remote files with newness checks.
|
Package fileset provides a set type to track local/remote files with newness checks. |
|
Package protocol implements the Block Exchange Protocol.
|
Package protocol implements the Block Exchange Protocol. |
|
Package scanner implements a file system scanner and hasher.
|
Package scanner implements a file system scanner and hasher. |
|
Package xdr implements an XDR (RFC 4506) encoder/decoder.
|
Package xdr implements an XDR (RFC 4506) encoder/decoder. |