Skip to content

Commit 5be6d12

Browse files
joshtrichardsbackportbot[bot]
authored andcommitted
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 c700b56 commit 5be6d12

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

admin_manual/configuration_server/occ_command.rst

+11-6
Original file line numberDiff line numberDiff line change
@@ -929,27 +929,32 @@ Commands for handling shares::
929929
Files external
930930
--------------
931931

932+
These commands are used for managing Nextcloud's *External Storage* feature. In
933+
addition to replicating the configuration capabilities in the Web UI, additional
934+
capabilities include exporting / importing configurations, scanning *External
935+
Storage* mounts that require login credentials, and configuring update notifications
936+
(if supported by the storage type).
937+
932938
.. note::
933939
These commands are only available when the "External storage support" app
934940
(``files_external``) is enabled.
935941

936-
Commands for managing external storage::
942+
Available commands for the "files_external" namespace::
937943

938-
files_external
939944
files_external:applicable Manage applicable users and groups for a mount
940945
files_external:backends Show available authentication and storage backends
941946
files_external:config Manage backend configuration for a mount
942947
files_external:create Create a new mount configuration
943948
files_external:delete Delete an external mount
944949
files_external:export Export mount configurations
945950
files_external:import Import mount configurations
946-
files_external:list List configured mounts
951+
files_external:list List configured admin or personal mounts
952+
files_external:notify Listen for active update notifications for a configured external mount
947953
files_external:option Manage mount options for a mount
954+
files_external:scan Scan an external storage for changed files
948955
files_external:verify Verify mount configuration
949-
files_external:notify Listen for active update notifications for a configured external mount
950956

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

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

0 commit comments

Comments
 (0)