document json type for config:system:set

Signed-off-by: Robin Appelman <robin@icewind.nl>
This commit is contained in:
Robin Appelman
2025-05-08 17:58:44 +02:00
parent 572f98ce5d
commit b07dfbba04

View File

@ -441,6 +441,8 @@ known:
* ``integer``
* ``float``
* ``string`` (default)
* ``null``
* ``json``
When you want to e.g. disable the maintenance mode run the following command::
@ -474,6 +476,15 @@ space. For example, to replace ``sample.tld`` with ``example.com``,
nextcloud.local
example.com
Alternatively, you can set the entry array at once by using the ``json`` type::
sudo -E -u www-data php occ config:system:set trusted_domains --type json --value '["nextcloud.local","example.com"]'
System config value trusted_domains set to json ["nextcloud.local","example.com"]
sudo -E -u www-data php occ config:system:get trusted_domains
nextcloud.local
example.com
Setting a hierarchical configuration value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -498,6 +509,11 @@ value above. For this Redis example, use the following commands::
sudo -E -u www-data php occ config:system:set redis password --value=secret
sudo -E -u www-data php occ config:system:set redis timeout --value=1.5
Alternatively, you can set the entry configuration at once by using the ``json`` type::
sudo -E -u www-data php occ config:system:set redis --type json --value '{"host":"/var/run/redis/redis.sock","port":0,"dbindex":0,"password":"secret","timeout":1.5}'
Deleting a single configuration value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -537,7 +553,7 @@ Manage addressbooks and calendars::
dav:list-subscriptions List all calendar subscriptions for a user
dav:move-calendar Move a calendar from an user to another
dav:remove-invalid-shares Remove invalid dav shares
dav:retention:clean-up
dav:retention:clean-up
dav:send-event-reminders Sends event reminders
dav:sync-birthday-calendar Synchronizes the birthday calendar
dav:sync-system-addressbook Synchronizes users to the system addressbook
@ -652,7 +668,7 @@ This example creates the subscription for the lunar calendar ``Lunar Calendar``
sudo -E -u www-data php occ dav:create-subscription molly "Lunar Calendar" webcal://cantonbecker.com/astronomy-calendar/astrocal.ics
Optionally, a color for the new subscription calendar can be passed as a HEX color code::
sudo -E -u www-data php occ dav:create-subscription molly "Lunar Calendar" calendar webcal://cantonbecker.com/astronomy-calendar/astrocal.ics "#ff5733"
If not set, the theming default color will be used.
@ -677,7 +693,7 @@ Sync system address book
address book<system-address-book>`::
sudo -E -u www-data php occ dav:sync-system-addressbook
Sync birthday calendar
^^^^^^^^^^^^^^^^^^^^^^
@ -852,7 +868,7 @@ Available ``occ`` commands for the ``files`` namespace::
files:object:get Get the contents of an object
files:object:put Write a file to the object store
files:put Write contents of a file
files:recommendations:recommend
files:recommendations:recommend
files:reminders List file reminders
files:repair-tree Try and repair malformed filesystem tree structures
files:scan rescan filesystem
@ -1040,7 +1056,7 @@ In this case no sub-directory is created and all files will appear directly in t
It is also possible to transfer only one directory along with its contents. This can be useful to restructure your organization or quotas. The ``--path`` argument is given as the path to the directory as seen from the source user::
sudo -E -u www-data php occ files:transfer-ownership --path="path_to_dir" <source-user> <destination-user>
Incoming shares are not moved by default because the sharing user holds the ownership of the respective files. There is however an option to enable moving incoming shares.
In case the incoming shares must be transferred as well, use the argument ``--transfer-incoming-shares`` with ``0`` or ``1`` as parameters ::
@ -1090,10 +1106,10 @@ Commands for handling shares::
Files external
--------------
These commands are used for managing Nextcloud's *External Storage* feature. In
addition to replicating the configuration capabilities in the Web UI, additional
capabilities include exporting / importing configurations, scanning *External
Storage* mounts that require login credentials, and configuring update notifications
These commands are used for managing Nextcloud's *External Storage* feature. In
addition to replicating the configuration capabilities in the Web UI, additional
capabilities include exporting / importing configurations, scanning *External
Storage* mounts that require login credentials, and configuring update notifications
(if supported by the storage type).
.. note::