Skip to content

Commit 31815f2

Browse files
feat(admin): Add command to scan external storages directly
- Adds missing minimal documentation entry for nextcloud/server#25109 - Adds an introduction paragraph Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent aa87126 commit 31815f2

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

admin_manual/occ_command.rst

+11-6
Original file line numberDiff line numberDiff line change
@@ -958,27 +958,32 @@ Commands for handling shares::
958958
Files external
959959
--------------
960960

961+
These commands are used for managing Nextcloud's *External Storage* feature. In
962+
addition to replicating the configuration capabilities in the Web UI, additional
963+
capabilities include exporting / importing configurations, scanning *External
964+
Storage* mounts that require login credentials, and configuring update notifications
965+
(if supported by the storage type).
966+
961967
.. note::
962968
These commands are only available when the "External storage support" app
963969
(``files_external``) is enabled.
964970

965-
Commands for managing external storage::
971+
Available commands for the "files_external" namespace::
966972

967-
files_external
968973
files_external:applicable Manage applicable users and groups for a mount
969974
files_external:backends Show available authentication and storage backends
970975
files_external:config Manage backend configuration for a mount
971976
files_external:create Create a new mount configuration
972977
files_external:delete Delete an external mount
973978
files_external:export Export mount configurations
974979
files_external:import Import mount configurations
975-
files_external:list List configured mounts
980+
files_external:list List configured admin or personal mounts
981+
files_external:notify Listen for active update notifications for a configured external mount
976982
files_external:option Manage mount options for a mount
983+
files_external:scan Scan an external storage for changed files
977984
files_external:verify Verify mount configuration
978-
files_external:notify Listen for active update notifications for a configured external mount
979985

980-
These commands replicate the functionality in the Nextcloud Web GUI, plus two new
981-
features: ``files_external:export`` and ``files_external:import``.
986+
``files_external:scan`` provides the ability to provide a username and/or password for cases where login credentials are used.
982987

983988
Use ``files_external:export`` to export all admin mounts to stdout, and
984989
``files_external:export [user_id]`` to export the mounts of the specified

0 commit comments

Comments
 (0)