diff --git a/conf.py b/conf.py index aa3d7c20f..4f80afbdd 100644 --- a/conf.py +++ b/conf.py @@ -54,9 +54,9 @@ copyright = u'2015, The Syncthing Authors' # built documents. # # The short X.Y version. -version = 'v0.11' +version = 'v0.12' # The full version, including alpha/beta/rc tags. -release = 'v0.11' +release = 'v0.12' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/rest/system-debug-get.rst b/rest/system-debug-get.rst new file mode 100644 index 000000000..30a1ebd50 --- /dev/null +++ b/rest/system-debug-get.rst @@ -0,0 +1,34 @@ +GET /rest/system/debug +====================== + +.. versionadded:: 0.12.0 + +Returns the set of debug facilities and which of them are currently enabled. + +.. code-block:: json + + { + "enabled": [ + "beacon" + ], + "facilities": { + "beacon": "Multicast and broadcast discovery", + "config": "Configuration loading and saving", + "connections": "Connection handling", + "db": "The database layer", + "dialer": "Dialing connections", + "discover": "Remote device discovery", + "events": "Event generation and logging", + "http": "REST API", + "main": "Main package", + "model": "The root hub", + "protocol": "The BEP protocol", + "relay": "Relay connection handling", + "scanner": "File change detection and hashing", + "stats": "Persistent device and folder statistics", + "sync": "Mutexes", + "upgrade": "Binary upgrades", + "upnp": "UPnP discovery and port mapping", + "versioner": "File versioning" + } + } diff --git a/rest/system-debug-post.rst b/rest/system-debug-post.rst new file mode 100644 index 000000000..9e11f29c3 --- /dev/null +++ b/rest/system-debug-post.rst @@ -0,0 +1,13 @@ +POST /rest/system/debug +======================= + +.. versionadded:: 0.12.0 + +Enables or disables debugging for specified facilities. Give one or both of +``enable`` and ``disable`` query parameters, with comma separated facility +names. To disable debugging of the beacon and discovery packages, and enable it +for config and db: + +.. code-block:: bash + + $ curl -H X-API-Key:abc123 -X POST 'http://localhost:8385/rest/system/debug?disable=beacon,discovery&enable=config,db' diff --git a/rest/system-error-get.rst b/rest/system-error-get.rst index a3bcf6cbc..b3455a455 100644 --- a/rest/system-error-get.rst +++ b/rest/system-error-get.rst @@ -1,6 +1,8 @@ GET /rest/system/error ====================== +.. note:: Return format changed in 0.12.0. + Returns the list of recent errors. .. code-block:: json @@ -8,8 +10,8 @@ Returns the list of recent errors. { "errors": [ { - "time": "2014-09-18T12:59:26.549953186+02:00", - "error": "This is an error string" + "when": "2014-09-18T12:59:26.549953186+02:00", + "message": "This is an error string" } ] } diff --git a/rest/system-log-get.rst b/rest/system-log-get.rst new file mode 100644 index 000000000..9fbe0042b --- /dev/null +++ b/rest/system-log-get.rst @@ -0,0 +1,17 @@ +GET /rest/system/log +==================== + +.. versionadded:: 0.12.0 + +Returns the list of recent log entries. + +.. code-block:: json + + { + "messages": [ + { + "when": "2014-09-18T12:59:26.549953186+02:00", + "message": "This is a log entry" + } + ] + } diff --git a/users/config.rst b/users/config.rst index 423b3ebe6..e5529a38c 100644 --- a/users/config.rst +++ b/users/config.rst @@ -47,33 +47,42 @@ The following shows the default configuration file: .. code-block:: xml - - - + + + + 1 0 0 0 random + false + 0 + 0 + 0 + 0 - +
dynamic
 -
