syncthing/README.md

70 lines
3.1 KiB
Markdown
Raw Normal View History

# Syncthing
2013-12-15 10:43:31 +00:00
[![Latest Build (Official)](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing.svg?style=flat-square&label=unix%20build)](http://build.syncthing.net/job/syncthing/lastBuild/)
[![AppVeyor Build](https://img.shields.io/appveyor/ci/calmh/syncthing/master.svg?style=flat-square&label=windows%20build)](https://ci.appveyor.com/project/calmh/syncthing)
[![API Documentation](https://img.shields.io/badge/api-Godoc-blue.svg?style=flat-square)](http://godoc.org/github.com/syncthing/syncthing)
[![MPLv2 License](https://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-05-31 07:35:17 +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.
This is called the [Block Exchange Protocol][1].
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
2015-05-31 07:35:17 +00:00
stable until Syncthing 1.0 is released, at which point it is locked down
2013-12-15 10:43:31 +00:00
for incompatible changes.
## Getting Started
2014-04-30 14:13:29 +00:00
Take a look at the [getting started guide][2].
2014-08-19 13:33:20 +00:00
2015-05-31 07:35:17 +00:00
There are a few examples for keeping Syncthing running in the background
2016-03-02 06:50:15 +00:00
on your system in [the etc directory][3]. There are also several [GUI
implementations][11] for Windows, Mac and Linux.
2014-11-24 12:47:56 +00:00
2016-01-03 12:07:22 +00:00
## Getting in Touch
The first and best point of contact is the [Forum][8]. There is also an IRC
2016-03-06 19:01:33 +00:00
channel, `#syncthing` on [freenode][4] (with a [web client][9]), for talking
2016-01-03 12:07:22 +00:00
directly to developers and users. If you've found something that is clearly a
bug, feel free to report it in the [GitHub issue tracker][10].
2014-11-24 22:04:12 +00:00
## Building
2014-08-19 13:33:20 +00:00
2016-03-02 06:50:15 +00:00
Building Syncthing from source is easy, and there's a [guide][5]
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
2016-03-02 06:50:15 +00:00
As of v0.10.15 and onwards release binaries are GPG signed with the key
D26E6ED000654A3E, available from https://syncthing.net/security.html and
most key servers.
There is also a built in automatic upgrade mechanism (disabled in some
distribution channels) which uses a compiled in ECDSA signature. Mac OS
X binaries are also properly code signed.
## Documentation
2013-12-15 10:43:31 +00:00
Please see the [Syncthing documentation site][6].
All code is licensed under the [MPLv2 License][7].
2015-10-20 11:41:24 +00:00
[1]: http://docs.syncthing.net/specs/bep-v1.html
[2]: http://docs.syncthing.net/intro/getting-started.html
[3]: https://github.com/syncthing/syncthing/blob/master/etc
2016-01-03 12:07:22 +00:00
[4]: http://www.freenode.net/irc_servers.shtml
[5]: http://docs.syncthing.net/dev/building.html
[6]: http://docs.syncthing.net/
[7]: https://github.com/syncthing/syncthing/blob/master/LICENSE
2016-01-03 12:07:22 +00:00
[8]: https://forum.syncthing.net/
[9]: https://kiwiirc.com/client/irc.freenode.net/#syncthing
[10]: https://github.com/syncthing/syncthing/issues
2016-03-02 06:50:15 +00:00
[11]: http://docs.syncthing.net/users/contrib.html#gui-wrappers