Skip to content

docs(config): add grouping folders and devices #1001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
calmh merged 3 commits into from
Apr 7, 2026
+20 −4
Merged

docs(config): add grouping folders and devices #1001

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
afdf4fe
docs(config): add grouping folders and devices
maen-bn Apr 5, 2026
f5b222f
docs(config): document version added for grouping folders and devices
maen-bn Apr 7, 2026
fdd8c67
spacing
calmh Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions users/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The following shows an example of a default configuration file (IDs will differ)
.. code-block:: xml

<configuration version="37">
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
<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">
<filesystemType>basic</filesystemType>
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
<encryptionPassword></encryptionPassword>
Expand Down Expand Up @@ -135,7 +135,7 @@ The following shows an example of a default configuration file (IDs will differ)
<syncXattrs>false</syncXattrs>
<sendXattrs>false</sendXattrs>
</folder>
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" name="syno" group="Personal" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
<address>dynamic</address>
<paused>false</paused>
<autoAcceptFolders>false</autoAcceptFolders>
Expand Down Expand Up @@ -288,7 +288,7 @@ Folder Element

.. code-block:: xml

<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">
<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">
<filesystemType>basic</filesystemType>
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">
<encryptionPassword></encryptionPassword>
Expand Down Expand Up @@ -339,6 +339,14 @@ element:
be different on each device, empty, and/or identical to other folder
labels. (optional)

.. option:: folder.group

.. versionadded:: 2.1.0

The group for a folder is a human readable and descriptive local name.
Allows folders to be grouped together locally. May be different on each
device, empty, and/or identical to other folder groups. (optional)

.. option:: folder.filesystemType

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

.. code-block:: xml

<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">
<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">
<address>dynamic</address>
<paused>false</paused>
<autoAcceptFolders>false</autoAcceptFolders>
Expand Down Expand Up @@ -658,6 +666,14 @@ element:

A friendly name for the device. (optional)

.. option:: device.group

.. versionadded:: 2.1.0

The group for a device is a human readable and descriptive local name.
Allows devices to be grouped together locally. May be different on each
device, empty, and/or identical to other device groups. (optional)

.. option:: device.compression

Whether to use protocol compression when sending messages to this device.
Expand Down
Loading