Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jakob Borg ec718e729e various: Master is now main
Also cleans out various old strings from the translation strings.
2020-06-16 07:08:09 +02:00
.github github: Update issue templates (#6610) 2020-05-07 12:23:00 +01:00
assets assets, gui: Losslessly compress all JPG, PNG, and PDF images (#6265) 2020-01-16 13:52:43 +01:00
cmd various: Master is now main 2020-06-16 07:08:09 +02:00
etc etc: Add RestartSec=5 to linux-systemd units 2020-05-12 10:02:32 +02:00
gui various: Master is now main 2020-06-16 07:08:09 +02:00
lib lib/model: Fix minor flakiness in TestModTimeWindow 2020-06-16 06:32:37 +02:00
man gui, man, authors: Update docs, translations, and contributors 2020-06-10 07:45:27 +02:00
meta all: Tweak error creation (#6391) 2020-03-03 22:40:00 +01:00
script build: Clean up build.sh, add build.ps1 (#6689) 2020-05-28 12:42:15 +02:00
test all: Tweak error creation (#6391) 2020-03-03 22:40:00 +01:00
.codecov.yml build: Add option to get test coverage (#5539) 2019-02-14 22:38:47 +00:00
.gitattributes lib/protocol: Revert protobuf encoder changes in v0.14.17 (fixes #3855) 2017-01-01 17:19:00 +00:00
.gitignore build: Update .gitignores for new asset locs (ref #6624) (#6631) 2020-05-11 11:04:47 +01:00
.golangci.yml golangci: Skip godox 2019-12-18 11:33:36 +01:00
AUTHORS gui, man, authors: Update docs, translations, and contributors 2020-06-03 07:45:41 +02:00
CONDUCT.md conduct: Upgrade to Contributor Covenant 2018-06-20 23:53:06 +02:00
CONTRIBUTING.md all: Update docs.s.n links to use https 2016-10-27 17:02:19 +00:00
Dockerfile docker: Add tzdata for local time log entries 2020-05-16 11:34:46 +02:00
Dockerfile.builder docker: Accept Go version as --build-arg 2020-05-04 12:45:36 +02:00
Dockerfile.stdiscosrv docker: Accept Go version as --build-arg 2020-05-04 12:45:36 +02:00
Dockerfile.strelaysrv docker: Accept Go version as --build-arg 2020-05-04 12:45:36 +02:00
GOALS.md goals: Typo 2017-12-12 08:12:30 +00:00
LICENSE all: Update license url to https (ref #3976) 2017-02-09 08:04:16 +01:00
README-Docker.md docker: Make it easy to disable the GUI, document it (#6021) 2019-09-22 11:33:29 +01:00
README.md various: Master is now main 2020-06-16 07:08:09 +02:00
build.go various: Master is now main 2020-06-16 07:08:09 +02:00
build.ps1 build: Clean up build.sh, add build.ps1 (#6689) 2020-05-28 12:42:15 +02:00
build.sh build: Clean up build.sh, add build.ps1 (#6689) 2020-05-28 12:42:15 +02:00
go.mod build(deps): bump github.com/lucas-clemente/quic-go (#6722) 2020-06-09 08:43:34 +02:00
go.sum build(deps): bump github.com/lucas-clemente/quic-go (#6722) 2020-06-09 08:43:34 +02:00

README.md

Syncthing


Latest Linux & Cross Build Latest Windows Build Latest Mac Build 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.

Docker

To run Syncthing in Docker, see the Docker README.

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. macOS binaries are also properly code signed.

Documentation

Please see the Syncthing documentation site.

All code is licensed under the MPLv2 License.