Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jakob Borg 8bb18fa988 Create 'prerelease' step to run before releases 2015-05-30 10:39:27 +02:00
Godeps Run benchmarks when running tests 2015-05-23 15:08:17 +02:00
assets Add .gitattributes; normalize line endings 2015-04-25 23:16:46 +09:00
cmd Reduce db write cache to (2*) 4 MiB 2015-05-23 21:05:52 +02:00
etc Drop systemd README instruction in favor of the wiki 2015-04-28 14:11:12 +02:00
gui Show help link, add icons, tweak icon spacing 2015-05-30 10:31:45 +02:00
internal Show help link, add icons, tweak icon spacing 2015-05-30 10:31:45 +02:00
protocol The protocol specs moved again 2015-01-09 08:54:19 +01:00
test Add validation cache 2015-05-25 13:19:18 +02:00
.gitattributes Revert "Enforce line endings when cloning (fixes #1766)" 2015-05-07 22:55:31 +02:00
.gitignore hax 2015-05-11 18:39:53 +02:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS Add mogwa1 2015-05-25 08:07:59 +02:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md Update CONTRIBUTING to not encourage changing AUTHORS 2015-05-21 20:58:17 +02:00
LICENSE MPLv2 2015-03-17 16:02:27 +01:00
NICKS Add mogwa1 2015-05-25 08:07:59 +02:00
README.md typos and spelling correction 2015-04-29 15:59:47 +02:00
authors.go Auto generate author list in gui/index.html 2015-04-04 10:09:42 +02:00
benchfilter.go Run benchmarks when running tests 2015-05-23 15:08:17 +02:00
build.go Run benchmarks when running tests 2015-05-23 15:08:17 +02:00
build.sh Create 'prerelease' step to run before releases 2015-05-30 10:39:27 +02:00
changelog.go changelog.go should not be built 2015-04-20 14:03:50 +09:00
check-contrib.sh Make check-contribs a little more generous in recognizing a copyright header 2015-05-21 21:42:46 +02:00

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

The syncthing documentation is on the Github wiki.

All code is licensed under the MPLv2 License.