Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jakob Borg 7d39d1a925 Make it possible to include extra external files into binary packages 2015-01-07 16:15:50 +01:00
Godeps Update goleveldb 2014-12-29 12:23:07 +01:00
assets Logo update 2014-08-06 09:07:13 +02:00
cmd Add device finder utility 2015-01-06 23:12:12 +00:00
docker Patch Go for issue #9102 in build env (fixes #1112) 2014-12-13 10:38:05 +01:00
etc add README 2015-01-05 18:29:13 +08:00
gui Merge remote-tracking branch 'origin/pr/1198' 2015-01-07 14:24:49 +01:00
internal Add timabell 2015-01-07 08:36:54 +01:00
protocol Move protocol specs to a separate repo 2014-12-22 09:55:58 +01:00
test Hash blocks after receipt, try multiple peers (fixes #1166) 2015-01-03 23:21:57 +00:00
.gitignore Include MD5 sums in archives 2014-12-22 12:12:34 +01:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS Add timabell 2015-01-07 08:36:54 +01:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md Clarify authorship requirements in contribution guidelines 2014-12-18 21:56:52 +01:00
LICENSE Relicense to GPL 2014-10-01 07:53:59 +02:00
NICKS Add timabell 2015-01-07 08:36:54 +01:00
README.md Update key ID for signed releases in README (fixes #1180) 2015-01-06 23:06:16 +01:00
build.go Make it possible to include extra external files into binary packages 2015-01-07 16:15:50 +01:00
build.sh Improve and clean up integration tests, benchmark. 2014-12-19 12:43:48 +01:00
changelog.sh Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
check-contrib.sh Disregard change to removed doc 2014-12-23 10:23:36 +01:00

README.md

syncthing

Latest Build API Documentation GPL License

This is the syncthing project. The following are the project goals:

  1. Define a protocol for synchronization of a folder between a number of collaborating devices. The protocol should be well defined, unambiguous, easily understood, free to use, efficient, secure and language neutral. This is the Block Exchange Protocol.

  2. Provide the reference implementation to demonstrate the usability of said protocol. This is the syncthing utility. It is the hope that alternative, compatible implementations of the protocol will come to exist.

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 (when awake and present, etc.).

Building

Building Syncthing from source is easy, and there's a guide. that describes it for both Unix and Windows.

Signed Releases

As of v0.10.15 and onwards, git tags and release binaries are GPG signed with the key D26E6ED000654A3E (see http://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 GPL, v3 or later.