Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Daniel Harte 01ae866d58 gui: Use favicon as indication for status (fixes #1018)
GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/3217
2016-06-01 19:06:36 +00:00
assets gui: Use favicon as indication for status (fixes #1018) 2016-06-01 19:06:36 +00:00
cmd lib/db,cmd/stindex: Expose VersionList and use it in stindex 2016-05-31 19:29:26 +00:00
debtpl debian: Rename debian directory to debtpl (fixes #3099) 2016-05-26 16:37:09 +00:00
etc etc: Add documentation key to syncthing-resume.service 2016-05-17 20:19:35 +00:00
gui gui: Use favicon as indication for status (fixes #1018) 2016-06-01 19:06:36 +00:00
lib lib/db,cmd/stindex: Expose VersionList and use it in stindex 2016-05-31 19:29:26 +00:00
man gui, man: Update docs & translations 2016-05-21 22:44:55 +09:00
script script: Improve changelog layout 2016-05-31 12:40:30 +00:00
test test: Update test configs to latest format 2016-05-31 10:36:33 +02:00
vendor vendor: Update github.com/gobwas/glob (fixes #3174) 2016-05-28 04:43:54 +00:00
.gitattributes build: Generate gui.files.go on the fly, remove from repo 2016-03-28 10:03:13 +00:00
.gitignore debian: Rename debian directory to debtpl (fixes #3099) 2016-05-26 16:37:09 +00:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS etc: Add documentation key to syncthing-resume.service 2016-05-17 20:19:35 +00:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md contributing: Clarify license situation for parts of the project 2016-06-01 13:47:25 +00:00
ISSUE_TEMPLATE.md issue_template: Add note about security issues 2016-05-21 22:49:37 +09:00
LICENSE MPLv2 2015-03-17 16:02:27 +01:00
NICKS etc: Add documentation key to syncthing-resume.service 2016-05-17 20:19:35 +00:00
PULL_REQUEST_TEMPLATE.md pull_request_template: Add note about docs needing update 2016-03-26 07:00:12 +00:00
README.md readme: Remove Appveyor icon 2016-04-22 20:30:37 +00:00
build.go script: Improve changelog layout 2016-05-31 12:40:30 +00:00
build.sh Use Go 1.5 vendoring instead of Godeps 2016-03-05 21:21:24 +01:00

README.md

Syncthing

Latest Build (Official) 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 are also several GUI implementations for Windows, Mac and Linux.

Getting in Touch

The first and best point of contact is the Forum. There is also an IRC channel, #syncthing on freenode (with a web client), for talking 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.

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 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

Please see the Syncthing documentation site.

All code is licensed under the MPLv2 License.