README
¶
syncthing
This is the syncthing project. The following are the project goals:
-
Define a protocol for synchronization of a folder between a number of collaborating devices. 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.
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 is an IRC channel, #syncthing on Freenode, for talking directly
to developers and users (when awake and present, etc.).
Building
Building Syncthing from source is easy, and there's a guide that describes it for both Unix and Windows.
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). For release binaries, MD5 and SHA1 checksums are calculated and signed, available in the md5sum.txt.asc and sha1sum.txt.asc files.
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 GPL, v3 or later.
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_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/calmh/logger
Package logger implements a standardized logger with callback functionality
|
Package logger implements a standardized logger with callback functionality |
|
_workspace/src/github.com/calmh/osext
Extensions to the standard "os" package.
|
Extensions to the standard "os" package. |
|
_workspace/src/github.com/calmh/xdr
Package xdr implements an XDR (RFC 4506) encoder/decoder.
|
Package xdr implements an XDR (RFC 4506) encoder/decoder. |
|
_workspace/src/github.com/juju/ratelimit
The ratelimit package provides an efficient token bucket implementation.
|
The ratelimit package provides an efficient token bucket implementation. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb
Package leveldb provides implementation of LevelDB key/value database.
|
Package leveldb provides implementation of LevelDB key/value database. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/cache
Package cache provides interface and implementation of a cache algorithms.
|
Package cache provides interface and implementation of a cache algorithms. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/comparer
Package comparer provides interface and implementation for ordering sets of data.
|
Package comparer provides interface and implementation for ordering sets of data. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/errors
Package errors provides common error types used throughout leveldb.
|
Package errors provides common error types used throughout leveldb. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/filter
Package filter provides interface and implementation of probabilistic data structure.
|
Package filter provides interface and implementation of probabilistic data structure. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/iterator
Package iterator provides interface and implementation to traverse over contents of a database.
|
Package iterator provides interface and implementation to traverse over contents of a database. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/journal
Package journal reads and writes sequences of journals.
|
Package journal reads and writes sequences of journals. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/memdb
Package memdb provides in-memory key/value database implementation.
|
Package memdb provides in-memory key/value database implementation. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/opt
Package opt provides sets of options used by LevelDB.
|
Package opt provides sets of options used by LevelDB. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/storage
Package storage provides storage abstraction for LevelDB.
|
Package storage provides storage abstraction for LevelDB. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/table
Package table allows read and write sorted key/value.
|
Package table allows read and write sorted key/value. |
|
_workspace/src/github.com/syndtr/goleveldb/leveldb/util
Package util provides utilities used throughout leveldb.
|
Package util provides utilities used throughout leveldb. |
|
_workspace/src/github.com/syndtr/gosnappy/snappy
Package snappy implements the snappy block-based compression format.
|
Package snappy implements the snappy block-based compression format. |
|
_workspace/src/github.com/vitrun/qart/coding
Package coding implements low-level QR coding details.
|
Package coding implements low-level QR coding details. |
|
_workspace/src/github.com/vitrun/qart/gf256
Package gf256 implements arithmetic over the Galois Field GF(256).
|
Package gf256 implements arithmetic over the Galois Field GF(256). |
|
cmd
|
|
|
internal
|
|
|
auto
Package auto contains auto generated files for web assets.
|
Package auto contains auto generated files for web assets. |
|
beacon
Package beacon implements an UDP broadcast beacon
|
Package beacon implements an UDP broadcast beacon |
|
config
Package config implements reading and writing of the syncthing configuration file.
|
Package config implements reading and writing of the syncthing configuration file. |
|
discover
Package discover implements the device discovery protocol.
|
Package discover implements the device discovery protocol. |
|
events
Package events provides event subscription and polling functionality.
|
Package events provides event subscription and polling functionality. |
|
files
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. |
|
lamport
Package lamport implements a simple Lamport Clock for versioning
|
Package lamport implements a simple Lamport Clock for versioning |
|
luhn
Package luhn generates and validates Luhn mod N check digits.
|
Package luhn generates and validates Luhn mod N check digits. |
|
model
Package model implements folder abstraction and file pulling mechanisms
|
Package model implements folder abstraction and file pulling mechanisms |
|
osutil
Package osutil implements utilities for native OS support.
|
Package osutil implements utilities for native OS support. |
|
protocol
Package protocol implements the Block Exchange Protocol.
|
Package protocol implements the Block Exchange Protocol. |
|
scanner
Package scanner implements a file system scanner and hasher.
|
Package scanner implements a file system scanner and hasher. |
|
upgrade
Package upgrade downloads and compares releases, and upgrades the running binary.
|
Package upgrade downloads and compares releases, and upgrades the running binary. |
|
upnp
Package upnp implements UPnP InternetGatewayDevice discovery, querying, and port mapping.
|
Package upnp implements UPnP InternetGatewayDevice discovery, querying, and port mapping. |
|
versioner
Package versioner implements common interfaces for file versioning and a simple default versioning scheme.
|
Package versioner implements common interfaces for file versioning and a simple default versioning scheme. |
Click to show internal directories.
Click to hide internal directories.