README
¶
Goals
Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers. We strive to fulfill the goals below. The goals are listed in order of importance, the most important one being the first. This is the summary version of the goal list - for more commentary, see the full Goals document.
Syncthing should be:
-
Safe From Data Loss
Protecting the user's data is paramount. We take every reasonable precaution to avoid corrupting the user's files.
-
Secure Against Attackers
Again, protecting the user's data is paramount. Regardless of our other goals we must never allow the user's data to be susceptible to eavesdropping or modification by unauthorized parties.
-
Easy to Use
Syncthing should be approachable, understandable and inclusive.
-
Automatic
User interaction should be required only when absolutely necessary.
-
Universally Available
Syncthing should run on every common computer. We are mindful that the latest technology is not always available to any given individual.
-
For Individuals
Syncthing is primarily about empowering the individual user with safe, secure and easy to use file synchronization.
-
Everything Else
There are many things we care about that don't make it on to the list. It is fine to optimize for these values, as long as they are not in conflict with the stated goals above.
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.
Docker
To run Syncthing in Docker, see the Docker README.
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. 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. macOS binaries are also properly code signed.
Documentation
Please see the Syncthing documentation site [source].
All code is licensed under the MPLv2 License.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
stcrashreceiver
Command stcrashreceiver is a trivial HTTP server that allows two things: - uploading files (crash reports) named like a SHA256 hash using a PUT request - checking whether such file exists using a HEAD request Typically this should be deployed behind something that manages HTTPS.
|
Command stcrashreceiver is a trivial HTTP server that allows two things: - uploading files (crash reports) named like a SHA256 hash using a PUT request - checking whether such file exists using a HEAD request Typically this should be deployed behind something that manages HTTPS. |
|
stfindignored
Command stfindignored lists ignored files under a given folder root.
|
Command stfindignored lists ignored files under a given folder root. |
|
strelaypoolsrv/auto
Package auto contains auto generated files for web assets.
|
Package auto contains auto generated files for web assets. |
|
syncthing/decrypt
Package decrypt implements the `syncthing decrypt` subcommand.
|
Package decrypt implements the `syncthing decrypt` subcommand. |
|
lib
|
|
|
api/auto
Package auto contains auto generated files for web assets.
|
Package auto contains auto generated files for web assets. |
|
assets
Package assets hold utilities for serving static assets.
|
Package assets hold utilities for serving static 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. |
|
config/mocks
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
connections/mocks
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
connections/registry
Registry tracks connections/addresses on which we are listening on, to allow us to pick a connection/address that has a NAT port mapping.
|
Registry tracks connections/addresses on which we are listening on, to allow us to pick a connection/address that has a NAT port mapping. |
|
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. |
|
discover/mocks
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
events
Package events provides event subscription and polling functionality.
|
Package events provides event subscription and polling functionality. |
|
events/mocks
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
logger
Package logger implements a standardized logger with callback functionality
|
Package logger implements a standardized logger with callback functionality |
|
logger/mocks
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
model
Package model implements folder abstraction and file pulling mechanisms
|
Package model implements folder abstraction and file pulling mechanisms |
|
model/mocks
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
osutil
Package osutil implements utilities for native OS support.
|
Package osutil implements utilities for native OS support. |
|
protocol
Package protocol implements the Block Exchange Protocol.
|
Package protocol implements the Block Exchange Protocol. |
|
protocol/mocks
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
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. |
|
proto
|
|