README
¶
syncthing
This is the syncthing project. The following are the project goals:
-
Define a protocol for synchronization of a file repository between a number of collaborating nodes. The protocol should be well defined, unambiguous, easily understood, free to use, efficient, secure and language neutral. This is the Block Exchange Protocol.
-
Provide the reference implementation to demonstrate the usability of said protocol. This is the
syncthingutility. It is the hope that alternative, compatible implementations of the protocol will come to exist.
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.
Syncthing does not use the BitTorrent protocol. The reasons for this are
- we don't know if BitTorrent Sync does either, so there's nothing to be compatible with, 2) BitTorrent includes a lot of functionality for making sure large swarms of selfish agents behave and somehow work towards a common goal. Here we have a much smaller swarm of cooperative agents and a simpler approach will suffice.
Getting Started
Take a look at the getting started guide.
Signed Releases
As of v0.7.0 and onwards, git tags and release binaries are GPG signed with
the key BCE524C7 (http://nym.se/gpg.txt). The signature is included in the
normal release bundle as syncthing.asc or syncthing.exe.asc.
Documentation
The syncthing documentation is on the discourse site.
License
All documentation and protocol specifications are licensed under the Creative Commons Attribution 4.0 International License.
All code is licensed under the MIT License.
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/bitbucket.org/kardianos/osext
Extensions to the standard "os" package.
|
Extensions to the standard "os" package. |
|
_workspace/src/code.google.com/p/go.crypto/bcrypt
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm.
|
Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing algorithm. |
|
_workspace/src/code.google.com/p/go.crypto/blowfish
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm.
|
Package blowfish implements Bruce Schneier's Blowfish encryption algorithm. |
|
_workspace/src/code.google.com/p/go.text/transform
Package transform provides reader and writer wrappers that transform the bytes passing through as well as various transformations.
|
Package transform provides reader and writer wrappers that transform the bytes passing through as well as various transformations. |
|
_workspace/src/code.google.com/p/go.text/unicode/norm
Package norm contains types and functions for normalizing Unicode strings.
|
Package norm contains types and functions for normalizing Unicode strings. |
|
_workspace/src/github.com/codegangsta/inject
Package inject provides utilities for mapping and injecting dependencies in various ways.
|
Package inject provides utilities for mapping and injecting dependencies in various ways. |
|
_workspace/src/github.com/codegangsta/martini
Package martini is a powerful package for quickly writing modular web applications/services in Golang.
|
Package martini is a powerful package for quickly writing modular web applications/services in Golang. |
|
_workspace/src/github.com/golang/groupcache/lru
Package lru implements an LRU cache.
|
Package lru implements an LRU cache. |
|
_workspace/src/github.com/juju/ratelimit
The ratelimit package provides an efficient token bucket implementation.
|
The ratelimit package provides an efficient token bucket implementation. |
|
Package auto contains auto generated files for web assets.
|
Package auto contains auto generated files for web assets. |
|
Package beacon implements an UDP broadcast beacon
|
Package beacon implements an UDP broadcast beacon |
|
Package buffers manages a set of reusable byte buffers.
|
Package buffers manages a set of reusable byte buffers. |
|
Package cid provides a manager for mappings between node ID:s and connection ID:s.
|
Package cid provides a manager for mappings between node ID:s and connection ID:s. |
|
cmd
|
|
|
Package config implements reading and writing of the syncthing configuration file.
|
Package config implements reading and writing of the syncthing configuration file. |
|
Package discover implements the node discovery protocol.
|
Package discover implements the node discovery protocol. |
|
Package files provides a set type to track local/remote files with newness checks.
|
Package files provides a set type to track local/remote files with newness checks. |
|
Package lamport implements a simple Lamport Clock for versioning
|
Package lamport implements a simple Lamport Clock for versioning |
|
Package logger implements a standardized logger with callback functionality
|
Package logger implements a standardized logger with callback functionality |
|
Package model implements repository abstraction and file pulling mechanisms
|
Package model implements repository abstraction and file pulling mechanisms |
|
Package protocol implements the Block Exchange Protocol.
|
Package protocol implements the Block Exchange Protocol. |
|
Package scanner implements a file system scanner and hasher.
|
Package scanner implements a file system scanner and hasher. |
|
Package upnp implements UPnP Internet Gateway upnpDevice port mappings
|
Package upnp implements UPnP Internet Gateway upnpDevice port mappings |
|
Package xdr implements an XDR (RFC 4506) encoder/decoder.
|
Package xdr implements an XDR (RFC 4506) encoder/decoder. |