No Description

Jakob Borg ef6f52f688 Correctly handle nil error in verbose logging (fixes #1921) 10 years ago
Godeps 8dd7e4e6b5 Run benchmarks when running tests 10 years ago
assets 2a60f4b1e9 Add .gitattributes; normalize line endings 10 years ago
cmd ef6f52f688 Correctly handle nil error in verbose logging (fixes #1921) 10 years ago
etc 3626003f68 replaced (not all) wiki links to new location docs.syncthing.net 10 years ago
gui a8b43ae598 Translation / docs update 10 years ago
internal a8b43ae598 Translation / docs update 10 years ago
man a8b43ae598 Translation / docs update 10 years ago
protocol e03d59e381 The protocol specs moved again 11 years ago
test 3f59d6daff Add validation cache 10 years ago
.gitattributes cb5ef26020 Revert "Enforce line endings when cloning (fixes #1766)" 10 years ago
.gitignore 21fbbc50cd hax 10 years ago
.mailmap c6688d8f89 Include ref#, show author nickname in release notes 11 years ago
AUTHORS 3e8eabe833 Add mogwa1 10 years ago
CONDUCT.md dde8045109 Add Code of Conduct 11 years ago
CONTRIBUTING.md 5f4a92c8e6 Correct link 10 years ago
LICENSE 32425c5561 MPLv2 10 years ago
NICKS 3e8eabe833 Add mogwa1 10 years ago
README.md ca7e7fa0c4 Docs link, capitalization 10 years ago
authors.go a598cd2b18 Auto generate author list in gui/index.html 10 years ago
benchfilter.go 8dd7e4e6b5 Run benchmarks when running tests 10 years ago
build.go 1f6dd5dbb9 Add man pages to Debian package 10 years ago
build.sh db52646655 Include generated man pages 10 years ago
changelog.go 42ff4b5bf0 changelog.go should not be built 10 years ago
check-contrib.sh ccf3fed950 Merge remote-tracking branch 'syncthing/pr/1911' 10 years ago

README.md

Syncthing

Latest Build API Documentation MPLv2 License

This is the Syncthing project which pursues the following goals:

  1. 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.

  2. Provide the reference implementation to demonstrate the usability of said protocol. This is the syncthing utility. 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 is an IRC channel, #syncthing on Freenode, for talking directly to developers and users.

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, git tags and release binaries are GPG signed with the key D26E6ED000654A3E (see https://syncthing.net/security.html). For release binaries, MD5 and SHA1 checksums are calculated and signed, available in the md5sum.txt.asc and sha1sum.txt.asc files.

Documentation

Please see the Syncthing documentation site.

All code is licensed under the MPLv2 License.