mirror of
https://github.com/octoleo/syncthing.git
synced 2024-11-10 07:11:08 +00:00
120 lines
4.3 KiB
Markdown
120 lines
4.3 KiB
Markdown
[![Syncthing][14]][15]
|
||
|
||
---
|
||
|
||
[](https://www.mozilla.org/MPL/2.0/)
|
||
[](https://bestpractices.coreinfrastructure.org/projects/88)
|
||
[](https://goreportcard.com/report/github.com/syncthing/syncthing)
|
||
|
||
## 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 ones first.
|
||
This is the summary version of the goal list - for more
|
||
commentary, see the full [Goals document][13].
|
||
|
||
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 every 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][2].
|
||
|
||
There are a few examples for keeping Syncthing running in the background
|
||
on your system in [the etc directory][3]. There are also several [GUI
|
||
implementations][11] for Windows, Mac, and Linux.
|
||
|
||
## Docker
|
||
|
||
To run Syncthing in Docker, see [the Docker README][16].
|
||
|
||
## 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.
|
||
|
||
## Getting in Touch
|
||
|
||
The first and best point of contact is the [Forum][8].
|
||
If you've found something that is clearly a
|
||
bug, feel free to report it in the [GitHub issue tracker][10].
|
||
|
||
If you believe that you’ve found a Syncthing-related security vulnerability,
|
||
please report it by emailing security@syncthing.net. Do not report it in the
|
||
Forum or 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][5] 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][6] [[source]][17].
|
||
|
||
All code is licensed under the [MPLv2 License][7].
|
||
|
||
[1]: https://docs.syncthing.net/specs/bep-v1.html
|
||
[2]: https://docs.syncthing.net/intro/getting-started.html
|
||
[3]: https://github.com/syncthing/syncthing/blob/main/etc
|
||
[5]: https://docs.syncthing.net/dev/building.html
|
||
[6]: https://docs.syncthing.net/
|
||
[7]: https://github.com/syncthing/syncthing/blob/main/LICENSE
|
||
[8]: https://forum.syncthing.net/
|
||
[10]: https://github.com/syncthing/syncthing/issues
|
||
[11]: https://docs.syncthing.net/users/contrib.html#gui-wrappers
|
||
[12]: https://www.bountysource.com/teams/syncthing/issues
|
||
[13]: https://github.com/syncthing/syncthing/blob/main/GOALS.md
|
||
[14]: assets/logo-text-128.png
|
||
[15]: https://syncthing.net/
|
||
[16]: https://github.com/syncthing/syncthing/blob/main/README-Docker.md
|
||
[17]: https://github.com/syncthing/docs
|