Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
NoLooseEnds 8e9119eedf assets: Add Mac folder icon
Skip-check: authors

GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/4238
2017-07-20 13:23:54 +00:00
assets assets: Add Mac folder icon 2017-07-20 13:23:54 +00:00
cmd all: Typos 2017-07-20 13:10:46 +00:00
etc all: Typos 2017-07-20 13:10:46 +00:00
gui gui, lib/config: Add default path for new folders (fixes #2157) 2017-07-20 13:16:54 +00:00
jenkins build, jenkins: Move test coverage stuff to jenkins/ 2017-06-02 07:18:59 +00:00
lib gui, lib/config: Add default path for new folders (fixes #2157) 2017-07-20 13:16:54 +00:00
man gui, man: Update docs & translations 2017-07-05 07:45:22 +02:00
meta build: Support builds outside of GOPATH 2017-07-11 07:57:58 +00:00
script meta: Move metadata checks into meta directory, make them tests 2017-07-07 20:43:26 +00:00
test all: Typos 2017-07-20 13:10:46 +00:00
vendor vendor: Update github.com/gogo/protobuf, keeping all files 2017-06-14 05:24:09 +02:00
.gitattributes lib/protocol: Revert protobuf encoder changes in v0.14.17 (fixes #3855) 2017-01-01 17:19:00 +00:00
.gitignore jenkins: Build snap 2016-10-20 09:31:07 +00:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS authors: Add rasa 2017-07-17 15:06:47 +02:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md all: Update docs.s.n links to use https 2016-10-27 17:02:19 +00:00
GOALS.md all: Correct various typos 2017-02-25 08:12:13 +00:00
ISSUE_TEMPLATE.md issue_template: Add note about security issues 2016-05-21 22:49:37 +09:00
LICENSE all: Update license url to https (ref #3976) 2017-02-09 08:04:16 +01:00
NICKS authors: Add rasa 2017-07-17 15:06:47 +02:00
PULL_REQUEST_TEMPLATE.md pull_request_template: Add note about docs needing update 2016-03-26 07:00:12 +00:00
README.md all: Typos 2017-07-20 13:10:46 +00:00
build.go build: Use maximum compression when archiving 2017-07-17 13:20:13 +00:00
build.sh build: The default build step already includes linting 2017-07-15 17:06:22 +02:00
snapcraft.yaml.template snapcraft: s/snap/prime (fixes #3955) 2017-02-05 15:03:36 +01:00

README.md

Syncthing


Latest Linux & Cross Build Latest Windows Build Latest Mac Build Latest Solaris Build API Documentation MPLv2 License CII Best Practices Go Report Card

Goals

Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers. We strive to fulfill the goals below. The goals are listed in order of importance, the most important one being the first. This is the summary version of the goal list - for more commentary, see the full Goals document.

Syncthing should be:

  1. Safe From Data Loss

    Protecting the user's data is paramount. We take every reasonable precaution to avoid corrupting the user's files.

  2. Secure Against Attackers

    Again, protecting the user's data is paramount. Regardless of our other goals we must never allow the user's data to be susceptible to eavesdropping or modification by unauthorized parties.

  3. Easy to Use

    Syncthing should be approachable, understandable and inclusive.

  4. Automatic

    User interaction should be required only when absolutely necessary.

  5. Universally Available

    Syncthing should run on every common computer. We are mindful that the latest technology is not always available to any given individual.

  6. For Individuals

    Syncthing is primarily about empowering the individual user with safe, secure and easy to use file synchronization.

  7. Everything Else

    There are many things we care about that don't make it on to the list. It is fine to optimize for these values, as long as they are not in conflict with the stated goals above.

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.

Vote on features/bugs

We'd like to encourage you to vote on issues that matter to you. This helps the team understand what are the biggest pain points for our users, and could potentially influence what is being worked on next.

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.