Open Source Continuous File Synchronization; contains branches to build Syncthing as a C library
Go to file
Martchus 5e9e226f5b Add basic C bindings to start and stop Syncthing and invoke its CLI 2023-08-09 11:33:06 +02:00
.github build: Run govulncheck (fixes #8983) 2023-07-30 14:38:36 +02:00
assets assets, gui: Losslessly compress all JPG, PNG, and PDF images (#6265) 2020-01-16 13:52:43 +01:00
c-bindings Add basic C bindings to start and stop Syncthing and invoke its CLI 2023-08-09 11:33:06 +02:00
cmd Add basic C bindings to start and stop Syncthing and invoke its CLI 2023-08-09 11:33:06 +02:00
etc etc: Update sysctl configs (#8955) 2023-06-28 07:05:12 +02:00
gui gui, man, authors: Update docs, translations, and contributors 2023-07-31 03:45:37 +00:00
lib all: Refactor the protocol/model interface a bit (ref #8981) (#9007) 2023-07-29 10:24:44 +02:00
man gui, man, authors: Update docs, translations, and contributors 2023-07-31 03:45:37 +00:00
meta build: Add more GitHub Actions 2023-02-22 10:56:55 +01:00
next-gen-gui all: Fix typos found by codespell (#8833) 2023-03-21 08:07:28 +01:00
proto lib/config, lib/connections: Configurable protocol priority (ref #8626) (#8868) 2023-04-16 14:54:28 +02:00
script cmd, docker: Updates for infrastructure 2023-01-31 11:17:52 +01:00
test all: Correct various typos (#8870) 2023-05-09 08:54:02 +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
.yamlfmt build: Add more GitHub Actions 2023-02-22 10:56:55 +01:00
AUTHORS gui, man, authors: Update docs, translations, and contributors 2023-07-31 03:45:37 +00:00
CONDUCT.md conduct: Upgrade to Contributor Covenant 2018-06-20 23:53:06 +02:00
CONTRIBUTING.md gui: Switch to Weblate for translations (#8777) 2023-02-07 12:22:08 +01:00
Dockerfile cmd/syncthing: Add environment variables for --home, --conf, and --data (fixes #8957) (#8952) 2023-06-28 07:03:36 +02:00
Dockerfile.builder build: Simplify gem command in Debian Docker image 2021-08-17 09:38:42 +02:00
Dockerfile.stcrashreceiver build: Build infrastructure images 2023-07-01 08:23:55 +02:00
Dockerfile.stdiscosrv build: Build and publish Docker images for relay and discovery server (fixes #8691, fixes #8960) 2023-07-01 08:48:12 +02:00
Dockerfile.strelaypoolsrv build: Build infrastructure images 2023-07-01 08:23:55 +02:00
Dockerfile.strelaysrv build: Build and publish Docker images for relay and discovery server (fixes #8691, fixes #8960) 2023-07-01 08:48:12 +02:00
Dockerfile.stupgrades build: Build infrastructure images 2023-07-01 08:23:55 +02:00
GOALS.md all: Fix various user-facing and non-user-facing typos (#8509) 2022-08-23 15:44:11 +02:00
LICENSE all: Update license url to https (ref #3976) 2017-02-09 08:04:16 +01:00
README-Docker.md docker: Add env var to control capabilities (#8552) 2022-09-26 13:39:41 +02:00
README.md readme: Remove outdated build badges/links 2023-07-03 13:03:09 +02:00
build.go cmd/ursrv: Merge ursrv and uraggregate as subcommands 2023-07-10 09:00:57 +02:00
build.ps1 build: Clean up build.sh, add build.ps1 (#6689) 2020-05-28 12:42:15 +02:00
build.sh gui: Switch to Weblate for translations (#8777) 2023-02-07 12:22:08 +01:00
go.mod build: Update dependencies 2023-07-11 09:14:21 +02:00
go.sum build: Update dependencies 2023-07-11 09:14:21 +02:00
tools.go build: Update quic-go for Go 1.19 (#8483) 2022-08-03 15:43:26 +02:00

README.md

Syncthing


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. After extracting the source bundle from a release or checking out git, you just need to run go run build.go and the binaries are created in ./bin. There's a guide with more details on the build process.

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.