2017-04-07 05:21:11 +00:00
[![Syncthing][14]][15]
---
2013-12-15 10:43:31 +00:00
2017-09-01 12:23:17 +00:00
[](https://build.syncthing.net/viewType.html?buildTypeId=Syncthing_BuildLinuxCross& guest=1)
[](https://build.syncthing.net/viewType.html?buildTypeId=Syncthing_BuildWindows& guest=1)
[](https://build.syncthing.net/viewType.html?buildTypeId=Syncthing_BuildMac& guest=1)
2015-09-02 09:57:00 +00:00
[](https://www.mozilla.org/MPL/2.0/)
2016-10-17 07:03:52 +00:00
[](https://bestpractices.coreinfrastructure.org/projects/88)
2017-02-05 17:54:25 +00:00
[](https://goreportcard.com/report/github.com/syncthing/syncthing)
2014-07-31 10:56:05 +00:00
2017-01-19 17:12:40 +00:00
## Goals
2013-12-15 10:43:31 +00:00
2017-02-05 17:58:06 +00:00
Syncthing is a **continuous file synchronization program** . It synchronizes
2017-01-19 17:12:40 +00:00
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][13].
2013-12-15 10:43:31 +00:00
2017-01-19 17:12:40 +00:00
Syncthing should be:
2013-12-15 10:43:31 +00:00
2017-12-07 09:43:00 +00:00
1. **Safe From Data Loss**
2017-01-19 17:12:40 +00:00
Protecting the user's data is paramount. We take every reasonable
precaution to avoid corrupting the user's files.
2017-12-07 09:43:00 +00:00
2. **Secure Against Attackers**
2017-01-19 17:12:40 +00:00
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.
2017-12-07 09:43:00 +00:00
3. **Easy to Use**
2017-01-19 17:12:40 +00:00
Syncthing should be approachable, understandable and inclusive.
2017-12-07 09:43:00 +00:00
4. **Automatic**
2017-01-19 17:12:40 +00:00
User interaction should be required only when absolutely necessary.
2017-12-07 09:43:00 +00:00
5. **Universally Available**
2017-01-19 17:12:40 +00:00
Syncthing should run on every common computer. We are mindful that the
latest technology is not always available to any given individual.
2017-12-07 09:43:00 +00:00
6. **For Individuals**
2017-01-19 17:12:40 +00:00
Syncthing is primarily about empowering the individual user with safe,
secure and easy to use file synchronization.
2017-12-07 09:43:00 +00:00
7. **Everything Else**
2017-01-19 17:12:40 +00:00
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.
2013-12-15 10:43:31 +00:00
2015-09-10 19:42:07 +00:00
## Getting Started
2014-04-30 14:13:29 +00:00
2015-09-10 19:42:07 +00:00
Take a look at the [getting started guide][2].
2014-08-19 13:33:20 +00:00
2015-05-31 07:35:17 +00:00
There are a few examples for keeping Syncthing running in the background
2016-03-02 06:50:15 +00:00
on your system in [the etc directory][3]. There are also several [GUI
implementations][11] for Windows, Mac and Linux.
2014-11-24 12:47:56 +00:00
2019-09-22 10:33:29 +00:00
## Docker
2019-09-23 04:28:42 +00:00
To run Syncthing in Docker, see [the Docker README][16].
2019-09-22 10:33:29 +00:00
2016-07-09 15:58:55 +00:00
## Vote on features/bugs
We'd like to encourage you to [vote][12] 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.
2016-01-03 12:07:22 +00:00
## Getting in Touch
2021-05-26 12:59:49 +00:00
The first and best point of contact is the [Forum][8].
If you've found something that is clearly a
2016-01-03 12:07:22 +00:00
bug, feel free to report it in the [GitHub issue tracker][10].
2014-11-24 22:04:12 +00:00
2015-09-10 19:42:07 +00:00
## Building
2014-08-19 13:33:20 +00:00
2022-05-06 05:56:26 +00:00
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][5] with more details on the
build process.
2014-04-30 14:13:29 +00:00
2015-09-10 19:42:07 +00:00
## Signed Releases
2014-03-21 06:40:48 +00:00
2016-03-02 06:50:15 +00:00
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
2018-01-27 09:07:19 +00:00
distribution channels) which uses a compiled in ECDSA signature. macOS
binaries are also properly code signed.
2014-03-21 06:40:48 +00:00
2015-09-10 19:42:07 +00:00
## Documentation
2013-12-15 10:43:31 +00:00
2021-08-29 20:32:46 +00:00
Please see the Syncthing [documentation site][6] [[source]][17].
2014-01-06 20:17:18 +00:00
2015-09-10 19:42:07 +00:00
All code is licensed under the [MPLv2 License][7].
2016-10-27 17:02:19 +00:00
[1]: https://docs.syncthing.net/specs/bep-v1.html
[2]: https://docs.syncthing.net/intro/getting-started.html
2020-06-16 05:01:55 +00:00
[3]: https://github.com/syncthing/syncthing/blob/main/etc
2016-10-27 17:02:19 +00:00
[5]: https://docs.syncthing.net/dev/building.html
[6]: https://docs.syncthing.net/
2020-06-16 05:01:55 +00:00
[7]: https://github.com/syncthing/syncthing/blob/main/LICENSE
2016-01-03 12:07:22 +00:00
[8]: https://forum.syncthing.net/
[10]: https://github.com/syncthing/syncthing/issues
2016-10-27 17:02:19 +00:00
[11]: https://docs.syncthing.net/users/contrib.html#gui-wrappers
2016-07-09 15:58:55 +00:00
[12]: https://www.bountysource.com/teams/syncthing/issues
2020-06-16 05:01:55 +00:00
[13]: https://github.com/syncthing/syncthing/blob/main/GOALS.md
2017-04-07 05:21:11 +00:00
[14]: assets/logo-text-128.png
2017-09-01 12:23:17 +00:00
[15]: https://syncthing.net/
2020-06-16 05:01:55 +00:00
[16]: https://github.com/syncthing/syncthing/blob/main/README-Docker.md
2022-05-06 05:56:26 +00:00
[17]: https://github.com/syncthing/docs
