From d0b50ae237e588b19d1262c2f8cae79f0fc0605e Mon Sep 17 00:00:00 2001
From: Robin Appelman <robin@icewind.nl>
Date: Thu, 13 Oct 2016 15:20:41 +0200
Subject: [PATCH] add documention for smb update notifications

---
 .../external_storage/smb.rst                  | 32 +++++++++++++++++++
 .../configuration_server/occ_command.rst      |  1 +
 2 files changed, 33 insertions(+)

diff --git a/admin_manual/configuration_files/external_storage/smb.rst b/admin_manual/configuration_files/external_storage/smb.rst
index 4275c37db..41ffaf686 100644
--- a/admin_manual/configuration_files/external_storage/smb.rst
+++ b/admin_manual/configuration_files/external_storage/smb.rst
@@ -45,3 +45,35 @@ See :doc:`../external_storage_configuration_gui` for additional mount
 options and information.
 
 See :doc:`auth_mechanisms` for more information on authentication schemes.
+
+------------------------
+SMB update notifications
+------------------------
+
+Starting with Nextcloud 10, Nextcloud can use smb update notifications to
+listen to changes made to a configured SMB/CIFS storage and detect external
+changes made to the storage in near real-time.
+
+.. note:: Due to limitations of linux based SMB servers, this feature only works
+   reliably on Windows SMB servers.
+
+.. note:: Using update notifications requires ``smbclient`` 4.x or newer.
+   Due to limitations with the smbclient php module, the ``smbclient`` binary
+   is required even when using the php module.
+
+To start listening to update notifications, start the ``occ`` command like this::
+
+ occ files_external:notify <mount_id>
+
+You can find the mount id for a specific storage using ``occ files_external:list``
+
+On default this command shows no output, can you see the list of detected changes by
+passing the ``-v`` option to the command.
+
+~~~~~~~~~~~~~~~~~~
+SMB Authentication
+~~~~~~~~~~~~~~~~~~
+
+In some cases (such as when using login credentials) it's not possible to read the
+smb credentials from the storage configuration, in those cases you can provide
+the username and password using the ``--username`` and ``--password`` arguments.
diff --git a/admin_manual/configuration_server/occ_command.rst b/admin_manual/configuration_server/occ_command.rst
index ecc5a7643..5ead1a8ef 100644
--- a/admin_manual/configuration_server/occ_command.rst
+++ b/admin_manual/configuration_server/occ_command.rst
@@ -654,6 +654,7 @@ Commands for managing external storage::
   files_external:list        List configured mounts
   files_external:option      Manage mount options for a mount
   files_external:verify      Verify mount configuration
+  files_external:notify      Listen for active update notifications for a configured external mount
 
 These commands replicate the functionality in the Nextcloud Web GUI, plus two new 
 features:  ``files_external:export`` and ``files_external:import``.