Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jake Peterson 44790b1333 Added Jake Peterson to AUTHORS 2015-10-23 22:49:25 -06:00
Godeps Merge pull request #2320 from AudriusButkevicius/proto 2015-10-18 08:47:30 +02:00
assets Add .gitattributes; normalize line endings 2015-04-25 23:16:46 +09:00
cmd Because I am a muppet 2015-10-23 20:21:21 +01:00
etc Documentation and examples for Ubuntu-like linux systems using 2015-10-23 22:37:35 -06:00
gui Fix Raleway font 2015-10-22 21:08:24 +02:00
lib Close channel after the client is stopped 2015-10-22 23:09:02 +01:00
man Docs update 2015-10-22 08:14:43 +02:00
protocol The protocol specs moved again 2015-01-09 08:54:19 +01:00
script Add specific build setup for CircleCI 2015-09-02 14:56:16 +02:00
test Update test configs to modern v0.12 defaults 2015-10-22 08:06:17 +02:00
.gitattributes Revert "Enforce line endings when cloning (fixes #1766)" 2015-05-07 22:55:31 +02:00
.gitignore Remove leftovers from signing 2015-08-31 17:46:48 +02:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS Added Jake Peterson to AUTHORS 2015-10-23 22:49:25 -06:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md Links are nice, too 2015-06-10 00:04:53 +02:00
LICENSE MPLv2 2015-03-17 16:02:27 +01:00
NICKS Add address for burkemw3 2015-10-20 08:38:12 +02:00
README.md Update specs link 2015-10-20 13:41:24 +02:00
appveyor.yaml Add AppVeyor for Windows builds 2015-09-20 15:18:50 +02:00
build.go Relative GOBIN not allowed in Go 1.5.2+ 2015-10-20 15:59:38 +02:00
build.sh Apparently -race adds some stuff gocov doesn't like. Lets try this instead. 2015-10-14 15:41:15 +09:00

README.md

Syncthing

Latest Build (Official) AppVeyor 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.