- Go 84.6%
- HTML 7.1%
- JavaScript 5.7%
- Shell 1.8%
- CSS 0.7%
6df85dc95cWe had a few places where we had perhaps too much of an opinion on the permissions on created files and directories, sometimes fuled by a misconception about how permissions work in both Unix and Windows. Recap on the ground rules: - On all unixes, all file & directory creation (`Mkdir`, `MkdirAll`, `Create`, `WriteFile`, `Open`) has the given permission bits filtered via the user's umask. The proper permissions for us to use are in almost all cases 0o666 for files and 0o777 for directories, strange as that may look at the call site. - On Windows, there is no umask but in turn all of the permission bits except the user write bit are ignored. The absence of user write bit is converted into the read only attribute. This means that what is proper for Unix above is also proper for Windows. - We make an exception when creating files for certificate keys and the config / database directories, as those contain secrets we think should remain closed even if the user generally collaborates with other users on the system. (Also removal of a bugfixed copy of MkdirAll for Windows that hasn't been necessary for a few years.) --------- Signed-off-by: Jakob Borg <jakob@kastelo.net> |
||
|---|---|---|
| .github | ||
| assets | ||
| cmd | ||
| etc | ||
| gui | ||
| internal | ||
| lib | ||
| man | ||
| meta | ||
| proto | ||
| relnotes | ||
| script | ||
| test | ||
| .codecov.yml | ||
| .deepsource.toml | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| .policy.yml | ||
| .yamlfmt | ||
| AUTHORS | ||
| buf.gen.yaml | ||
| buf.yaml | ||
| build.go | ||
| build.ps1 | ||
| build.sh | ||
| compat.yaml | ||
| CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| Dockerfile.builder | ||
| Dockerfile.stcrashreceiver | ||
| Dockerfile.stdiscosrv | ||
| Dockerfile.strelaypoolsrv | ||
| Dockerfile.strelaysrv | ||
| Dockerfile.stupgrades | ||
| Dockerfile.ursrv | ||
| go.mod | ||
| go.sum | ||
| GOALS.md | ||
| LICENSE | ||
| README-Docker.md | ||
| README.md | ||
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.
Syncthing should be:
-
Safe From Data Loss
Protecting the user's data is paramount. We take every reasonable precaution to avoid corrupting the user's files.
-
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.
-
Easy to Use
Syncthing should be approachable, understandable, and inclusive.
-
Automatic
User interaction should be required only when absolutely necessary.
-
Universally Available
Syncthing should run on every common computer. We are mindful that the latest technology is not always available to every individual.
-
For Individuals
Syncthing is primarily about empowering the individual user with safe, secure, and easy to use file synchronization.
-
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.
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.
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 with more details on the
build process.
Signed Releases
Release binaries are GPG signed with the key available from https://syncthing.net/security/. There is also a built-in automatic upgrade mechanism (disabled in some distribution channels) which uses a compiled in ECDSA signature. macOS and Windows binaries are also code-signed.
Documentation
Please see the Syncthing documentation site [source].
All code is licensed under the MPLv2 License.