Merge pull request #1 from syncthing/master

Bringing Up to Date
2016-01-07 20:51:22 +10:00
parent 008e5a0ac0 8ad18f22b0
commit e3eaa4110e
7 changed files with 35 additions and 11 deletions
@@ -64,6 +64,14 @@ Runs Jenkins and does the core and Android builds, Ubuntu Linux.
 - build2.syncthing.net (build runner, SmartOS container, 8192 MB)
 - `android.syncthing.net <http://android.syncthing.net/>`__ (Ubuntu Linux, 3072 MB)

+Build Servers, Other
+--------------------
+
+Runs a Jenkins slave and builds release builds for their respective OS.
+
+- native-windows-amd64 (Windows 2012 R2, Amazon EC2 t2.micro)
+- native-darwin-amd64 (Mac OS X 10.8.5, MacBookPro5,1)
+
 APT Server
 ----------

@@ -337,7 +337,7 @@ folder Flags field contains the following single bit flags:
     0                   1                   2                   3
     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-    |                       Reserved                          |D|P|R|
+    |                       Reserved                  | Hash  |D|P|R|
    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

 :Bit 31 ("R", Read Only):
@@ -351,6 +351,14 @@ folder Flags field contains the following single bit flags:
 :Bit 29 ("D", Ignore Deletes):
    is set for folders that the device will ignore deletes for.

+:Bits 25-28 (Hash):
+    indicates the hash algorithm in use for this folder, as a four bit integer.
+    The value values are:
+
+    - 0: SHA256
+    - 1: Murmur3-128
+    - 2-15: Reserved for future usage
+
 The **Options** field contains a list of options that apply to the folder.

 Fields (Device Structure)
@@ -151,7 +151,8 @@ ro
    Syncthing) on this device.

 rescanIntervalS
-    The rescan interval, in seconds.
+    The rescan interval, in seconds. Can be set to zero to disable when external
+    plugins are used to trigger rescans.

 ignorePerms
    True if the folder should ignore permissions.
@@ -450,7 +451,7 @@ upnpTimeoutSeconds
    When scanning for UPnP devices, wait this long for responses.

 urAccepted
-    Whether the user as accepted to submit anonymous usage data. The default,
+    Whether the user has accepted to submit anonymous usage data. The default,
    ``0``, mean the user has not made a choice, and Syncthing will ask at some
    point in the future. ``-1`` means no, a number above zero means that that
    version of usage reporting has been accepted.
@@ -463,7 +464,7 @@ 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
+    When true, the UR URL can be http instead of https, or have a self-signed
    certificate. The default is ``false``.

 urInitialDelayS
@@ -487,7 +488,8 @@ cacheIgnoredFiles
    the price of memory.

 progressUpdateIntervalS
-    .. note:: Requires explanation.
+    How often in seconds the progress of ongoing downloads is made available to
+    the GUI.

 symlinksEnabled
    Whether to sync symlinks, if supported by the system.
@@ -503,10 +505,10 @@ databaseBlockCacheMiB

 pingTimeoutS
    Ping-timeout in seconds. Don't change it unless you are having issues due to
-    slow response time (slow connection/cpu) and large index exchanges
+    slow response time (slow connection/cpu) and large index exchanges.

 pingIdleTimeS
-    ping interval in seconds. Don't change it unless you feel it's necessary.
+    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
@@ -523,7 +525,7 @@ using the same configuration files) can cause issues. This is easy to do
 accidentally if you sync your home folder between devices. A common symptom
 of syncing configuration files is two devices ending up with the same Device ID.

-If you want to use syncthing to backup your configuration files, it is recommended
+If you want to use Syncthing to backup your configuration files, it is recommended
 that the files you are backing up are in a :ref:`folder-master` to prevent other
 devices from overwriting the per device configuration. The folder on the remote
 device(s) should not be used as configuration for the remote devices.
@@ -103,8 +103,7 @@ Synology NAS
   the files at https://synocommunity.com/packages). Numerous CPU
   architectures are supported. SPK's may be older versions, however you
   can execute a Syncthing version upgrade via Web-GUI after
-   installation on Synology device. As Syncthing is marked as beta by
-   the SynoCommunity, you need to enable beta-versions in the settings.
+   installation on Synology device.

 QNAP NAS
 ~~~~~~~~
@@ -26,6 +26,12 @@ to select a different location.
 Configuring
 -----------

+.. note::
+   If you are running an instance of syncthing on the discovery server,
+   you must either add that instance to other nodes using a static 
+   address or bind the discovery server and syncthing instances to
+   different IP addresses.
+
 Running discosrv with non-default settings requires passing the
 respective parameters to discosrv on every start. ``discosrv -help``
 gives you all the tweakables with their defaults:
@@ -100,7 +100,8 @@ the following script and store it as ``/Users/jb/bin/onlylatest.sh`` (i.e. the
    filepath="$2"

    # First ensure the dir where we need to store the file exists
-    mkdir -p `dirname "$versionspath/$filepath"`
+    outpath=`dirname "$versionspath/$filepath"`
+    mkdir -p "$outpath"
    # Then move the file there
    mv -f "$folderpath/$filepath" "$versionspath/$filepath"