2014-07-31 10:56:05 +00:00
|
|
|
syncthing
|
2013-12-15 10:43:31 +00:00
|
|
|
=========
|
|
|
|
|
|
2014-08-20 10:23:04 +00:00
|
|
|
[](http://build.syncthing.net/job/syncthing/lastBuild/)
|
2014-08-13 08:15:22 +00:00
|
|
|
[](http://godoc.org/github.com/syncthing/syncthing)
|
2014-09-29 19:43:32 +00:00
|
|
|
[](http://opensource.org/licenses/GPL-3.0)
|
2014-07-31 10:56:05 +00:00
|
|
|
|
2014-02-20 16:40:15 +00:00
|
|
|
This is the `syncthing` project. The following are the project goals:
|
2013-12-15 10:43:31 +00:00
|
|
|
|
2014-09-28 11:39:39 +00:00
|
|
|
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
|
2014-12-22 08:53:02 +00:00
|
|
|
Protocol](https://github.com/syncthing/protocol/blob/master/BEPv1.md).
|
2013-12-15 10:43:31 +00:00
|
|
|
|
|
|
|
|
2. Provide the reference implementation to demonstrate the usability of
|
2014-02-20 16:40:15 +00:00
|
|
|
said protocol. This is the `syncthing` utility. It is the hope that
|
|
|
|
|
alternative, compatible implementations of the protocol will come to
|
|
|
|
|
exist.
|
2013-12-15 10:43:31 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2014-04-30 14:13:29 +00:00
|
|
|
Getting Started
|
|
|
|
|
---------------
|
|
|
|
|
|
2014-08-19 13:33:20 +00:00
|
|
|
Take a look at the [getting started guide](http://discourse.syncthing.net/t/46).
|
|
|
|
|
|
2014-11-24 12:47:56 +00:00
|
|
|
There are a few examples for keeping syncthing running in the background
|
|
|
|
|
on your system in [the etc directory](https://github.com/syncthing/syncthing/blob/master/etc).
|
|
|
|
|
|
2014-11-24 22:04:12 +00:00
|
|
|
There is an IRC channel, `#syncthing` on Freenode, for talking directly
|
|
|
|
|
to developers and users (when awake and present, etc.).
|
|
|
|
|
|
2014-08-19 13:33:20 +00:00
|
|
|
Building
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Building Syncthing from source is easy, and there's a
|
|
|
|
|
[guide](http://discourse.syncthing.net/t/44)
|
|
|
|
|
that describes it for both Unix and Windows.
|
2014-04-30 14:13:29 +00:00
|
|
|
|
2014-03-21 06:40:48 +00:00
|
|
|
Signed Releases
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
As of v0.7.0 and onwards, git tags and release binaries are GPG signed with
|
2014-08-13 10:52:04 +00:00
|
|
|
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.
|
2014-03-21 06:40:48 +00:00
|
|
|
|
2014-01-07 11:07:56 +00:00
|
|
|
Documentation
|
|
|
|
|
=============
|
2013-12-15 10:43:31 +00:00
|
|
|
|
2014-04-30 13:14:42 +00:00
|
|
|
The [syncthing
|
|
|
|
|
documentation](http://discourse.syncthing.net/category/documentation) is
|
|
|
|
|
on the discourse site.
|
2014-01-06 20:17:18 +00:00
|
|
|
|
2014-09-29 19:43:32 +00:00
|
|
|
All code is licensed under the
|
|
|
|
|
[GPL](https://github.com/syncthing/syncthing/blob/master/LICENSE), v3 or
|
|
|
|
|
later.
|
