Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jakob Borg 7f97037190 Revert "Merge pull request #1078 from syncthing/go1.4"
This reverts commit b658afd857, reversing
changes made to 591c5dabf4.
2014-12-04 22:24:49 +01:00
Godeps Dependency update, new golang.org/x package names 2014-11-30 00:17:00 +01:00
assets Logo update 2014-08-06 09:07:13 +02:00
cmd Utility to print all info we know about a path 2014-12-03 11:32:10 +01:00
docker Revert "Merge pull request #1078 from syncthing/go1.4" 2014-12-04 22:24:49 +01:00
etc Add example for Solaris SMF running 2014-11-24 13:59:59 +01:00
gui Avoid rounding errors (fixes #1068) 2014-12-03 23:44:39 +00:00
internal Revert "Merge pull request #1078 from syncthing/go1.4" 2014-12-04 22:24:49 +01:00
protocol Update PROTOCOL.md 2014-11-20 16:32:01 +01:00
test Revert "Merge pull request #1078 from syncthing/go1.4" 2014-12-04 22:24:49 +01:00
.gitignore GUI Rework: reorganized folders and split app.js 2014-11-26 13:43:38 +01:00
AUTHORS Add asdil12 2014-11-30 20:57:34 +01:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md Clarify/formalize contribution policy and commit access 2014-12-02 15:55:45 +01:00
LICENSE Relicense to GPL 2014-10-01 07:53:59 +02:00
README.md Note about IRC channel 2014-11-24 23:07:30 +01:00
build.go Use runtime info to determine ARM version for upgrade (fixes #1051) 2014-12-01 10:24:13 +01:00
build.sh Revert "Merge pull request #1078 from syncthing/go1.4" 2014-12-04 22:24:49 +01:00
check-contrib.sh Finalize s/CONTRIBUTORS/AUTHORS/ 2014-11-18 18:13:19 +04: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.7.0 and onwards, git tags and release binaries are GPG signed with the key BCE524C7 (http://nym.se/gpg.txt). 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 discourse site.

License

All documentation and protocol specifications are licensed under the Creative Commons Attribution 4.0 International License.

All code is licensed under the GPL, v3 or later.