octoleo/syncthing
1
0
Fork 0
mirror of https://github.com/octoleo/syncthing.git synced 2024-12-23 03:18:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Open Source Continuous File Synchronization
3,967 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%
3a3c8ec6b8
Go to file
Dale Visser 3a3c8ec6b8 readme: Add Core Infrastructure Initiative Badge 
Skip-check: authors, pr-build

GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/3515
2016-10-17 07:03:52 +00:00
assets gui, assets: Compress PNGs using ZopfliPNG 2016-06-28 06:19:12 +00:00
cmd cmd/syncthing: go fmt traceback.go 2016-10-12 20:37:26 +02:00
etc etc/linux-systemd: Remove bogus dependency on networking for user unit 2016-10-03 03:49:00 +00:00
gui authors: Add Xavier O. 2016-10-07 21:24:47 +01:00
jenkins jenkins: use https when downloading docs (fixes #3651) 2016-10-05 12:17:35 +00:00
lib lib/osutil: Prevent infinite Glob recursion (fixes #3577) 2016-10-12 20:55:38 +00:00
man gui, man: Update docs and translations 2016-10-07 11:09:19 +09:00
script build: Simpler creation of Debian packages 2016-09-12 12:21:07 +00:00
test Add API service for local disk changes 2016-09-28 15:54:13 +00:00
vendor vendor: Update github.com/d4l3k/messagediff 2016-09-13 22:20:22 +02:00
.gitattributes lib/db, lib/fs, lib/model: Introduce fs.MtimeFS, remove VirtualMtimeRepo 2016-08-05 17:45:45 +00:00
.gitignore build: Simpler creation of Debian packages 2016-09-12 12:21:07 +00:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS authors: Add Xavier O. 2016-10-07 21:24:47 +01:00
build.go build: Trivial perf improvement of shouldRebuildAssets 2016-10-09 14:28:20 +02:00
build.sh build, lib: Correct total test coverage calculation 2016-08-08 16:29:32 +00:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md contributing: Clarify license situation for parts of the project 2016-06-01 13:47:25 +00:00
ISSUE_TEMPLATE.md issue_template: Add note about security issues 2016-05-21 22:49:37 +09:00
LICENSE MPLv2 2015-03-17 16:02:27 +01:00
NICKS authors: Add Xavier O. 2016-10-07 21:24:47 +01:00
PULL_REQUEST_TEMPLATE.md pull_request_template: Add note about docs needing update 2016-03-26 07:00:12 +00:00
README.md readme: Add Core Infrastructure Initiative Badge 2016-10-17 07:03:52 +00:00

README.md

Syncthing

Latest Build (Official) API Documentation MPLv2 License CII Best Practices

This is the Syncthing project which pursues the following goals:

  1. Define a protocol for synchronization of a folder between a number of collaborating devices. This protocol should be well defined, unambiguous, easily understood, free to use, efficient, secure and language neutral. This is called the Block Exchange Protocol.

  2. Provide the reference implementation to demonstrate the usability of said protocol. This is the syncthing utility. We hope that alternative, compatible implementations of the protocol will arise.

The two are evolving together; the protocol is not to be considered stable until Syncthing 1.0 is released, at which point it is locked down for incompatible changes.

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. Mac OS X binaries are also properly code signed.

Documentation

Please see the Syncthing documentation site.

All code is licensed under the MPLv2 License.