add documention for smb update notifications

This commit is contained in:
Robin Appelman
2016-10-13 15:20:41 +02:00
parent b78dc07316
commit d0b50ae237
2 changed files with 33 additions and 0 deletions

View File

@@ -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.

View File

@@ -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``.