Skip to content

Add docs for scanProgressFileLimit and improve scanProgressIntervalS #946

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add docs for scanProgressFileLimit and improve scanProgressIntervalS #946

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0bdbe59
Add docs for scanProgressFileLimit and improve scanProgressIntervalS …
danog Jul 30, 2025
8dfa1f6
Update users/config.rst
danog Jul 30, 2025
57c3bd8
Update users/config.rst
danog Jul 30, 2025
eaec6ed
Bump
danog Jul 30, 2025
a926e43
Bump
danog Jul 30, 2025
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
13 changes: 12 additions & 1 deletion users/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,18 @@ The following child elements may exist:
.. option:: folder.scanProgressIntervalS

The interval in seconds with which scan progress information is sent to the GUI. Setting to ``0``
will cause Syncthing to use the default value of two.
will cause Syncthing to use the default value of two. Setting a negative value will disable
scan progress information.
Enabling scan progress information will buffer the entire file list in RAM (using approximately 512 bytes per file plus the length of all file names):
this can cause high memory usage and :abbr:`GC (garbage collection)` thrashing on large folders, greatly slowing down scans,
so it is recommended to disable this for folders with a lot of files.

.. option:: folder.scanProgressFileLimit

Disable emission of scan progress information if more than the specified number of files
are encountered during the scan, useful to avoid running out of memory while buffering the entire file list
in RAM for folders with a lot of files.
Setting to ``0`` will cause Syncthing to use the default value of ``2048``.

.. option:: folder.pullerPauseS

Expand Down