Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jakob Borg 2a60f4b1e9 Add .gitattributes; normalize line endings 2015-04-25 23:16:46 +09:00
Godeps Index reset should generate file conflicts (fixes #1613) 2015-04-09 13:06:09 +02:00
assets Add .gitattributes; normalize line endings 2015-04-25 23:16:46 +09:00
cmd Fix folder check tests 2015-04-25 23:16:46 +09:00
etc systemd: Fix error code definitions to prevent failed units 2015-03-30 00:51:06 +02:00
gui Add .gitattributes; normalize line endings 2015-04-25 23:16:46 +09:00
internal Fix folder check tests 2015-04-25 23:16:46 +09:00
protocol The protocol specs moved again 2015-01-09 08:54:19 +01:00
test Fix integration tests 2015-04-09 16:16:39 +01:00
.gitattributes Add .gitattributes; normalize line endings 2015-04-25 23:16:46 +09:00
.gitignore Get version from RELEASE file if it exists, or guess from directory (fixes #1449) 2015-03-12 11:18:23 +01:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS Add Moter8 2015-04-16 23:23:34 +09:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md MPLv2 2015-03-17 16:02:27 +01:00
LICENSE MPLv2 2015-03-17 16:02:27 +01:00
NICKS Add Moter8 2015-04-16 23:23:34 +09:00
README.md Reword and clarify some sentences 2015-04-10 13:46:38 +02:00
authors.go Auto generate author list in gui/index.html 2015-04-04 10:09:42 +02:00
build.go MPLv2 2015-03-17 16:02:27 +01:00
build.sh Allowed integration test time 60m -> 90m 2015-03-30 08:26:31 +02:00
changelog.go changelog.go should not be built 2015-04-20 14:03:50 +09:00
check-contrib.sh check-contrib 2015-01-19 10:18:28 -08: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 arrise.

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.