Skip to content

Commit 071d108

Browse files
maen-bncalmh
andauthored
docs(config): add grouping folders and devices (#1001)
Document upcoming fuctionality addtion for grouping done in syncthing/syncthing#10563 --------- Signed-off-by: Ben Norcombe <bennorcombe@pm.me> Signed-off-by: Jakob Borg <jakob@kastelo.net> Co-authored-by: Jakob Borg <jakob@kastelo.net>
1 parent 84bd234 commit 071d108

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

users/config.rst

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ The following shows an example of a default configuration file (IDs will differ)
100100
.. code-block:: xml
101101
102102
<configuration version="37">
103-
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
103+
<folder id="default" label="Default Folder" group="Home" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
104104
<filesystemType>basic</filesystemType>
105105
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
106106
<encryptionPassword></encryptionPassword>
@@ -135,7 +135,7 @@ The following shows an example of a default configuration file (IDs will differ)
135135
<syncXattrs>false</syncXattrs>
136136
<sendXattrs>false</sendXattrs>
137137
</folder>
138-
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
138+
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" name="syno" group="Personal" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
139139
<address>dynamic</address>
140140
<paused>false</paused>
141141
<autoAcceptFolders>false</autoAcceptFolders>
@@ -288,7 +288,7 @@ Folder Element
288288

289289
.. code-block:: xml
290290
291-
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
291+
<folder id="default" label="Default Folder" group="Home" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
292292
<filesystemType>basic</filesystemType>
293293
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
294294
<encryptionPassword></encryptionPassword>
@@ -339,6 +339,14 @@ element:
339339
be different on each device, empty, and/or identical to other folder
340340
labels. (optional)
341341

342+
.. option:: folder.group
343+
344+
.. versionadded:: 2.1.0
345+
346+
The group for a folder is a human readable and descriptive local name.
347+
Allows folders to be grouped together locally. May be different on each
348+
device, empty, and/or identical to other folder groups. (optional)
349+
342350
.. option:: folder.filesystemType
343351

344352
The internal file system implementation used to access this folder, detailed
@@ -617,7 +625,7 @@ Device Element
617625

618626
.. code-block:: xml
619627
620-
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="2CYF2WQ-AKZO2QZ-JAKWLYD-AGHMQUM-BGXUOIS-GYILW34-HJG3DUK-LRRYQAR">
628+
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" name="syno" group="Personal" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="2CYF2WQ-AKZO2QZ-JAKWLYD-AGHMQUM-BGXUOIS-GYILW34-HJG3DUK-LRRYQAR">
621629
<address>dynamic</address>
622630
<paused>false</paused>
623631
<autoAcceptFolders>false</autoAcceptFolders>
@@ -658,6 +666,14 @@ element:
658666

659667
A friendly name for the device. (optional)
660668

669+
.. option:: device.group
670+
671+
.. versionadded:: 2.1.0
672+
673+
The group for a device is a human readable and descriptive local name.
674+
Allows devices to be grouped together locally. May be different on each
675+
device, empty, and/or identical to other device groups. (optional)
676+
661677
.. option:: device.compression
662678

663679
Whether to use protocol compression when sending messages to this device.

0 commit comments

Comments
 (0)