syncthing/README.md

60 lines
2.3 KiB
Markdown
Raw Normal View History

2014-07-31 10:56:05 +00:00
syncthing
2013-12-15 10:43:31 +00:00
=========
[![Latest Build](http://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing.svg?style=flat-square)](http://build.syncthing.net/job/syncthing/lastBuild/)
2014-08-13 08:15:22 +00:00
[![API Documentation](http://img.shields.io/badge/api-Godoc-blue.svg?style=flat-square)](http://godoc.org/github.com/syncthing/syncthing)
2015-03-07 20:36:35 +00:00
[![MPLv2 License](http://img.shields.io/badge/license-MPLv2-blue.svg?style=flat-square)](https://www.mozilla.org/MPL/2.0/)
2014-07-31 10:56:05 +00:00
2015-04-10 11:20:50 +00:00
This is the `syncthing` project which pursues the following 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
2015-04-10 11:20:50 +00:00
collaborating devices. This protocol should be well defined, unambiguous,
2014-09-28 11:39:39 +00:00
easily understood, free to use, efficient, secure and language neutral.
2015-04-10 11:20:50 +00:00
This is called the [Block Exchange
2015-01-09 07:54:19 +00:00
Protocol](https://github.com/syncthing/specs/blob/master/BEPv1.md).
2013-12-15 10:43:31 +00:00
2. Provide the reference implementation to demonstrate the usability of
2015-04-10 11:20:50 +00:00
said protocol. This is the `syncthing` utility. We hope that
2015-04-28 15:34:55 +00:00
alternative, compatible implementations of the protocol will arise.
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
---------------
2015-01-03 15:44:13 +00:00
Take a look at the [getting started
guide](https://github.com/syncthing/syncthing/wiki/Getting-Started).
2014-08-19 13:33:20 +00:00
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
2015-04-10 11:20:50 +00:00
to developers and users.
2014-11-24 22:04:12 +00:00
2014-08-19 13:33:20 +00:00
Building
--------
Building Syncthing from source is easy, and there's a
2015-01-03 15:44:13 +00:00
[guide](https://github.com/syncthing/syncthing/wiki/Building).
2015-04-10 11:20:50 +00:00
that describes it for both Unix and Windows systems.
2014-04-30 14:13:29 +00:00
Signed Releases
---------------
As of v0.10.15 and onwards, git tags and release binaries are GPG signed
2015-04-10 11:20:50 +00:00
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
=============
2013-12-15 10:43:31 +00:00
2014-04-30 13:14:42 +00:00
The [syncthing
2015-01-03 15:44:13 +00:00
documentation](https://github.com/syncthing/syncthing/wiki/) is on the
Github wiki.
2014-09-29 19:43:32 +00:00
All code is licensed under the
2015-04-10 11:20:50 +00:00
[MPLv2 License](https://github.com/syncthing/syncthing/blob/master/LICENSE).