127.0.0.1:8384
- l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b +
127.0.0.1:52620
+ k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1 - 0.0.0.0:56847 - udp4://announce.syncthing.net:22026 - udp6://announce-v6.syncthing.net:22026 + tcp://0.0.0.0:22000 + default true true - 21025 - [ff32::5222]:21026 + 21027 + [ff12::8384]:21027 + dynamic+https://relays.syncthing.net/endpoint 0 0 60 + true + 10 + false true true 60 @@ -81,6 +90,9 @@ The following shows the default configuration file: 10 0 + https://data.syncthing.net/newdata + false + 1800 true 12 24 @@ -89,6 +101,8 @@ The following shows the default configuration file: true false 0 + 1 + https://api.github.com/repos/syncthing/syncthing/releases?per_page=30 @@ -106,13 +120,19 @@ Folder Element .. code-block:: xml - - + + + 1 0 0 0 random + false + 0 + 0 + 0 + 0 One or more ``folder`` elements must be present in the file. Each element @@ -149,6 +169,11 @@ device Syncthing will currently add this automatically if it is not present in the configuration file. +minDiskFreePct + The percentage of space that should be available on the disk this folder + resides. The folder will be stopped when the percentage of free space goes + below the threshold. Set to zero to disable. + versioning Specifies a versioning configuration. @@ -179,6 +204,24 @@ order Pull files ordered by modification time; oldest and newest first respectively. +ignoreDelete + When set to true, this device will pretend not to see instructions to + delete files from other devices. + +scanProgressIntervalS + The interval with which scan progress information is sent to the GUI. Zero + means the default value (two seconds). + +pullerSleepS, pullerPauseS + Tweaks for rate limiting the puller. Don't change these unless you know + what you're doing. + +maxConflicts + The maximum number of conflict copies to keep around for any given file. + The default, -1, means an unlimited number. Setting this to zero disables + conflict copies altogether. + + Device Element -------------- @@ -297,16 +340,19 @@ Options Element .. code-block:: xml - 0.0.0.0:56847 - udp4://announce.syncthing.net:22026 - udp6://announce-v6.syncthing.net:22026 + tcp://0.0.0.0:22000 + default true true - 21025 - [ff32::5222]:21026 + 21027 + [ff12::8384]:21027 + dynamic+https://relays.syncthing.net/endpoint 0 0 60 + true + 10 + false true true 60 @@ -314,6 +360,9 @@ Options Element 10 0 + https://data.syncthing.net/newdata + false + 1800 true 12 24 @@ -322,20 +371,26 @@ Options Element true false 0 - 60 - 120 + 1 + https://api.github.com/repos/syncthing/syncthing/releases?per_page=30 The ``options`` element contains all other global configuration options. listenAddress The listen address for incoming sync connections. See the ``address`` - element under the `GUI Element`_ for allowed syntax. + element under the `GUI Element`_ for allowed syntax, with the addition + that the address must have a protocol scheme prefix. Currently ``tcp://`` + is the only supported protocol scheme. globalAnnounceServer - A URI to a global announce (discovery) server. Allowed protocol prefixes - are ``udp4://`` (UDP over IPv4), ``udp6://`` (UDP over IPv6) and - ``udp://`` (UDP over any available protocol). + A URI to a global announce (discovery) server, or the word ``default`` to + include the default servers. Any number of globalAnnounceServer elements + may be present. The syntax for non-default entries is that of a HTTP or + HTTPS URL. A number of options may be added as query options to the URL: + ``insecure`` to prevent certificate validation (required for HTTP URLs) + and ``id=`` to perform certificate pinning. The device ID to + use is printed by the discovery server on startup. globalAnnounceEnabled Whether to announce this device to the global announce (discovery) server, @@ -351,6 +406,12 @@ localAnnouncePort localAnnounceMCAddr The group address and port to join and send IPv6 multicast announcements on. +relayServer + Lists one or more relay servers, on the format ``relay://hostname:port``. + Alternatively, a relay list can be loaded over https by using an URL like + ``dynamic+https://somehost/path``. The default loads the list of relays + from the relay pool server, ``relays.syncthing.net``. + maxSendKbps Outgoing data rate limit, in kibibits per second. @@ -361,6 +422,17 @@ reconnectionIntervalS The number of seconds to wait between each attempt to connect to currently unconnected devices. +relaysEnabled + When true, relays will be connected to and potentially used for device to device connections. + +relayReconnectIntervalM + Sets the interval, in minutes, between relay reconnect attempts. + +relayWithoutGlobalAnn + When set to true, relay connections will be attempted even when global + discovery is disabled. This is useful only in the case where devices are + known to be connected to the same relays. The default is ``false``. + startBrowser Whether to attempt to start a browser to show the GUI when Syncthing starts. @@ -387,6 +459,17 @@ urUniqueID The unique ID sent together with the usage report. Generated when usage reporting is enabled. +urURL + The URL to post usage report data to, when enabled. + +urPostInsecurely + When true, the UR URL can be http instead of https, or have a self signed + certificate. The default is ``false``. + +urInitialDelayS + The time to wait from startup to the first usage report being sent. Allows + the system to stabilize before reporting statistics. + restartOnWakeup Whether to perform a restart of Syncthing when it is detected that we are waking from sleep mode (i.e. a folded up laptop). @@ -424,3 +507,10 @@ pingTimeoutS pingIdleTimeS ping interval in seconds. Don't change it unless you feel it's necessary. + +minHomeDiskFreePct + The percentage of space that should be available on the partition holding + the configuration and index. + +releasesURL + The URL from which release information is loaded, for automatic upgrades.