Skip to content

docs(admin): document external storage change detection and limitations#14937

Merged
skjnldsv merged 2 commits into
masterfrom
feature/external-storage-change-detection-docs
May 21, 2026
Merged

docs(admin): document external storage change detection and limitations#14937
skjnldsv merged 2 commits into
masterfrom
feature/external-storage-change-detection-docs

Conversation

@skjnldsv
Copy link
Copy Markdown
Member

@skjnldsv skjnldsv commented May 20, 2026

☑️ Resolves

What changed and why

Expanded the external storage admin documentation to explain a common source of confusion: changes made directly on a mounted storage (outside Nextcloud) are not automatically visible to Nextcloud, desktop clients, or mobile apps.

The thin "Adding files to external storage" section has been replaced with a proper Detecting changes made outside Nextcloud section that covers:

  • Why it happens: Nextcloud maintains an internal filecache; external changes are invisible until a rescan updates it.
  • How "Filesystem check frequency" actually works: it only fires during a WebDAV PROPFIND, driven by user actions, not background polling. The mount option bullet in the UI description is also expanded to make this clear.
  • Why desktop clients miss deep changes: clients only PROPFIND the sync root and rely on etag propagation up the tree; without a rescan at the changed level there is no trail to follow.
  • Solution A (SMB): occ files_external:notify for near-real-time detection via SMB change events.
  • Solution B (all others): periodic occ files_external:scan <mount_id> cron job.
  • Rename limitation: any rescan (periodic or on direct access) cannot detect renames reliably; the old entry is treated as deleted, causing permanent metadata loss (shares, tags, comments, activities). Documented as a .. warning::.

A .. seealso:: cross-reference was added to smb.rst at the top of the "SMB update notifications" section pointing back to the new anchor (external_storage_change_detection_label).

📸 Screenshots

image image image image

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 20, 2026

📖 Documentation Preview

🔍 Open preview →

📄 2 changed documentation pages

Last updated: Thu, 21 May 2026 16:17:30 GMT

Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
@skjnldsv skjnldsv requested a review from artonge May 21, 2026 09:49
@skjnldsv
Copy link
Copy Markdown
Member Author

skjnldsv commented May 21, 2026

@artonge done in d400487 !

  • reworded both bullets (once per direct access + never) per your suggeestions
  • dropped the trailing clause from the etag paragraph
  • swapped files:scan --all and the --path variant for files_external:scan <mount_id>, also removed the AIO note and webcron recommendation
  • broadened the rename limitation, its not just for periodic rescan but also for "once per direct access" as you pointed out

let me know if anything still looks off!

Copy link
Copy Markdown
Contributor

@artonge artonge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should keep the AIO part, I assume Simon put it there because the question come frequently.

Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
Expand the external storage documentation to explain why changes made
directly on a mounted storage (outside Nextcloud) are not detected
automatically, and how to configure reliable detection.

Closes #7849

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
@skjnldsv skjnldsv force-pushed the feature/external-storage-change-detection-docs branch from f33ca84 to d3236ea Compare May 21, 2026 13:04
@skjnldsv skjnldsv requested a review from artonge May 21, 2026 13:04
@skjnldsv
Copy link
Copy Markdown
Member Author

Thanks for taking the time, I adjusted a few areas, and fixed the wrong listed option 🚀
Rebased and squashed!

Comment thread admin_manual/configuration_files/external_storage_configuration_gui.rst Outdated
Co-authored-by: Louis <louis@chmn.me>
Signed-off-by: John Molakvoæ <skjnldsv@users.noreply.github.com>
@skjnldsv skjnldsv requested a review from artonge May 21, 2026 16:11
@skjnldsv skjnldsv merged commit b1fb4c5 into master May 21, 2026
28 checks passed
@skjnldsv skjnldsv deleted the feature/external-storage-change-detection-docs branch May 21, 2026 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explanation why using external storage outside of Nextcloud is unreliable and hints to make it work with limitations

2 participants