Open Source Continuous File Synchronization
Go to file
Jakob Borg 21e116aa45 lib/scanner: Refactor scanner.Walk API
The old usage pattern was to create a Walker with a bunch of attributes,
then call Walk() on it and nothing else. This extracts the attributes
into a Config struct and exposes a Walk(cfg Config) method instead, as
there was no reason to expose the state-holding walker type.

Also creates a few no-op implementations of the necessary interfaces
so that we can skip nil checks and simiplify things here and there.

Definitely look at this diff without whitespace.

GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/3060
2016-05-09 18:25:39 +00:00
assets Add .gitattributes; normalize line endings 2015-04-25 23:16:46 +09:00
cmd cmd/syncthing: Use random folder ID for default folder, limit random charset 2016-05-09 09:43:40 +00:00
debian build: Parameterize build targets 2016-04-06 22:18:30 +01:00
etc Let "systemctl help" command work 2016-03-16 13:09:01 +00:00
gui all: Correct spelling in comments 2016-05-08 10:54:22 +00:00
lib lib/scanner: Refactor scanner.Walk API 2016-05-09 18:25:39 +00:00
man gui, man: Update docs & translations 2016-05-04 19:47:08 +00:00
script script: Don't verify authors on commits tagged 'Skip-check: authors' 2016-05-08 10:47:57 +00:00
test lib/config: Change folder type attribute to a FolderType type 2016-05-04 11:26:36 +00:00
vendor vendor: Update github.com/gobwas/glob to solve 1.3 build issue 2016-04-20 07:05:08 +00:00
.gitattributes build: Generate gui.files.go on the fly, remove from repo 2016-03-28 10:03:13 +00:00
.gitignore build: Parameterize build targets 2016-04-06 22:18:30 +01:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS Confirmation box for when adding multiple folders on the same path (#1960) 2016-03-17 23:05:37 +00:00
build.go build: Clean up "go vet" and "go lint" steps 2016-04-15 07:26:25 +00:00
build.sh Use Go 1.5 vendoring instead of Godeps 2016-03-05 21:21:24 +01:00
CONDUCT.md Add Code of Conduct 2014-12-02 15:57:31 +01:00
CONTRIBUTING.md Links are nice, too 2015-06-10 00:04:53 +02:00
ISSUE_TEMPLATE.md issue_template: Add note about using forum for support 2016-03-23 20:50:52 +00:00
LICENSE MPLv2 2015-03-17 16:02:27 +01:00
NICKS meta: Amend wweich in NICKS 2016-03-17 21:23: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: Remove Appveyor icon 2016-04-22 20:30:37 +00:00

Syncthing

Latest Build (Official) API Documentation MPLv2 License

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.

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.