Open Source Continuous File Synchronization
Go to file
Jakob Borg ffe7a2fcd7 cmd/syncthing, lib/config: Enable HTTP CPU/heap profile collection for users
This adds a config to enable debug functions on the API server, which is
by default disabled. When enabled, the /rest/debug things become
available and become available without requiring a CSRF token (although
authentication is required if configured).

We also add a new endpoint /rest/debug/cpuprof?duration=15s (with the
duration being configurable, defaulting to 30s). This runs a CPU profile
for the duration and returns it as a file. It sets headers so that a
browser will save the file with an informative name.

The same is done for heap profiles, /rest/debug/heapprof, which does not
take any parameters.

The purpose of this is that any user can enable debugging under
advanced, then point their browser to the endpoint above and get a file
that contains a CPU or heap profile we can use, with the filename
telling us what version and architecture the profile is from.

On the command line, this becomes

    curl -O -J http://localhost:8082/rest/debug/cpuprof?duration=5s
    curl: Saved to filename
    'syncthing-cpu-darwin-amd64-v0.14.3+4-g935bcc0-110307.pprof'

GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/3467
2016-08-02 11:06:45 +00:00
assets gui, assets: Compress PNGs using ZopfliPNG 2016-06-28 06:19:12 +00:00
cmd cmd/syncthing, lib/config: Enable HTTP CPU/heap profile collection for users 2016-08-02 11:06:45 +00:00
debtpl debian: Rename debian directory to debtpl (fixes #3099) 2016-05-26 16:37:09 +00:00
etc etc: Add documentation key to syncthing-resume.service 2016-05-17 20:19:35 +00:00
gui gui: Add one-off notifications that need to be acked 2016-08-02 08:07:30 +00:00
lib cmd/syncthing, lib/config: Enable HTTP CPU/heap profile collection for users 2016-08-02 11:06:45 +00:00
man gui, man: Update docs & translations 2016-07-28 13:15:14 +02:00
script script: Copyright in protofmt.go 2016-07-04 14:55:17 +02:00
test cmd/syncthing, lib/config: Enable HTTP CPU/heap profile collection for users 2016-08-02 11:06:45 +00:00
vendor vendor: Update to latest github.com/syndtr/goleveldb 2016-07-06 09:57:15 +02:00
.gitattributes build: Generate gui.files.go on the fly, remove from repo 2016-03-28 10:03:13 +00:00
.gitignore build, cmd/stdiscosrv, cmd/strelaysrv: Rename binaries to add "st" prefix 2016-07-04 10:51:22 +00:00
.mailmap Include ref#, show author nickname in release notes 2014-12-07 12:52:18 +01:00
AUTHORS authors: Add xduugu 2016-06-18 21:04:32 +02:00
build.go build: Allow easy influencing build user and build host 2016-07-27 23:27:47 +02:00
build.sh build: Remove unused docker-* commands 2016-07-25 08:10:46 +02: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 xduugu 2016-06-18 21:04:32 +02:00
PULL_REQUEST_TEMPLATE.md pull_request_template: Add note about docs needing update 2016-03-26 07:00:12 +00:00
README.md repo: Add message about voting 2016-07-09 15:58:55 +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.

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.