README
¶
Syncthing
This is the Syncthing project which pursues the following goals:
-
Define a protocol for synchronization of a folder between a number of collaborating devices. This protocol should be well defined, unambiguous, easily understood, free to use, efficient, secure and language neutral. This is called the Block Exchange Protocol.
-
Provide the reference implementation to demonstrate the usability of said protocol. This is the
syncthingutility. We hope that alternative, compatible implementations of the protocol will arise.
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.
Getting Started
Take a look at the getting started guide.
There are a few examples for keeping Syncthing running in the background on your system in the etc directory. There are also several GUI implementations for Windows, Mac and Linux.
Vote on features/bugs
We'd like to encourage you to vote on issues that matter to you. This helps the team understand what are the biggest pain points for our users, and could potentially influence what is being worked on next.
Getting in Touch
The first and best point of contact is the Forum. There is also an IRC
channel, #syncthing on freenode (with a web client), for talking
directly to developers and users. If you've found something that is clearly a
bug, feel free to report it in the GitHub issue tracker.
Building
Building Syncthing from source is easy, and there's a guide that describes it for both Unix and Windows systems.
Signed Releases
As of v0.10.15 and onwards release binaries are GPG signed with the key D26E6ED000654A3E, available from https://syncthing.net/security.html and most key servers.
There is also a built in automatic upgrade mechanism (disabled in some distribution channels) which uses a compiled in ECDSA signature. Mac OS X binaries are also properly code signed.
Documentation
Please see the Syncthing documentation site.
All code is licensed under the MPLv2 License.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
lib
|
|
|
auto
Package auto contains auto generated files for web assets.
|
Package auto contains auto generated files for web assets. |
|
beacon
Package beacon implements an UDP broadcast beacon
|
Package beacon implements an UDP broadcast beacon |
|
config
Package config implements reading and writing of the syncthing configuration file.
|
Package config implements reading and writing of the syncthing configuration file. |
|
db
Package db provides a set type to track local/remote files with newness checks.
|
Package db provides a set type to track local/remote files with newness checks. |
|
discover
Package discover implements the local and global device discovery protocols.
|
Package discover implements the local and global device discovery protocols. |
|
events
Package events provides event subscription and polling functionality.
|
Package events provides event subscription and polling functionality. |
|
logger
Package logger implements a standardized logger with callback functionality
|
Package logger implements a standardized logger with callback functionality |
|
model
Package model implements folder abstraction and file pulling mechanisms
|
Package model implements folder abstraction and file pulling mechanisms |
|
osutil
Package osutil implements utilities for native OS support.
|
Package osutil implements utilities for native OS support. |
|
protocol
Package protocol is a generated protocol buffer package.
|
Package protocol is a generated protocol buffer package. |
|
rand
Package rand implements functions similar to math/rand in the standard library, but on top of a secure random number generator.
|
Package rand implements functions similar to math/rand in the standard library, but on top of a secure random number generator. |
|
rc
Package rc provides remote control of a Syncthing process via the REST API.
|
Package rc provides remote control of a Syncthing process via the REST API. |
|
scanner
Package scanner implements a file system scanner and hasher.
|
Package scanner implements a file system scanner and hasher. |
|
signature
Package signature provides simple methods to create and verify signatures in PEM format.
|
Package signature provides simple methods to create and verify signatures in PEM format. |
|
upgrade
Package upgrade downloads and compares releases, and upgrades the running binary.
|
Package upgrade downloads and compares releases, and upgrades the running binary. |
|
upnp
Package upnp implements UPnP InternetGatewayDevice discovery, querying, and port mapping.
|
Package upnp implements UPnP InternetGatewayDevice discovery, querying, and port mapping. |
|
versioner
Package versioner implements common interfaces for file versioning and a simple default versioning scheme.
|
Package versioner implements common interfaces for file versioning and a simple default versioning scheme. |