octoleo/syncthing
1
0
Fork 0
mirror of https://github.com/octoleo/syncthing.git synced 2024-12-22 02:48:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Open Source Continuous File Synchronization
4,796 Commits 40 Branches 558 Tags 128 MiB
Go 82.5%
HTML 6.8%
JavaScript 5.4%
TypeScript 2.6%
Shell 1.7%
Other 0.9%
6df3940c26
Go to file
Jakob Borg 6df3940c26 conduct: Upgrade to Contributor Covenant 
It's pretty much the GitHub standard, says the obvious, and does it
better than our old one which was a little bit rambling.

Intentionally just doing it instead of discussing it, in the hope of
avoiding trolling. So sue me.
2018-06-20 23:53:06 +02:00
.github github: I want to review changes to the AUTHORS file and top level READMEs 2018-02-04 22:54:38 +01:00
assets assets: Use icon from synctrayzor (ref #4839) (#4859) 2018-04-02 19:57:01 -04:00
cmd cmd/syncthing: Correctly compare If-Modified-Since in HTTP server (#5016) 2018-06-18 08:14:17 +02:00
etc all: Transition to using fs watcher by default (fixes #4552) 2018-03-25 21:05:47 +01:00
gui gui: kiB -> KiB (fixes #5017) (#5021) 2018-06-20 16:51:30 +02:00
lib lib/db: Remove updated invalid files from need bucket (fixes #5007) (#5008) 2018-06-18 08:23:40 +02:00
man gui, man: Update docs & translations 2018-06-06 07:45:29 +02:00
meta meta: Fix authors check 2018-02-07 17:32:26 +01:00
script script: Use strings instead of byte slice literals in asset generation 2018-06-13 23:48:50 +02:00
test test: Migrate test configs to current version 2018-06-08 12:39:17 +02:00
vendor all: Use Executable from os instead of osext (fixes #4900) (#4950) 2018-05-13 07:43:24 +02:00
.gitattributes lib/protocol: Revert protobuf encoder changes in v0.14.17 (fixes #3855) 2017-01-01 17:19:00 +00:00
.gitignore jenkins: Build snap 2016-10-20 09:31:07 +00:00
AUTHORS authors: Add xjtdy888 2018-05-09 08:42:27 +02:00
build.go build: MacOS X is now macOS; don't presume to know all possible goarchs 2018-06-13 23:20:52 +02:00
build.sh build: Remove ulimit from build.sh 2018-01-08 17:51:59 +00:00
CONDUCT.md conduct: Upgrade to Contributor Covenant 2018-06-20 23:53:06 +02:00
CONTRIBUTING.md all: Update docs.s.n links to use https 2016-10-27 17:02:19 +00:00
Dockerfile dockerfile: Incorporate exposed ports, add volume (#4908) 2018-05-05 10:28:19 +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: Add README from old Docker repo (fixes #4868) (#4869) 2018-04-09 10:48:37 +02:00
README.md all: Mac OS X is now called macOS 2018-01-27 09:07:19 +00:00
snapcraft.yaml.template snapcraft: s/snap/prime (fixes #3955) 2017-02-05 15:03:36 +01:00

README.md

Syncthing

Latest Downloads 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.

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. There is also an IRC channel, #syncthing on freenode (with a web client), for talking directly to developers and users. 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.

All code is licensed under the MPLv2 License.