Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Jakob Borg c5ec6cd7ef
build: Fix deepsource test & exclude patterns (#7969)
2021-09-26 12:08:59 +02:00
.github build: Upgrade to GitHub-native Dependabot (#7607) 2021-04-29 21:19:06 +02:00
assets assets, gui: Losslessly compress all JPG, PNG, and PDF images (#6265) 2020-01-16 13:52:43 +01:00
cmd all: Unused args, retvals, assignments (#7926) 2021-09-08 00:11:16 +02:00
etc etc: Fix start-limit parameters location in systemd units (ref #7439) (#7529) 2021-03-28 14:14:10 +02:00
gui gui: Removed superfluous quotes (fixes #7853) (#7961) 2021-09-23 23:38:06 +02:00
lib build: Update all dependencies (#7968) 2021-09-26 12:08:23 +02:00
man gui, man, authors: Update docs, translations, and contributors 2021-09-22 07:45:31 +02:00
meta lib: Use counterfeiter to mock interfaces in tests (#7375) 2021-03-03 08:53:50 +01:00
next-gen-gui gui: Semicolons (#7597) 2021-05-03 12:14:54 +02:00
proto gui, lib: Handle pw adding remote encrypted folder (fixes #7705) (#7772) 2021-06-17 13:53:02 +02:00
script all: Update build constraints to Go 1.17 style (#7894) 2021-08-17 10:10:41 +02:00
test all: Update build constraints to Go 1.17 style (#7894) 2021-08-17 10:10:41 +02:00
.codecov.yml build: Add test coverage info (#7502) 2021-04-05 10:25:39 +02:00
.deepsource.toml build: Fix deepsource test & exclude patterns (#7969) 2021-09-26 12:08:59 +02:00
.gitattributes lib/protocol: Revert protobuf encoder changes in v0.14.17 (fixes #3855) 2017-01-01 17:19:00 +00:00
.gitignore Ignore GoLand cruft 2021-05-09 23:56:18 +01:00
.golangci.yml golangci: Skip godox 2019-12-18 11:33:36 +01:00
AUTHORS gui, man, authors: Update docs, translations, and contributors 2021-09-01 07:45:32 +02:00
CONDUCT.md conduct: Upgrade to Contributor Covenant 2018-06-20 23:53:06 +02:00
CONTRIBUTING.md contributing: Fix GitHub format (#7713) 2021-05-31 10:27:35 +02:00
Dockerfile docker: Expose 22000/udp (#7421) 2021-03-02 20:42:25 +01:00
Dockerfile.builder build: Simplify gem command in Debian Docker image 2021-08-17 09:38:42 +02:00
Dockerfile.buildx docker: Expose 22000/udp (#7421) 2021-03-02 20:42:25 +01: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: Remove sysctl from README (#7670) 2021-05-12 22:17:51 +02:00
README.md readme: Add a link to docs source (#7909) 2021-08-29 22:32:46 +02:00
build.go build: Update all dependencies (#7968) 2021-09-26 12:08:23 +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: Update all dependencies (#7968) 2021-09-26 12:08:23 +02:00
go.sum build: Update all dependencies (#7968) 2021-09-26 12:08:23 +02:00
tools.go build: List go:generate tools in tools.go (#7599) 2021-05-08 12:52:06 +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. 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 [source].

All code is licensed under the MPLv2 License.