diff --git a/global-attributes.yml b/global-attributes.yml index 4bbf0067f..1db3818ff 100644 --- a/global-attributes.yml +++ b/global-attributes.yml @@ -36,8 +36,7 @@ oc-examples-username: 'username' oc-examples-password: 'password' oc-complete-name: 'owncloud-complete-latest' - occ-command-example-prefix: 'sudo -u www-data ./occ' - occ-command-example-prefix-no-sudo: 'occ' + occ-command-example-prefix: 'occ' php-net-url: 'https://www.php.net' php-supported-versions-url: 'https://www.php.net/supported-versions.php' http-status-codes-base-url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status' diff --git a/modules/admin_manual/pages/configuration/database/linux_database_configuration.adoc b/modules/admin_manual/pages/configuration/database/linux_database_configuration.adoc index ad2fb25de..6ce93155b 100644 --- a/modules/admin_manual/pages/configuration/database/linux_database_configuration.adoc +++ b/modules/admin_manual/pages/configuration/database/linux_database_configuration.adoc @@ -185,6 +185,8 @@ innodb_file_per_table=ON {occ-command-example-prefix} db:convert-mysql-charset ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ When this is done, tables will be created with: + * A `utf8mb4` character set. diff --git a/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration.adoc b/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration.adoc index d7bc816c8..e3ae80344 100644 --- a/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration.adoc +++ b/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration.adoc @@ -123,11 +123,15 @@ To enable the encryption app, run the following command: {occ-command-example-prefix} app:enable encryption ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} encryption:enable ---- +NOTE: Run this command inside the ownCloud Docker container. + If the encryption app is successfully enabled, you should see the following confirmations: [source,plaintext] @@ -165,6 +169,8 @@ To be safe and avoid any issues on a running instance, put your server in single {occ-command-example-prefix} maintenance:singleuser --on ---- +NOTE: Run this command inside the ownCloud Docker container. + Enabling encryption via the command line involves several commands. If not already done, enable the default encryption module app with the following command: [source,bash,subs="attributes+"] @@ -172,6 +178,8 @@ Enabling encryption via the command line involves several commands. If not alrea {occ-command-example-prefix} app:enable encryption ---- +NOTE: Run this command inside the ownCloud Docker container. + Then enable encryption, using the following command: [source,bash,subs="attributes+"] @@ -179,6 +187,8 @@ Then enable encryption, using the following command: {occ-command-example-prefix} encryption:enable ---- +NOTE: Run this command inside the ownCloud Docker container. + Finally, encrypt all data, using the following command: [source,bash,subs="attributes+"] @@ -186,6 +196,8 @@ Finally, encrypt all data, using the following command: {occ-command-example-prefix} encryption:encrypt-all --yes ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: This command is not typically required as the master key is often enabled at installation time. As a result when enabling it, there should be no data to encrypt. In case it’s being enabled after the installation and there are files which are unencrypted, xref:configuration/server/occ_command.adoc#encrypt-all[encrypt-all] can be used to encrypt them. Depending on the amount of existing data and the location, this operation can take a long time. Now you can turn off the single user mode: @@ -195,6 +207,8 @@ Now you can turn off the single user mode: {occ-command-example-prefix} maintenance:singleuser --off ---- +NOTE: Run this command inside the ownCloud Docker container. + === View Current Encryption Status Get the current encryption status and the loaded encryption module: @@ -204,6 +218,8 @@ Get the current encryption status and the loaded encryption module: {occ-command-example-prefix} encryption:status ---- +NOTE: Run this command inside the ownCloud Docker container. + === Replacing an Existing Master Key If the master key needs replacement, for example because it has been compromised, an occ command is available. The command is xref:configuration/server/occ_command.adoc#encryption[encryption:recreate-master-key]. It replaces an existing master key with a new one and encrypts the files with the new key. @@ -217,6 +233,8 @@ You must first put your ownCloud server into single-user mode to prevent any use {occ-command-example-prefix} maintenance:singleuser --on ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- Single user mode is currently enabled @@ -229,6 +247,8 @@ Decrypt all user data files, or optionally a single user: {occ-command-example-prefix} encryption:decrypt-all [username] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Disable Encryption To disable encryption, put your ownCloud server into single-user mode, and then disable your encryption module with these commands: @@ -238,11 +258,15 @@ To disable encryption, put your ownCloud server into single-user mode, and then {occ-command-example-prefix} maintenance:singleuser --on ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} encryption:disable ---- +NOTE: Run this command inside the ownCloud Docker container. + Take it out of single-user mode when you are finished, by using the following command: [source,bash,subs="attributes+"] @@ -250,6 +274,8 @@ Take it out of single-user mode when you are finished, by using the following co {occ-command-example-prefix} maintenance:singleuser --off ---- +NOTE: Run this command inside the ownCloud Docker container. + [IMPORTANT] ==== You may only disable encryption by using the xref:configuration/server/occ_command.adoc#encryption[occ Encryption Commands]. Make sure you have backups of all encryption keys, including those for all your users if user key encryption was selected. @@ -264,6 +290,8 @@ Get the current encryption status and the loaded encryption module: {occ-command-example-prefix} encryption:status ---- +NOTE: Run this command inside the ownCloud Docker container. + === Enable Users' File Recovery Keys If users encrypt their files and lose their ownCloud password, they lose access to their encrypted files as the files will be unrecoverable. It is not possible to reset a user’s password using the standard reset process if the user's files are encrypted. @@ -315,6 +343,8 @@ You must first put your ownCloud server into single-user mode to prevent any use {occ-command-example-prefix} maintenance:singleuser --on ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- Single user mode is currently enabled @@ -329,11 +359,15 @@ You may disable encryption only with `occ`. Make sure you have backups of all th {occ-command-example-prefix} maintenance:singleuser --on ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} encryption:disable ---- +NOTE: Run this command inside the ownCloud Docker container. + IMPORTANT: Encryption cannot be disabled without the user’s password or xref:enable-users-file-recovery-keys[file recovery key]. If you don’t have access to at least one of these then there is no way to decrypt all files. @@ -345,6 +379,8 @@ command: {occ-command-example-prefix} maintenance:singleuser --off ---- +NOTE: Run this command inside the ownCloud Docker container. + It is possible to disable encryption with the file recovery key _if_ every user has enabled it. In this case, "decrypt all" will decrypt all files of all users. NOTE: It is *not* planned to move this to the next user login or a background job. If that was done, then login passwords would need to be stored in the database, which could be a security issue. @@ -358,6 +394,8 @@ View current location of keys: {occ-command-example-prefix} encryption:show-key-storage-root ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- Current key storage root: default storage location (data/) @@ -385,6 +423,8 @@ chmod -R 0770 /var/www/owncloud/data/new_keys {occ-command-example-prefix} encryption:change-key-storage-root new_keys ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- Change key storage root from default storage location to new_keys diff --git a/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc b/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc index 6c6b043dc..02e37c04d 100644 --- a/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc +++ b/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc @@ -24,6 +24,8 @@ This quick guide gives a brief summary of the commands needed without going into {occ-command-example-prefix} maintenance:singleuser --off ---- +NOTE: Run this command inside the ownCloud Docker container. + === View the Encryption Status [source,bash,subs="attributes+"] @@ -31,6 +33,8 @@ This quick guide gives a brief summary of the commands needed without going into {occ-command-example-prefix} encryption:status ---- +NOTE: Run this command inside the ownCloud Docker container. + === Decrypt Encrypted Files Depending on the amount of existing data, this operation can take a long time. @@ -42,6 +46,8 @@ Depending on the amount of existing data, this operation can take a long time. {occ-command-example-prefix} maintenance:singleuser --off ---- +NOTE: Run this command inside the ownCloud Docker container. + === Deactivate Master-Key-Based Encryption [source,bash,subs="attributes+"] @@ -52,6 +58,8 @@ Depending on the amount of existing data, this operation can take a long time. {occ-command-example-prefix} app:disable encryption ---- +NOTE: Run this command inside the ownCloud Docker container. + If the master key has been compromised or exposed, you can replace it. You will need the current master key for it. [source,bash,subs="attributes+"] @@ -59,6 +67,8 @@ If the master key has been compromised or exposed, you can replace it. You will {occ-command-example-prefix} encryption:recreate-master-key ---- +NOTE: Run this command inside the ownCloud Docker container. + == Clean up Your Database Access your ownCloud database and remove the remaining entries that have not been automatically removed with this command: diff --git a/modules/admin_manual/pages/configuration/files/external_storage/configuration.adoc b/modules/admin_manual/pages/configuration/files/external_storage/configuration.adoc index f80927ec3..889d37aed 100644 --- a/modules/admin_manual/pages/configuration/files/external_storage/configuration.adoc +++ b/modules/admin_manual/pages/configuration/files/external_storage/configuration.adoc @@ -101,7 +101,7 @@ TIP: Please refer to xref:configuration/server/import_ssl_cert.adoc[Importing Sy The following backends are provided by the external storages app. Other apps may provide their own backends, which are not listed here. -NOTE: A non-blocking or correctly configured SELinux setup is needed for these backends to work. Please refer to xref:installation/selinux_configuration.adoc[the SELinux configuration]. +NOTE: A non-blocking or correctly configured SELinux setup is needed for these backends to work. == Allow Users to Mount External Storage @@ -137,6 +137,8 @@ You might need to setup a cron job that runs {occ-command-example-prefix} files:scan --all` ---- +NOTE: Run this command inside the ownCloud Docker container. + * Alternatively, replace `--all` with the user name to trigger a rescan of the user’s files periodically, for example every 15 minutes, which includes the mounted external storage. + diff --git a/modules/admin_manual/pages/configuration/files/federated_cloud_sharing_configuration.adoc b/modules/admin_manual/pages/configuration/files/federated_cloud_sharing_configuration.adoc index 02f4c421f..392328f33 100644 --- a/modules/admin_manual/pages/configuration/files/federated_cloud_sharing_configuration.adoc +++ b/modules/admin_manual/pages/configuration/files/federated_cloud_sharing_configuration.adoc @@ -36,6 +36,8 @@ image::configuration/files/browser-address-bars.png[Lock icon in Firefox, Google ---- {occ-command-example-prefix} system:cron ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Run the `OCA\Federation\SyncJob` job with the `force` option on both servers. + You can get the corresponding job ID by using the `background:queue:status` occ command: @@ -44,6 +46,8 @@ You can get the corresponding job ID by using the `background:queue:status` occ ---- {occ-command-example-prefix} background:queue:execute --force ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . The check should now be green @@ -54,6 +58,8 @@ You can get the corresponding job ID by using the `background:queue:status` occ {occ-command-example-prefix} dav:sync-system-addressbook {occ-command-example-prefix} federation:sync-addressbook ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Configure automatic acceptance of new federated shares + @@ -65,6 +71,8 @@ NOTE: Automatic acceptance of new federated shares will not work if the option ` {occ-command-example-prefix} config:app:set federation auto_accept_trusted --value '0' {occ-command-example-prefix} config:app:set federatedfilesharing auto_accept_trusted --value 'yes' ---- + +NOTE: Run this command inside the ownCloud Docker container. -- == Working With Proxies @@ -117,6 +125,8 @@ Alternatively you can use the command line: {occ-command-example-prefix} config:app:set files_sharing cronjob_scan_external_enabled --value 'yes' ---- +NOTE: Run this command inside the ownCloud Docker container. + You can also configure these settings of the cronjob: . the minimum amount of time since last login of a user so that a scan is triggered (ensures only active users get fed shares synced) @@ -125,6 +135,8 @@ You can also configure these settings of the cronjob: ---- {occ-command-example-prefix} config:app:set files_sharing cronjob_scan_external_min_login --value ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . the minimum amount of time since last scanned so that the next scan is triggered (avoid frequent scan when active collaboration) + @@ -132,6 +144,8 @@ You can also configure these settings of the cronjob: ---- {occ-command-example-prefix} config:app:set files_sharing cronjob_scan_external_min_scan --value ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . the maximum number of federated share scans per 10 minutes (scan performed only if fed share files got updated) + @@ -139,6 +153,8 @@ You can also configure these settings of the cronjob: ---- {occ-command-example-prefix} config:app:set files_sharing cronjob_scan_external_batch --value ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Use the following command to force a run of the scanner cronjob: + @@ -146,6 +162,8 @@ You can also configure these settings of the cronjob: ---- {occ-command-example-prefix} background:queue:execute --force --accept-warning ---- ++ +NOTE: Run this command inside the ownCloud Docker container. == Known Issues @@ -173,6 +191,8 @@ It is possible to configure the VCARD properties that are searched in order to r {occ-command-example-prefix} config:app:set dav remote_search_properties --value=CLOUD,FN,EMAIL ---- +NOTE: Run this command inside the ownCloud Docker container. + Possible values are: * VERSION diff --git a/modules/admin_manual/pages/configuration/files/file_sharing_configuration.adoc b/modules/admin_manual/pages/configuration/files/file_sharing_configuration.adoc index 78467d880..841afadba 100644 --- a/modules/admin_manual/pages/configuration/files/file_sharing_configuration.adoc +++ b/modules/admin_manual/pages/configuration/files/file_sharing_configuration.adoc @@ -106,6 +106,8 @@ xref:configuration/server/occ_command.adoc#config-commands[occ config:app:set co --value '' ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: In the example above, the `` is an {two-letter-url}[ISO 3166-1 alpha-2 two-letter country code], such as *de*, *gb*, *us*, *es* or others. @@ -228,6 +230,8 @@ Here is an example of how to transfer all files from one user to another. ---- +NOTE: Run this command inside the ownCloud Docker container. + Here is an example of how to transfer _a limited group_ a single folder from one user to another. In it, `folder/to/move`, and any file and folder inside it will be moved to ``. [source,bash,subs="attributes+"] @@ -238,6 +242,8 @@ Here is an example of how to transfer _a limited group_ a single folder from one ---- +NOTE: Run this command inside the ownCloud Docker container. + When using this command keep two things in mind: 1. The directory provided to the `--path` switch *must* exist inside `data//files`. @@ -254,6 +260,8 @@ IMPORTANT: If an exception occurred during the transfer ownership command or the {occ-command-example-prefix} files:troubleshoot-transfer-ownership --uid ` ---- +NOTE: Run this command inside the ownCloud Docker container. + == Creating Persistent File Shares When a user is deleted, their files are also deleted. As you can imagine, this is a problem if they created file shares that need to be preserved, because these disappear as well. In ownCloud, files are tied to their owners. This means, whatever happens to the file owner also happens to the files. @@ -282,6 +290,8 @@ This command provides for the creation of both personal (for a specific user) an --user someuser ---- +NOTE: Run this command inside the ownCloud Docker container. + or [source,bash,subs="attributes+"] @@ -296,6 +306,8 @@ or --user someuser ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== General Share [source,bash,subs="attributes+"] @@ -306,6 +318,8 @@ or --config={host=127.0.0.1, share='home', root='$user', domain='owncloud.local'} ---- +NOTE: Run this command inside the ownCloud Docker container. + or [source,bash,subs="attributes+"] @@ -319,6 +333,8 @@ or --config domain='somedomain.local' ---- +NOTE: Run this command inside the ownCloud Docker container. + === occ files_external:import You can create general and personal shares passing the configuration details via JSON files, using the `occ files_external:import` command. @@ -331,6 +347,8 @@ You can create general and personal shares passing the configuration details via /import.json ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== Personal Share [source,bash,subs="attributes+"] @@ -339,6 +357,8 @@ You can create general and personal shares passing the configuration details via /import.json --user someuser ---- +NOTE: Run this command inside the ownCloud Docker container. + In the two examples above, here is a sample JSON file, showing all of the available configuration options that the command supports. [source,json] diff --git a/modules/admin_manual/pages/configuration/files/manual_file_locking.adoc b/modules/admin_manual/pages/configuration/files/manual_file_locking.adoc index 6a1543324..704e72b4f 100644 --- a/modules/admin_manual/pages/configuration/files/manual_file_locking.adoc +++ b/modules/admin_manual/pages/configuration/files/manual_file_locking.adoc @@ -53,6 +53,8 @@ Using the occ command:: {occ-command-example-prefix} config:app:set files enable_lock_file_action --value yes ---- +NOTE: Run this command inside the ownCloud Docker container. + == Configuration To prevent files being locked infinitely, there is a mechanism that automatically expires locks after a certain time. The expiration time of locks can either be configured via the web interface or using occ commands. In addition, administrators can define groups whose members can break locks. @@ -78,6 +80,8 @@ Using the occ command:: {occ-command-example-prefix} config:app:set files lock_timeout_default --value 1800 ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ * Maximum locks timeout + [source,bash,subs="attributes+"] @@ -85,6 +89,8 @@ Using the occ command:: {occ-command-example-prefix} config:app:set files lock_timeout_max --value 86400 ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ * Define lock breaker groups + The example below defines two lock breaker groups named `unlockers` and `admin`. @@ -93,3 +99,5 @@ The example below defines two lock breaker groups named `unlockers` and `admin`. ---- {occ-command-example-prefix} config:app:set core lock-breaker-groups --value '["unlockers","admin"]' ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/files/mimetypes.adoc b/modules/admin_manual/pages/configuration/files/mimetypes.adoc index 552eba2ca..8bc7bf93c 100644 --- a/modules/admin_manual/pages/configuration/files/mimetypes.adoc +++ b/modules/admin_manual/pages/configuration/files/mimetypes.adoc @@ -112,6 +112,8 @@ use the xref:configuration/server/occ_command.adoc[occ command] to propagate the {occ-command-example-prefix} maintenance:mimetype:update-js ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example - Changing the JSON File Icon image:configuration/mimetypes/json-alias-before.png[The default icon for JSON files] @@ -156,6 +158,8 @@ The name and location of the file are important. ---- {occ-command-example-prefix} maintenance:mimetype:update-js ---- ++ +NOTE: Run this command inside the ownCloud Docker container. After doing so, whenever you view a folder that contains JSON files or upload one, your new icon file will be used to represent the file, as in the image below. diff --git a/modules/admin_manual/pages/configuration/files/trashbin_options.adoc b/modules/admin_manual/pages/configuration/files/trashbin_options.adoc index cdcdefa0d..64bdc1a41 100644 --- a/modules/admin_manual/pages/configuration/files/trashbin_options.adoc +++ b/modules/admin_manual/pages/configuration/files/trashbin_options.adoc @@ -34,6 +34,8 @@ Remove deleted files for users on backend Database user4 ---- +NOTE: Run this command inside the ownCloud Docker container. + This example removes the deleted files of user2 and user4: [source,bash,subs="attributes+"] @@ -43,6 +45,8 @@ This example removes the deleted files of user2 and user4: Remove deleted files of user4 ---- +NOTE: Run this command inside the ownCloud Docker container. + `trashbin:expire` deletes only expired files according to the `trashbin_retention_obligation` setting in `config.php`. The default setting is `auto`, which keeps files in the Trashbin for 30 days, then @@ -59,4 +63,6 @@ users in a space-delimited list: Remove deleted files of user2 ---- +NOTE: Run this command inside the ownCloud Docker container. + See the *Deleted Files* section in xref:configuration/server/config_sample_php_parameters.adoc[Sample PHP Configuration Parameters], and xref:configuration/server/occ_command.adoc[the Trash Bin section] of the occ commands. diff --git a/modules/admin_manual/pages/configuration/general_topics/code_signing.adoc b/modules/admin_manual/pages/configuration/general_topics/code_signing.adoc index 3d2f145de..1de829745 100644 --- a/modules/admin_manual/pages/configuration/general_topics/code_signing.adoc +++ b/modules/admin_manual/pages/configuration/general_topics/code_signing.adoc @@ -216,6 +216,8 @@ a command to manually scan all apps: {occ-command-example-prefix} integrity:check-app ---- +NOTE: Run this command inside the ownCloud Docker container. + TIP: See xref:configuration/server/occ_command.adoc[the occ command] to learn more about using `occ`. == Errors diff --git a/modules/admin_manual/pages/configuration/general_topics/impersonate_users.adoc b/modules/admin_manual/pages/configuration/general_topics/impersonate_users.adoc index 42658e8fc..95f043403 100644 --- a/modules/admin_manual/pages/configuration/general_topics/impersonate_users.adoc +++ b/modules/admin_manual/pages/configuration/general_topics/impersonate_users.adoc @@ -54,6 +54,8 @@ image::apps/impersonate/impersonate_enable.png[Define who can use Impersonate,wi {occ-command-example-prefix} config:app:set \ impersonate enabled --value 'yes' ---- ++ +NOTE: Run this command inside the ownCloud Docker container. ** You can also use an occ command to define groups whose members are granted the right to _use_ impersonation: + @@ -62,6 +64,8 @@ image::apps/impersonate/impersonate_enable.png[Define who can use Impersonate,wi {occ-command-example-prefix} config:app:set \ impersonate enabled --value '["admin","einstein-g"]' ---- ++ +NOTE: Run this command inside the ownCloud Docker container. == Define Who is Allowed to Impersonate @@ -87,17 +91,23 @@ image::apps/impersonate/impersonate_oc_admins_only.png[Impersonate for ownCloud impersonate impersonate_all_groupadmins --value false ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:set \ impersonate impersonate_include_groups --value false ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:set \ impersonate impersonate_include_groups_list --value '[]' ---- ++ +NOTE: Run this command inside the ownCloud Docker container. * If you want to allow all group admins to impersonate users within groups which they administer: + @@ -111,17 +121,23 @@ image::apps/impersonate/impersonate_group_admins_only.png[Impersonate for all gr impersonate impersonate_all_groupadmins --value true ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:set \ impersonate impersonate_include_groups --value false ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:set \ impersonate impersonate_include_groups_list --value '[]' ---- ++ +NOTE: Run this command inside the ownCloud Docker container. * If you want to limit impersonation to admins of specific groups, first click btn:[Allow group admins of specific groups...]. With the option checked, click into the textbox underneath it. You will see a list of all groups on your ownCloud installation, which will change, based on what you type in the textbox to search for specific groups. Choose one or more groups from the list, and they will be added to the textbox, restricting this functionality to admins of those groups only. + @@ -135,14 +151,20 @@ image::apps/impersonate/impersonate_groups_only.png[Impersonate for specific gro impersonate impersonate_all_groupadmins --value false ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:set \ impersonate impersonate_include_groups --value true ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:set \ impersonate impersonate_include_groups_list --value '["group1", "group2"]' ---- ++ +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/general_topics/search.adoc b/modules/admin_manual/pages/configuration/general_topics/search.adoc index e57d073a3..55f79f8bf 100644 --- a/modules/admin_manual/pages/configuration/general_topics/search.adoc +++ b/modules/admin_manual/pages/configuration/general_topics/search.adoc @@ -52,7 +52,9 @@ To install the app, use the Marketplace app on your ownCloud server or proceed m ---- {occ-command-example-prefix} app:enable search_elastic ---- -+ + +NOTE: Run this command inside the ownCloud Docker container. + or enable it via the GUI menu:Settings[Admin > Apps > Full Text Search > Enable]. == Configuration @@ -183,6 +185,8 @@ You can at any time reset the index if required by clicking on btn:[Reset index] {occ-command-example-prefix} search:index:reset ---- +NOTE: Run this command inside the ownCloud Docker container. + == Using occ Commands You can use the: @@ -194,6 +198,8 @@ You can use the: {occ-command-example-prefix} search:index:reset ---- +NOTE: Run this command inside the ownCloud Docker container. + * xref:configuration/server/occ_command.adoc#config-commands[occ Config Commands command set] to configure the app. + Examples: @@ -230,6 +236,8 @@ Set app options:: search_elastic scanExternalStorages --value 0 ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ or + [source,bash,subs="attributes+"] @@ -238,6 +246,8 @@ or search_elastic scanExternalStorages --value 1 ---- +NOTE: Run this command inside the ownCloud Docker container. + == App Modes The Full Text Search app provides two modes, which are *active* and *passive*. @@ -269,6 +279,8 @@ To do an initial full indexing without the app interfering, it can be put in _pa search_elastic mode --value passive ---- +NOTE: Run this command inside the ownCloud Docker container. + or [source,bash,subs="attributes+"] @@ -277,6 +289,8 @@ or search_elastic mode --value active ---- +NOTE: Run this command inside the ownCloud Docker container. + == Restrict Search Results === Index Metadata Only @@ -289,6 +303,8 @@ If you only want to use the Full Text Search app as a more scalable search on fi search_elastic nocontent --value true ---- +NOTE: Run this command inside the ownCloud Docker container. + [NOTE] ==== * You have to reindex all files if you change this back to `false`. Setting it to `true` does not require reindexing. @@ -306,6 +322,8 @@ If you only want to use search for shared filenames, you can disable full text s --value nofulltext ---- +NOTE: Run this command inside the ownCloud Docker container. + You can also configure multiple groups by separating them with comma: [source,bash,subs="attributes+"] @@ -315,6 +333,8 @@ You can also configure multiple groups by separating them with comma: --value nofulltext,anothergroup,"group with blanks" ---- +NOTE: Run this command inside the ownCloud Docker container. + This allows a scalable search in shared files without clouding the results with content based hits. == Create the Index @@ -329,6 +349,8 @@ When everything has been set up and configured, you can initiate creating the in {occ-command-example-prefix} search:index:create ---- +NOTE: Run this command inside the ownCloud Docker container. + == Issues When the Elasticsearch server is down or the index has not been set up, you may get the following message. Check if the ES server is reachable or if the index was set up properly as one solution to fix the issue. diff --git a/modules/admin_manual/pages/configuration/server/background_jobs_configuration.adoc b/modules/admin_manual/pages/configuration/server/background_jobs_configuration.adoc index 209a7de35..2b2607d0f 100644 --- a/modules/admin_manual/pages/configuration/server/background_jobs_configuration.adoc +++ b/modules/admin_manual/pages/configuration/server/background_jobs_configuration.adoc @@ -21,6 +21,8 @@ As an example: {occ-command-example-prefix} background:cron ---- +NOTE: Run this command inside the ownCloud Docker container. + Is the same as using the *Cron* section on your ownCloud Admin page. === Docker Note @@ -94,6 +96,8 @@ There is no way to do so via the ownCloud UI. But, the most direct way to do so, {occ-command-example-prefix} system:cron ---- +NOTE: Run this command inside the ownCloud Docker container. + Each of these processes would acquire their own list of jobs to process without overlapping any other. === Available Background Jobs @@ -129,6 +133,8 @@ The ExpireTrash job, contained in `OCA\Files_Trashbin\BackgroundJob\ExpireTrash` {occ-command-example-prefix} trashbin:expire ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== ExpireVersions The ExpireVersions job, contained in `OCA\Files_Versions\BackgroundJob\ExpireVersions`, will expire versions of files which are older than the specified maximum version retention time. It can be run, as follows, using the xref:configuration/server/occ_command.adoc#versions[OCC versions] command: @@ -138,6 +144,8 @@ The ExpireVersions job, contained in `OCA\Files_Versions\BackgroundJob\ExpireVer {occ-command-example-prefix} versions:expire ---- +NOTE: Run this command inside the ownCloud Docker container. + CAUTION: Please take care when adding `ExpireTrash` and `ExpireVersions` as xref:cron[Cron] jobs. Make sure that they're not started in parallel on multiple machines. Running in parallel on a single machine is fine. But, currently, there isn't sufficient locking in place to prevent them from conflicting with each other if running in parallel across multiple machines. ==== SyncJob (CardDAV) @@ -149,6 +157,8 @@ The `CardDAV SyncJob`, contained in `OCA\DAV\CardDAV\SyncJob`, syncs the local s {occ-command-example-prefix} dav:sync-system-addressbook ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== SyncJob (Federation) OCAFederationSyncJob @@ -161,6 +171,8 @@ xref:configuration/server/occ_command.adoc#federation-sync[OCC federation sync] {occ-command-example-prefix} federation:sync-addressbooks ---- +NOTE: Run this command inside the ownCloud Docker container. + == Troubleshooting === Remove Non-Existent Background Jobs diff --git a/modules/admin_manual/pages/configuration/server/harden_server.adoc b/modules/admin_manual/pages/configuration/server/harden_server.adoc index 8d7aa2530..cf8779f11 100644 --- a/modules/admin_manual/pages/configuration/server/harden_server.adoc +++ b/modules/admin_manual/pages/configuration/server/harden_server.adoc @@ -36,6 +36,8 @@ This information is obtained by running xref:configuration/server/occ_command.ad {occ-command-example-prefix} security:routes ---- +NOTE: Run this command inside the ownCloud Docker container. + It should print a list of all the routes as in the following truncated example. [source,plaintext] @@ -71,8 +73,7 @@ With this information, you can begin customizing a rate-limiting solution specif === Enable hardening modules such as SELinux -We also recommend to enable hardening modules such as SELinux -where possible. See xref:installation/selinux_configuration.adoc[SELinux Configuration] to learn more about SELinux. +We also recommend to enable hardening modules such as SELinux where possible. == Database diff --git a/modules/admin_manual/pages/configuration/server/legal_settings_configuration.adoc b/modules/admin_manual/pages/configuration/server/legal_settings_configuration.adoc index b3527719a..3cbdeaf39 100644 --- a/modules/admin_manual/pages/configuration/server/legal_settings_configuration.adoc +++ b/modules/admin_manual/pages/configuration/server/legal_settings_configuration.adoc @@ -51,6 +51,8 @@ Get the current values, if any, for the Imprint and Privacy Policy URLs: {occ-command-example-prefix} config:app:get core legal.privacy_policy_url ---- +NOTE: Run this command inside the ownCloud Docker container. + Set the Imprint and Privacy Policy URLs: [source,bash,subs="attributes+"] ---- @@ -58,6 +60,8 @@ Set the Imprint and Privacy Policy URLs: {occ-command-example-prefix} config:app:set core legal.privacy_policy_url --value=new_value ---- +NOTE: Run this command inside the ownCloud Docker container. + For more information about these commands, refer to xref:configuration/server/occ_command.adoc#config-commands[the config command reference in the occ commands documentation]. == Viewing the URLs diff --git a/modules/admin_manual/pages/configuration/server/occ_command.adoc b/modules/admin_manual/pages/configuration/server/occ_command.adoc index 9a1a95b93..73d4af8a6 100644 --- a/modules/admin_manual/pages/configuration/server/occ_command.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_command.adoc @@ -65,66 +65,43 @@ toc::[] == Running occ -=== Check if occ Is Set to Executable +All `occ` commands must be run inside the running ownCloud Docker container. There are two ways to do this. -Note that this step is not necessary when using a docker installation. +=== Running a Single occ Command -To check if the `occ` command is set to executable, change to your ownCloud directory first, then enter the command: +To run a single `occ` command without entering the container, use `docker compose exec` from the directory containing your `docker-compose.yml`: [source,bash] ---- -ls -lhF occ +docker compose exec owncloud occ ---- -This should give an output similar to this: +[[docker-exec]] +=== Opening a Shell Inside the Container -[source,plaintext] ----- --rwxr-x--x 1 root www-data 283 May 18 17:44 occ* ----- - -In case it does not, set the occ command to executable with: +To run multiple commands interactively, open a bash shell inside the container: [source,bash] ---- -sudo chmod +x occ +docker compose exec owncloud bash ---- -=== As Your HTTP User - -On a regular ownCloud installation, `occ` is in the `owncloud/` directory, this is on Ubuntu Linux for example `/var/www/owncloud` . `occ` itself is a PHP script. - -*You must run it as your HTTP user* to ensure that the correct permissions are maintained on your ownCloud files and directories. The default HTTP user is different on the various Linux distributions. - -* The HTTP user and group in Debian/Ubuntu is `www-data`. -* The HTTP user and group in Fedora/CentOS is `apache`. -* The HTTP user and group in Arch Linux is `http`. -* The HTTP user in openSUSE is `wwwrun`, and the HTTP group is `www`. +Once inside, run `occ` commands directly: -[TIP] -==== -Use the following command to find your HTTP user: [source,bash] ---- -ps -ef | egrep '(apache|httpd)' | grep -v grep | grep -v root | head -n1 | awk '{print $1}' +occ ---- -==== -If your HTTP server is configured to use a different PHP version than the default (/usr/bin/php), `occ` should be run with the same version. + -For example, in CentOS with SCL-PHP74 installed, the command looks like this: - -[source,bash] ----- -sudo -u apache /opt/rh/php74/root/usr/bin/php /var/www/html/owncloud/occ ----- +Type `exit` to leave the container shell. === occ Command Structure The `occ` command has _options_, _commands_, and _arguments_. -. Options are optional. +. Options are optional. . Commands are required. -. Arguments can be required _or_ optional. +. Arguments can be required _or_ optional. The generic syntax is: @@ -133,25 +110,6 @@ The generic syntax is: occ [options] command [arguments] ---- -.Example command running occ in Ubuntu -[source,bash] ----- -sudo -u www-data /var/www/owncloud/occ ----- - -If your web server is configured to use a different PHP version than the default (/usr/bin/php), the `occ` command should be run with the same version. - -=== With a Docker Container - -If your ownCloud instance is set up in a docker container, you need a user in the group `docker` to perform `occ` commands. An example command looks like this: - -[source,docker] ----- -docker exec --user www-data occ ----- - -For more information on docker, refer to section xref:installation/docker/index.adoc[Installing with Docker]. - === Example Commands Running `occ` with no options lists all commands and options, like this example on Ubuntu: diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_2fa_app_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_2fa_app_commands.adoc index fa543aa65..4d0ed815f 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_2fa_app_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_2fa_app_commands.adoc @@ -22,6 +22,8 @@ Delete the redundant secrets of non-existing users: {occ-command-example-prefix} twofactor_totp:delete-redundant-secret ---- +NOTE: Run this command inside the ownCloud Docker container. + == Set Secret Verification Status Set secret verification status of specified users or all users: @@ -31,6 +33,8 @@ Set secret verification status of specified users or all users: {occ-command-example-prefix} twofactor_totp:set-secret-verification-status [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_activity_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_activity_commands.adoc index b46452394..d7f13996e 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_activity_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_activity_commands.adoc @@ -17,6 +17,8 @@ The `activity:send-emails` command sends all pending activity emails immediately {occ-command-example-prefix} activity:send-emails ---- +NOTE: Run this command inside the ownCloud Docker container. + == Manage Rename and Move Action Notifications Starting with Activity app version 2.7.0, rename and move action notifications can be sent. This feature is disabled by default and must be enabled manually. @@ -28,6 +30,8 @@ Starting with Activity app version 2.7.0, rename and move action notifications c {occ-command-example-prefix} config:app:set activity enable_move_and_rename_activities --value "yes" ---- +NOTE: Run this command inside the ownCloud Docker container. + === Disable Rename and Move Action Notifications [source,bash,subs="attributes+"] @@ -35,9 +39,13 @@ Starting with Activity app version 2.7.0, rename and move action notifications c {occ-command-example-prefix} config:app:set activity enable_move_and_rename_activities --value "no" ---- +NOTE: Run this command inside the ownCloud Docker container. + or [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:delete activity enable_move_and_rename_activities ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_admin_audit_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_admin_audit_commands.adoc index 6b1c406d9..11c31b433 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_admin_audit_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_admin_audit_commands.adoc @@ -18,6 +18,8 @@ To ignore all CLI triggered events, you can set the following option, defaults t --value "yes" ---- +NOTE: Run this command inside the ownCloud Docker container. + == Get Value of Ignore CLI Events This command reads the value of `admin_audit ignore_cli_events`: @@ -27,6 +29,8 @@ This command reads the value of `admin_audit ignore_cli_events`: {occ-command-example-prefix} config:app:get "admin_audit ignore_cli_events" ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- yes @@ -40,3 +44,5 @@ This command completely removes the key and the value: ---- {occ-command-example-prefix} config:app:delete "admin_audit ignore_cli_events" ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_antivirus_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_antivirus_commands.adoc index 62622c0bf..4df727680 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_antivirus_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_antivirus_commands.adoc @@ -12,6 +12,8 @@ Parametrisation must be done with the `occ config` command set. {occ-command-example-prefix} config:list files_antivirus ---- +NOTE: Run this command inside the ownCloud Docker container. + == Set the Setting To set a new value, use the command below and replace `` and value `` accordingly. @@ -21,6 +23,8 @@ To set a new value, use the command below and replace `` and value ` {occ-command-example-prefix} config:app:set files_antivirus --value= --update-only ---- +NOTE: Run this command inside the ownCloud Docker container. + === Antivirus Mode [string] Antivirus Configuration. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_brute_force_protection_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_brute_force_protection_commands.adoc index 08d4a679e..21b6ca2f1 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_brute_force_protection_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_brute_force_protection_commands.adoc @@ -13,6 +13,8 @@ The combination of `uid` and `IP address` is used to trigger the ban. {occ-command-example-prefix} config:list brute_force_protection ---- +NOTE: Run this command inside the ownCloud Docker container. + == Set the Setting To set a new value, use the command below and replace `` and value `` accordingly. @@ -22,6 +24,8 @@ To set a new value, use the command below and replace `` and value ` {occ-command-example-prefix} config:app:set brute_force_protection --value= --update-only ---- +NOTE: Run this command inside the ownCloud Docker container. + === Fail Tolerance [attempts] Number of wrong attempts to trigger the ban. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_custom_groups.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_custom_groups.adoc index a0d99d485..276181f1d 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_custom_groups.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_custom_groups.adoc @@ -23,6 +23,8 @@ By default, administrators can administrate custom groups of an instance. When c --type boolean --value true ---- +NOTE: Run this command inside the ownCloud Docker container. + This occ command will create a key-value pair in your config.php which must be writable for the webserver user. You can also do this manually by adding the following key in config.php: [source.plaintext] @@ -42,6 +44,8 @@ You can hide custom groups from a user's personal settings page based on a user' --value '["no_guest_app_users", "project5"]' ---- +NOTE: Run this command inside the ownCloud Docker container. + This occ command will create a key-value pair in your config.php which must be writable for the webserver user to be set. You can also set this manually by adding the following key in config.php: [source.plaintext] @@ -65,6 +69,8 @@ This setting defines if ordinary users are allowed to create custom groups. By d --value 'true' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Restrict Add or Remove Group Members This setting defines if an existing ordinary group member is allowed to add other users to the target group or remove them. By default, all users can add members to groups, but this can be restricted to admins (if allowed as above) and group-admins. Values to be set can be 'yes' and 'no', defaults to 'no'. @@ -77,6 +83,8 @@ This setting defines if an existing ordinary group member is allowed to add othe --value 'yes' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Allow Duplicate Group Display Names This setting allows the creation of multiple groups with the same display name. By default, group display names must be unique, but it can be be allowed to have multiple identical group display names. Values to be set can be 'true' and 'false', defaults to 'false'. @@ -88,3 +96,5 @@ This setting allows the creation of multiple groups with the same display name. allow_duplicate_names \ --value 'false' ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_data_exporter_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_data_exporter_commands.adoc index 7ecf599ca..5716d2428 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_data_exporter_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_data_exporter_commands.adoc @@ -24,6 +24,8 @@ The following commands are available for the Data Exporter app: {occ-command-example-prefix} instance:export:user ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="80%",cols="30%,70%",] @@ -39,6 +41,8 @@ The following commands are available for the Data Exporter app: {occ-command-example-prefix} instance:import:user [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="80%",cols="30%,70%",] @@ -62,6 +66,8 @@ The following commands are available for the Data Exporter app: {occ-command-example-prefix} instance:export:migrate:share ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="80%",cols="30%,70%",] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_files_lifecycle.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_files_lifecycle.adoc index dbcef98f6..32de07b15 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_files_lifecycle.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_files_lifecycle.adoc @@ -47,6 +47,8 @@ Archive files which have reached a certain age. {occ-command-example-prefix} lifecycle:archive [options] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Options [width="90%",cols="40%,80%",] @@ -65,6 +67,8 @@ Expire files from archive which have reached a certain age. {occ-command-example-prefix} lifecycle:expire [options] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Options [width="90%",cols="40%,80%",] @@ -83,6 +87,8 @@ Restore files from archive to the original location. Note that the location for {occ-command-example-prefix} lifecycle:restore ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="90%",cols="40%,80%",] @@ -100,6 +106,8 @@ Restore all files in folder `project1` for user alice with path `/work/projects/ {occ-command-example-prefix} lifecycle:restore /alice/archive/files/work/projects/project1 ---- +NOTE: Run this command inside the ownCloud Docker container. + == Restore All Files From Archive Restore all archived files for all users in the system back to their original locations. This command has no additional arguments or options. @@ -109,6 +117,8 @@ Restore all archived files for all users in the system back to their original lo {occ-command-example-prefix} lifecycle:restore-all ---- +NOTE: Run this command inside the ownCloud Docker container. + == Set Default Upload Time Set upload time for files which do not have one. @@ -121,6 +131,8 @@ This can happen with files that were uploaded before the files_lifecycle app was {occ-command-example-prefix} lifecycle:set-upload-time [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="90%",cols="40%,80%",] @@ -153,6 +165,8 @@ The following example command sets the time passed since upload (or restore) for {occ-command-example-prefix} config:app:set files_lifecycle archive_period --value='90' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Set the Expire Period The number of days since archiving after which files will be permanently deleted. @@ -164,6 +178,8 @@ The following example command sets the time passed to delete files to 180 days. {occ-command-example-prefix} config:app:set files_lifecycle expire_period --value='180' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Set Groups to be Excluded Define groups of users that are exempt from the lifecycle policies (comma-separated group ids). @@ -175,6 +191,8 @@ The following example command specifies groups whose members will not be part of {occ-command-example-prefix} config:app:set files_lifecycle excluded_groups --value='group1,group2' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Restoration Policy for Users Set a policy who can restore files. Use the value `soft` for self-service and `hard` for admin/groupadmin-service. @@ -186,6 +204,8 @@ The following example command sets the restoration policy for users to `soft` (d {occ-command-example-prefix} config:app:set files_lifecycle policy --value='soft' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Disable User Interface Disable the whole user interface for the File Lifecycle Management app. @@ -197,9 +217,13 @@ The following example command disables the user interface for the File Lifecycle {occ-command-example-prefix} config:app:set files_lifecycle disable_ui --value='yes' ---- +NOTE: Run this command inside the ownCloud Docker container. + You can reenable it by deleting the key: [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:delete files_lifecycle disable_ui ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_full_text_search_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_full_text_search_commands.adoc index 13f419cb9..9c4a4b596 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_full_text_search_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_full_text_search_commands.adoc @@ -29,6 +29,8 @@ The command `search:index:create` creates the initial full text search index for {occ-command-example-prefix} search:index:create ()... ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,100%"] @@ -57,6 +59,8 @@ This example creates a full text search index for the user with user id `testuse Indexing user testuser ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example 2 This example creates a full text search index for the users with user ids `admin` and `testuser`. @@ -69,6 +73,8 @@ Indexing user admin Indexing user testuser ---- +NOTE: Run this command inside the ownCloud Docker container. + == Fill a Secondary Index Fill a secondary index based on the indexed data we have. Files not matching the "indexed" status will be ignored. This is intended to be used in index data migrations, so the connector for this secondary index should have been configured as "write connector". See the xref:configuration/general_topics/search.adoc[Full Text Search] documentation for more details. Note that the values of the `connector_name` are hardcoded and have to be written as described. @@ -78,6 +84,8 @@ Fill a secondary index based on the indexed data we have. Files not matching the {occ-command-example-prefix} search:index:fillSecondary [options] [--] ... ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,100%"] @@ -117,6 +125,8 @@ If you want to rebuild the whole index, run `search:index:reset` and then `searc {occ-command-example-prefix} search:index:rebuild ()... ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,100%"] @@ -153,6 +163,8 @@ This will delete all full text search index data for testuser! Do you want to pr Rebuilding full text search Index for testuser ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example 2 This example rebuilds the full text search index for the users with user IDs `admin` and `testuser`. @@ -170,6 +182,8 @@ Rebuilding Search Index for admin Rebuilding Search Index for testuser ---- +NOTE: Run this command inside the ownCloud Docker container. + === Rebuild the Entire Index The entire index can be rebuilt by running the following two commands: @@ -189,6 +203,8 @@ Reset all the configured indexes. Changes in the configuration of the indexes as {occ-command-example-prefix} search:index:reset ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,100%"] @@ -209,6 +225,8 @@ This will delete the whole search index! Do you want to proceed? Search index has been reset. ---- +NOTE: Run this command inside the ownCloud Docker container. + == Update the Full Text Search Index Updates to the search index due to changed content or changed metadata are happening via background jobs that are added to a queue. These background jobs are normally run by the ownCloud cronjob. The command `search:index:update` updates the full text search index by running all pending background jobs. @@ -218,6 +236,8 @@ Updates to the search index due to changed content or changed metadata are happe {occ-command-example-prefix} search:index:update ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,100%"] @@ -237,6 +257,8 @@ Start Updating the Elastic search index: No pending jobs found. ---- +NOTE: Run this command inside the ownCloud Docker container. + == Set App Modes To do an initial full indexing without the Full Text Search app interfering, it can be put in passive mode. See the xref:configuration/general_topics/search.adoc#app-modes[App Modes] section in the Full Text Search description for details. @@ -247,6 +269,8 @@ To do an initial full indexing without the Full Text Search app interfering, it search_elastic mode --value passive ---- +NOTE: Run this command inside the ownCloud Docker container. + Switching back to active mode can be done by running the following command: [source,bash,subs="attributes+"] @@ -255,6 +279,8 @@ Switching back to active mode can be done by running the following command: search_elastic mode --value active ---- +NOTE: Run this command inside the ownCloud Docker container. + == Restrict Search Results Search results can be restricted in different ways, see the xref:configuration/general_topics/search.adoc#restrict-search-results[Restrict Search Results] section in the Full Text Search description for details. @@ -267,6 +293,8 @@ Search results can be restricted in different ways, see the xref:configuration/g search_elastic nocontent --value true ---- +NOTE: Run this command inside the ownCloud Docker container. + Switching back to provide all content search results can be done by running the following command: [source,bash,subs="attributes+"] @@ -275,6 +303,8 @@ Switching back to provide all content search results can be done by running the search_elastic nocontent --value false ---- +NOTE: Run this command inside the ownCloud Docker container. + === Limit Metadata Search for Groups [source,bash,subs="attributes+"] @@ -283,3 +313,5 @@ Switching back to provide all content search results can be done by running the search_elastic group.nocontent \ --value group1,group2,"group with blank" ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_ldap_integration_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_ldap_integration_commands.adoc index 2610e4cf2..c365fe984 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_ldap_integration_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_ldap_integration_commands.adoc @@ -23,6 +23,9 @@ Search for an LDAP user, using this syntax: ---- {occ-command-example-prefix} ldap:search [options] [--] ---- + +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -116,6 +119,8 @@ Searches match at the beginning of the attribute value only. This example search {occ-command-example-prefix} ldap:search "rob" ---- +NOTE: Run this command inside the ownCloud Docker container. + This will find "robbie", "roberta", and "robin". Broaden the search to find, for example, `jeroboam` with the asterisk wildcard: @@ -124,6 +129,8 @@ Broaden the search to find, for example, `jeroboam` with the asterisk wildcard: {occ-command-example-prefix} ldap:search "*rob" ---- +NOTE: Run this command inside the ownCloud Docker container. + The following examples use `offset` and `limit` options: [source,bash,subs="attributes+"] @@ -136,6 +143,8 @@ Rekha Cox (Rekha.Cox) Rekha Craft (Rekha.Craft) ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} ldap:search "re" --offset 0 --limit 3 @@ -144,6 +153,8 @@ Rebecca Vintin (Rebecca.Vintin) Rebekka Da-Cahuna (Rebekka.Da-Cahuna) ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} ldap:search "re" --offset 3 --limit 3 @@ -151,6 +162,8 @@ Rekha Cox (Rekha.Cox) Rekha Craft (Rekha.Craft) ---- +NOTE: Run this command inside the ownCloud Docker container. + == Check if an LDAP User Exists This only works if the ownCloud server is connected to an LDAP server. @@ -183,6 +196,8 @@ Example: {occ-command-example-prefix} ldap:check-user robert ---- +NOTE: Run this command inside the ownCloud Docker container. + `ldap:check-user` will not run a check when it finds a disabled LDAP connection. This prevents users that exist on disabled LDAP connections from being marked as deleted. If you know for sure that the user you are searching for is not in one of the disabled connections and exists on an active connection, use the `--force` option to force a check of all active LDAP connections. [source,bash,subs="attributes+"] @@ -190,6 +205,8 @@ Example: {occ-command-example-prefix} ldap:check-user --force robert ---- +NOTE: Run this command inside the ownCloud Docker container. + == Create an Empty LDAP Configuration Create an empty LDAP configuration. @@ -215,6 +232,8 @@ Configurations that you create without assigning a are automatically Created new configuration with configID 's01' ---- +NOTE: Run this command inside the ownCloud Docker container. + == List and View Your Configurations You can list and view your configurations: @@ -224,6 +243,8 @@ You can list and view your configurations: {occ-command-example-prefix} ldap:show-config [options] [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -252,6 +273,8 @@ If you omit the `configID`, all configuration ID's with their settings are liste {occ-command-example-prefix} ldap:show-config ---- +NOTE: Run this command inside the ownCloud Docker container. + View the configuration for a single `configID`: [source,bash,subs="attributes+"] @@ -259,6 +282,8 @@ View the configuration for a single `configID`: {occ-command-example-prefix} ldap:show-config s01 ---- +NOTE: Run this command inside the ownCloud Docker container. + == Delete an Existing LDAP Configuration Deletes an existing LDAP configuration. @@ -282,6 +307,8 @@ Deletes an existing LDAP configuration. Deleted configuration with configID 's01' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Invalidate LDAP Cache This command invalidates the LDAP cache for all users: @@ -291,6 +318,8 @@ This command invalidates the LDAP cache for all users: {occ-command-example-prefix} ldap:invalidate-cache ---- +NOTE: Run this command inside the ownCloud Docker container. + == Manipulate LDAP Configurations This command manipulates LDAP configurations. @@ -300,6 +329,8 @@ This command manipulates LDAP configurations. {occ-command-example-prefix} ldap:set-config ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -323,6 +354,8 @@ This example sets search attributes: {occ-command-example-prefix} ldap:set-config s01 ldapAttributesForUserSearch "cn;givenname;sn;displayname;mail" ---- +NOTE: Run this command inside the ownCloud Docker container. + Available keys, along with default values for configValue, are listed in the table below. [width="70%",cols=",",options="header",] @@ -390,6 +423,8 @@ Tests whether your configuration is correct and can bind to the server. {occ-command-example-prefix} ldap:test-config ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -406,6 +441,8 @@ Example: The configuration is valid and the connection could be established! ---- +NOTE: Run this command inside the ownCloud Docker container. + == Set and Unset LDAP App Configurations [source,bash,subs="attributes+"] @@ -413,6 +450,8 @@ The configuration is valid and the connection could be established! {occ-command-example-prefix} config:app:set user_ldap updateAttributesInterval --value=7200 ---- +NOTE: Run this command inside the ownCloud Docker container. + In the example above, the interval is being set to 7200 seconds. Assuming the above example was used, the command would output the following: @@ -428,6 +467,8 @@ If you want to reset (or unset) the setting, then you can use the following comm {occ-command-example-prefix} config:app:delete user_ldap updateAttributesInterval ---- +NOTE: Run this command inside the ownCloud Docker container. + *Reuse Existing LDAP Accounts if Available* If you want to allow new LDAP logins to attempt to reuse existing `oc_accounts` entries that match the resolved username attribute, and have backend set to `User_Proxy`, then set the `reuse_accounts` config setting to `yes`. @@ -439,6 +480,8 @@ Below is an example of how to do so. {occ-command-example-prefix} config:app:set user_ldap reuse_accounts --value="yes" ---- +NOTE: Run this command inside the ownCloud Docker container. + This functionality is valuable for several reasons; these are: * It handles the situation of when admins mistakenly delete one or more user mappings, and subsequent logins then create new accounts. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_market_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_market_commands.adoc index 131798919..243809147 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_market_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_market_commands.adoc @@ -36,6 +36,8 @@ So its app id is `twofactor_backup_codes`. {occ-command-example-prefix} market:install [option] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="80%",cols="30%,70%",] @@ -66,6 +68,8 @@ Only `zip`, `gzip`, and `bzip2` archives are supported. {occ-command-example-prefix} market:install -l /mnt/data/richdocuments-2.0.0.tar.gz ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: The target directory has to be *accessible to the webserver user* and you have to *enable* the app afterwards with the `occ app:enable` command. == Uninstall an Application @@ -77,6 +81,8 @@ To uninstall an application use the following commands: {occ-command-example-prefix} market:uninstall ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="80%",cols="30%,70%",] @@ -94,6 +100,8 @@ It returns the ids of the apps. {occ-command-example-prefix} market:list ---- +NOTE: Run this command inside the ownCloud Docker container. + == Upgrade an Application Install new app versions if available on the marketplace by using following commands: @@ -103,6 +111,8 @@ Install new app versions if available on the marketplace by using following comm {occ-command-example-prefix} market:upgrade [options] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="80%",cols="30%,70%",] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_metrics_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_metrics_commands.adoc index 7559e1e74..7d4094856 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_metrics_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_metrics_commands.adoc @@ -28,6 +28,8 @@ Note: You can also set the config key/value manually into your config.php file. --value "your-metrics-secret" ---- +NOTE: Run this command inside the ownCloud Docker container. + The above command adds the following at the end of `config.php`: [source,php] @@ -44,6 +46,8 @@ This command reads the value of the `metrics_shared_secret` key from config.php: {occ-command-example-prefix} config:system:get "metrics_shared_secret" ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- your-metrics-secret @@ -58,3 +62,5 @@ This command completely removes the key and the value from config.php: {occ-command-example-prefix} config:system:delete "metrics_shared_secret" ---- +NOTE: Run this command inside the ownCloud Docker container. + diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_migrate_to_kitworks_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_migrate_to_kitworks_commands.adoc index bd50c40e6..cc71e4b2f 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_migrate_to_kitworks_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_migrate_to_kitworks_commands.adoc @@ -28,6 +28,8 @@ To start the migration, it must be initialized first: {occ-command-example-prefix} migrate:to-kiteworks:init KW_HOST KW_APPLICATION_ID "KW_SECRET" ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -59,6 +61,8 @@ After initialisation, the migration must be verified to be ready: {occ-command-example-prefix} migrate:to-kiteworks:verify $KW_ADMIN_USER ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -84,6 +88,8 @@ After verification, migrating users can be started: {occ-command-example-prefix} migrate:to-kiteworks:users $KW_ADMIN_USER $KW_PROFILE_GUEST ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -112,6 +118,8 @@ After migrating users, migrating files can be started: {occ-command-example-prefix} migrate:to-kiteworks:files $KW_ADMIN_USER ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -137,6 +145,8 @@ After migrating files, shares can be migrated. Note that when initiating this st {occ-command-example-prefix} migrate:to-kiteworks:shares $KW_ADMIN_USER ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -162,6 +172,8 @@ After migrating shares, the final step can be processed. This is to disable migr {occ-command-example-prefix} migrate:to-kiteworks:disable-users $KW_ADMIN_USER ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_password_policy_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_password_policy_commands.adoc index 37099c67f..ecc8c3e97 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_password_policy_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_password_policy_commands.adoc @@ -11,6 +11,8 @@ Command to expire a user or group of users’ passwords. {occ-command-example-prefix} user:expire-password [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,82%",] @@ -69,6 +71,8 @@ The password for frank is set to expire on 2018-07-12 13:15:28 UTC. {occ-command-example-prefix} user:expire-password --uid frank '15-Aug-05 15:52:01 UTC' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Caveats Please be aware of the following implications of enabling or changing the password policy's "*days until user password expires*" option. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_ransomware_protection_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_ransomware_protection_commands.adoc index c187c6e8b..e5057cee4 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_ransomware_protection_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_ransomware_protection_commands.adoc @@ -31,6 +31,8 @@ Scan the ownCloud database for changes in order to discover anomalies in a user {occ-command-example-prefix} ransomguard:scan ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -49,6 +51,8 @@ Revert all operations in a user account after a given point in time. Note that ` {occ-command-example-prefix} ransomguard:restore ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -67,6 +71,8 @@ When necessary, set a user account as `read-only` for ownCloud and other WebDAV {occ-command-example-prefix} ransomguard:lock ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -84,6 +90,8 @@ When ransomware issues have been resolved, the user account can be unlocked. {occ-command-example-prefix} ransomguard:unlock ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -105,6 +113,8 @@ This command will set the location of the blacklist file the app will use. The l {occ-command-example-prefix} ransomguard:blacklist:set-file ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== Arguments [width="100%",cols="20%,70%",] @@ -122,6 +132,8 @@ This command will update the contents of the blacklist file using another file a {occ-command-example-prefix} ransomguard:blacklist:update:from-file ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== Arguments [width="100%",cols="20%,70%",] @@ -139,6 +151,8 @@ This command will update the contents by getting the blacklist from a website. T {occ-command-example-prefix} ransomguard:blacklist:update:from-site ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== Arguments [width="100%",cols="20%,70%",] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_richdocuments.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_richdocuments.adoc index b8c7c9fa1..f78896b13 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_richdocuments.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_richdocuments.adoc @@ -41,6 +41,8 @@ Adding the port is only necessary when not using standard ports. {occ-command-example-prefix} config:app:set richdocuments wopi_url --value='[IP/URL]:port' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Enable Secure View Enable Secure View (possible values: true/false, default: false). @@ -52,6 +54,8 @@ The following example command enables secure view globally on the system: {occ-command-example-prefix} config:app:set richdocuments secure_view_option --value='true' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Define the Watermark Pattern Displayed A watermark pattern is displayed in the document when it is viewed. It can be an arbitrary string. The keyword \{viewer-email} will be replaced with the current user's email address in the document watermark. If an email address is not set, then the user's display name will be used. @@ -63,6 +67,8 @@ The following example command sets the watermark pattern displayed in the docume {occ-command-example-prefix} config:app:set richdocuments watermark_text --value='Restricted to \{viewer-email}' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Open Documents in a New Tab By default, documents will open in a new tab if not otherwise defined. You can change this behaviour with a command (possible values: true/false, default: false). @@ -74,6 +80,8 @@ The following example command makes documents open in the same tab: {occ-command-example-prefix} config:app:set richdocuments open_in_new_tab --value='false' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Define the Print and Exporting Option Enable documents in secure view mode to be printed and exported (possible values: true/false, default: false). @@ -85,6 +93,8 @@ The following example command enables the option to globally print and export do {occ-command-example-prefix} config:app:set secure_view_can_print_default --value='true' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Enforce Displaying the Watermark Open documents in secure view with watermark by default (possible values: true/false, default: false). @@ -96,6 +106,8 @@ The following example command enables the option to globally enforce displaying {occ-command-example-prefix} config:app:set richdocuments secure_view_open_action_default --value='true' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Delete a Key or Change a Key You can delete a key with the following example command: @@ -105,9 +117,13 @@ You can delete a key with the following example command: {occ-command-example-prefix} config:app:delete richdocuments secure_view_open_action_default ---- +NOTE: Run this command inside the ownCloud Docker container. + You can change a key with the following example command: [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:set richdocuments secure_view_option --value='false' ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_s3objectstore_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_s3objectstore_commands.adoc index f93c170b0..63a8a96a8 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_s3objectstore_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_s3objectstore_commands.adoc @@ -11,6 +11,8 @@ Marketplace URL: {oc-marketplace-url}/apps/files_primary_s3[S3 Primary Object St {occ-command-example-prefix} s3:list ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="80%",cols="30%,70%",] @@ -26,6 +28,8 @@ Marketplace URL: {oc-marketplace-url}/apps/files_primary_s3[S3 Primary Object St {occ-command-example-prefix} s3:create-bucket ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="80%",cols="30%,70%",] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_saml_sso_shibboleth_integration_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_saml_sso_shibboleth_integration_commands.adoc index 29b0577ac..46e604843 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_saml_sso_shibboleth_integration_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_saml_sso_shibboleth_integration_commands.adoc @@ -8,3 +8,5 @@ Marketplace URL: {oc-marketplace-url}/apps/user_shibboleth[SAML/SSO Integration] ---- {occ-command-example-prefix} shibboleth:mode [mode] ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_wnd_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_wnd_commands.adoc index a08c6415f..65f1103f6 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_wnd_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/app_commands/_wnd_commands.adoc @@ -27,6 +27,8 @@ Listen to smb changes and store notifications for later processing in the databa {occ-command-example-prefix} wnd:listen [options] [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="90%",cols="40%,80%",] @@ -83,6 +85,8 @@ Process the notifications stored by the `wnd:listen` command {occ-command-example-prefix} wnd:process-queue [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="90%",cols="40%,80%",] @@ -112,6 +116,8 @@ Sets the service account for the target mount point. You'll be asked for the pas {occ-command-example-prefix} wnd:set-service-account [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + Please see the occ documentation of xref:configuration/server/occ_command.adoc#files_externallist[files_external:list] to get the required mount-id. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_2fa_core_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_2fa_core_commands.adoc index e7a912c3c..34ae1fa28 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_2fa_core_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_2fa_core_commands.adoc @@ -22,6 +22,8 @@ Disable two-factor authentication for a user: {occ-command-example-prefix} twofactorauth:disable [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -39,6 +41,8 @@ Enable two-factor authentication for a user: {occ-command-example-prefix} twofactorauth:enable [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_app_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_app_commands.adoc index dabc63894..9d0c05da4 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_app_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_app_commands.adoc @@ -22,6 +22,8 @@ The output shows whether they are enabled or disabled. {occ-command-example-prefix} app:list [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -65,6 +67,8 @@ Enable an app, for example the Market app. market enabled ---- +NOTE: Run this command inside the ownCloud Docker container. + == Disable an App [source,bash,subs="attributes+"] @@ -73,6 +77,8 @@ market enabled market disabled ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: Be aware that the following apps cannot be disabled: _DAV_, _FederatedFileSharing_, _Files_ and _Files_External_. == Check App Code @@ -90,6 +96,8 @@ By default all checks are enabled. The Activity app is an example of a correctly App is compliant - awesome job! ---- +NOTE: Run this command inside the ownCloud Docker container. + If your app has issues, you'll see output like this. [source,bash,subs="attributes+"] @@ -103,6 +111,8 @@ Analysing /var/www/owncloud/apps/files/foo_app.php line 49: OC_Util - Static method of private class must not be called ---- +NOTE: Run this command inside the ownCloud Docker container. + == Get the App Installation Path You can get the full file path to an app. @@ -113,3 +123,5 @@ You can get the full file path to an app. /var/www/owncloud/apps/notifications ---- +NOTE: Run this command inside the ownCloud Docker container. + diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_background_jobs_selector.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_background_jobs_selector.adoc index 57652cec0..b4cddaec0 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_background_jobs_selector.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_background_jobs_selector.adoc @@ -25,5 +25,7 @@ background {occ-command-example-prefix} background:webcron ---- +NOTE: Run this command inside the ownCloud Docker container. + TIP: Check out the sections xref:configuration/server/occ_command.adoc#managing-background-jobs[Managing Background Jobs] and xref:configuration/server/background_jobs_configuration.adoc[Background Jobs configuration] to learn more. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_command_line_installation_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_command_line_installation_commands.adoc index 67ba27f55..2a47dac17 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_command_line_installation_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_command_line_installation_commands.adoc @@ -39,6 +39,8 @@ Available commands: maintenance:install Install ownCloud ---- +NOTE: Run this command inside the ownCloud Docker container. + == Command Description @@ -51,6 +53,8 @@ ownCloud is not installed - only a limited number of commands are available Usage: ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- maintenance:install [--database=["..."]] [--database-connection-string=["..."]] \ @@ -122,3 +126,5 @@ cd /var/www/owncloud/ ownCloud is not installed - only a limited number of commands are available ownCloud was successfully installed ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_command_line_upgrade_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_command_line_upgrade_commands.adoc index 49706a2c9..60df06634 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_command_line_upgrade_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_command_line_upgrade_commands.adoc @@ -12,6 +12,8 @@ Usage: upgrade [options] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Options [width="100%",cols="20%,70%",] @@ -40,6 +42,8 @@ Update successful Turned off maintenance mode ---- +NOTE: Run this command inside the ownCloud Docker container. + Note how it details the steps. Enabling verbosity displays timestamps: [source,bash,subs="attributes+"] @@ -55,6 +59,8 @@ ownCloud or one of the apps require upgrade - only a limited number of commands 2017-06-23T09:06:15+0000 Turned off maintenance mode ---- +NOTE: Run this command inside the ownCloud Docker container. + If there is an error it throws an exception, and the error is detailed in your ownCloud logfile, so you can use the log output to figure out what went wrong, or to use in a bug report. ---- diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_config_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_config_commands.adoc index 97f61ee96..fbfb4305b 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_config_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_config_commands.adoc @@ -80,6 +80,8 @@ These commands manage the configurations of apps. Keys and values are stored in {occ-command-example-prefix} config:app:delete [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -104,6 +106,8 @@ These commands manage the configurations of apps. Keys and values are stored in Config value provisioning_api of app myappname deleted ---- +NOTE: Run this command inside the ownCloud Docker container. + The delete command will by default not complain if the configuration was not set before. If you want to be notified in that case, set the `--error-if-not-exists` flag. @@ -113,6 +117,8 @@ If you want to be notified in that case, set the `--error-if-not-exists` flag. Config provisioning_api of app appname could not be deleted because it did not exist ---- +NOTE: Run this command inside the ownCloud Docker container. + == config:app:get [source,bash,subs="attributes+"] @@ -120,6 +126,8 @@ Config provisioning_api of app appname could not be deleted because it did not e {occ-command-example-prefix} config:app:get [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -145,6 +153,8 @@ the command will exit with 1. 2.2.1 ---- +NOTE: Run this command inside the ownCloud Docker container. + == config:app:set [source,bash,subs="attributes+"] @@ -152,6 +162,8 @@ the command will exit with 1. {occ-command-example-prefix} config:app:set [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -181,6 +193,8 @@ the command will exit with 1. Config value incoming_server2server_share_enabled for app files_sharing set to yes ---- +NOTE: Run this command inside the ownCloud Docker container. + The `config:app:set` command creates the value, if it does not already exist. To update an existing value, set `--update-only`: [source,bash,subs="attributes+"] @@ -193,6 +207,8 @@ The `config:app:set` command creates the value, if it does not already exist. To Value not updated, as it has not been set before. ---- +NOTE: Run this command inside the ownCloud Docker container. + == General Config Commands These commands manage listing and importing configurations. @@ -207,6 +223,8 @@ Values that exist in the current configuration, but not in the one that is being {occ-command-example-prefix} config:import filename.json ---- +NOTE: Run this command inside the ownCloud Docker container. + It is also possible to import remote files, by piping the input: [source,bash,subs="attributes+"] @@ -214,6 +232,8 @@ It is also possible to import remote files, by piping the input: {occ-command-example-prefix} config:import < local-backup.json ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: While it is possible to update/set/delete the versions and installation statuses of apps and ownCloud itself, it is *not* recommended to do this directly. Use the `occ app:enable`, `occ app:disable` and `occ update` commands instead. @@ -226,6 +246,8 @@ The `config:list` command lists all configuration values for your ownCloud setup {occ-command-example-prefix} config:list [options] [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -258,6 +280,8 @@ To generate a full report which includes sensitive values, such as passwords and {occ-command-example-prefix} config:list --private ---- +NOTE: Run this command inside the ownCloud Docker container. + === Filtering Information Reported The output can be filtered to just the core information, core and apps, or one specific app. @@ -276,6 +300,8 @@ In the example below, you can see how to filter for each of these categories. {occ-command-example-prefix} config:list -- dav ---- +NOTE: Run this command inside the ownCloud Docker container. + Below is an example of listing the config details for a single app. [source,json] @@ -301,6 +327,8 @@ These commands manage system configurations. {occ-command-example-prefix} config:system:delete [options] [--] ()... ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -324,6 +352,8 @@ These commands manage system configurations. System config value maintenance:mode deleted ---- +NOTE: Run this command inside the ownCloud Docker container. + == config:system:get [source,bash,subs="attributes+"] @@ -331,6 +361,8 @@ System config value maintenance:mode deleted {occ-command-example-prefix} config:system:get [options] [--] ()... ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -355,6 +387,8 @@ the command will exit with 1. 10.7.0.4 ---- +NOTE: Run this command inside the ownCloud Docker container. + == config:system:set [source,bash,subs="attributes+"] @@ -362,6 +396,8 @@ the command will exit with 1. {occ-command-example-prefix} config:system:set [options] [--] ()... ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -396,6 +432,8 @@ ownCloud is in maintenance mode - no app have been loaded System config value maintenance set to boolean false ---- +NOTE: Run this command inside the ownCloud Docker container. + Create the `app_paths` config setting (using a JSON payload because of multi array values): [source,bash,subs="attributes+"] @@ -416,6 +454,8 @@ Create the `app_paths` config setting (using a JSON payload because of multi arr ]' ---- +NOTE: Run this command inside the ownCloud Docker container. + Adding Redis to the configuration: [source,bash,subs="attributes+"] @@ -428,6 +468,8 @@ Adding Redis to the configuration: System config value redis set to json {"host": "{oc-examples-server-ip}", "port": "{std-port-redis}"} ---- +NOTE: Run this command inside the ownCloud Docker container. + Some configurations (e.g., the trusted domain setting) are an array of data. The array starts counting with 0. In order to set (and also get) the value of one key, you can specify multiple `config` names separated by spaces: @@ -439,6 +481,8 @@ owncloud.local sample.tld ---- +NOTE: Run this command inside the ownCloud Docker container. + To replace `sample.tld` with `example.com` trusted_domains => 2 needs to be set: [source,bash,subs="attributes+"] @@ -451,3 +495,5 @@ localhost owncloud.local example.com ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_config_reports_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_config_reports_commands.adoc index dc15bb771..467c69d66 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_config_reports_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_config_reports_commands.adoc @@ -10,6 +10,8 @@ From the command-line in the root directory of your ownCloud installation, run i {occ-command-example-prefix} configreport:generate ---- +NOTE: Run this command inside the ownCloud Docker container. + This will generate the report and send it to `STDOUT`. You can optionally pipe the output to a file and then attach it to an email to ownCloud support, by running the following command: @@ -18,6 +20,8 @@ You can optionally pipe the output to a file and then attach it to an email to o {occ-command-example-prefix} configreport:generate > generated-config-report.txt ---- +NOTE: Run this command inside the ownCloud Docker container. + Alternatively, you could generate the report and email it all in one command, by running: [source,bash,subs="attributes+"] @@ -28,4 +32,6 @@ Alternatively, you could generate the report and email it all in one command, by ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: These commands are not available in xref:maintenance-commands[single-user (maintenance) mode]. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_database_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_database_commands.adoc index e156ecb26..0ff376c4b 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_database_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_database_commands.adoc @@ -2,31 +2,6 @@ == Database Conversion Commands -=== Convert the Database Type - -The SQLite database is good for testing, and for ownCloud servers with small single-user workloads that do not use sync clients, but production servers with multiple users should use MariaDB, MySQL, or PostgreSQL. You can use `occ` to convert from SQLite to one of these other databases. - -[source,plaintext] ----- -db - db:convert-type Convert the ownCloud database to the newly configured one ----- - -You need: - -* Your desired database and its PHP connector installed. -* The login and password of a database admin user. -* The database port number, if it is a non-standard port. - -This is example converts SQLite to MySQL/MariaDB: - -[source,bash,subs="attributes+"] ----- -{occ-command-example-prefix} db:convert-type mysql oc_dbuser 127.0.0.1 oc_database ----- - -TIP: For a more detailed explanation see xref:configuration/database/db_conversion.adoc[converting database types]. - === Convert the MySQL Charset Convert charset of MySQL/MariaDB to use utf8mb4. If you are using an older ownCloud installation, the database may not be setup to use the 4-byte unicode charset. This command changes the database charset to use `utf8mb4`. Check your database charset before you use this command. @@ -36,6 +11,8 @@ Convert charset of MySQL/MariaDB to use utf8mb4. If you are using an older ownCl {occ-command-example-prefix} db:convert-mysql-charset ---- +NOTE: Run this command inside the ownCloud Docker container. + == Restore the Table Format This command sets the default row format of MySQL/MariaDB tables. This is only necessary once before you are going to e.g. install MariaDB 10.6 or higher because the COMPRESSED row format is now read-only by default. As a prerequisite, ownCloud 10.9 needs to be installed first. See the xref:maintenance/upgrading/database_upgrade.adoc[Database Upgrade] guide for details. @@ -44,3 +21,5 @@ This command sets the default row format of MySQL/MariaDB tables. This is only n ---- {occ-command-example-prefix} db:restore-default-row-format ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_dav_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_dav_commands.adoc index ce89b5a15..d0e44c85e 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_dav_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_dav_commands.adoc @@ -23,6 +23,8 @@ NOTE: These commands are not available in xref:maintenance-commands[single-user {occ-command-example-prefix} dav:cleanup-chunks [options] [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="25%,70%",] @@ -54,6 +56,8 @@ Cleaning chunks for admin 0 [>---------------------------] ---- +NOTE: Run this command inside the ownCloud Docker container. + == Create Addressbook Create a dav address book. @@ -63,6 +67,8 @@ Create a dav address book. {occ-command-example-prefix} dav:create-addressbook ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="25%,70%",] @@ -83,6 +89,8 @@ This example creates the address book `mollybook` for the user molly: {occ-command-example-prefix} dav:create-addressbook molly mollybook ---- +NOTE: Run this command inside the ownCloud Docker container. + Molly will immediately see her address book. == Create Calendar @@ -94,6 +102,8 @@ Create a dav calendar. {occ-command-example-prefix} dav:create-calendar ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="25%,70%",] @@ -114,6 +124,8 @@ This example creates a new calendar `mollycal` for user molly: {occ-command-example-prefix} dav:create-calendar molly mollycal ---- +NOTE: Run this command inside the ownCloud Docker container. + Molly will immediately see her calendar. // NOTE: dav:migrate-addressbooks has been removed with: https://github.com/owncloud/core/pull/23976 @@ -128,6 +140,8 @@ Synchronizes the birthday calendar. It adds all birthdays to your calendar from {occ-command-example-prefix} dav:sync-birthday-calendar [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="25%,70%",] @@ -145,6 +159,8 @@ This example syncs to your calendar from user `bernie`: {occ-command-example-prefix} dav:sync-birthday-calendar bernie ---- +NOTE: Run this command inside the ownCloud Docker container. + == Sync System Addressbook Synchronizes all users to the system addressbook. @@ -153,3 +169,5 @@ Synchronizes all users to the system addressbook. ---- {occ-command-example-prefix} dav:sync-system-addressbook ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_encryption_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_encryption_commands.adoc index 9fd848c3d..e9586afcd 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_encryption_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_encryption_commands.adoc @@ -50,6 +50,8 @@ To enable encryption you must first enable the Encryption app and then run `occ - defaultModule: OC_DEFAULT_MODULE ---- +NOTE: Run this command inside the ownCloud Docker container. + == Encrypt the Users Home Storage Server-side encryption for local storage like the users home and remote storages like Google Drive can operate independently of each other. By doing so, you can encrypt a remote storage without also having to encrypt the users home storage on your ownCloud server. Possible values are `0` and `1` @@ -70,6 +72,8 @@ The folder must exist and the path is relative to your data directory. {occ-command-example-prefix} encryption:change-key-storage-root ../data/security/oc-keys ---- +NOTE: Run this command inside the ownCloud Docker container. + You can see the current location of your keys folder: [source,bash,subs="attributes+"] @@ -78,6 +82,8 @@ You can see the current location of your keys folder: Current key storage root: default storage location (data/) ---- +NOTE: Run this command inside the ownCloud Docker container. + == List Modules `encryption:list-modules` displays your available encryption modules. @@ -108,6 +114,8 @@ This argument automatically answers, potential, questions with "yes", which is p {occ-command-example-prefix} encryption:decrypt freda ---- +NOTE: Run this command inside the ownCloud Docker container. + Users must have enabled recovery keys on their Personal pages. You must first put your ownCloud server into single-user mode, using xref:maintenance-commands[the maintenance commands], to prevent any user activity until decryption is completed. === Arguments @@ -168,6 +176,8 @@ The `-y` switch can be supplied to automate acceptance of user input. {occ-command-example-prefix} encryption:fix-encrypted-version [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + `encryption:fix-encrypted-version` fixes the encrypted version of files if the encrypted file(s) are not downloadable for a given user. You only need this command if you get an "Invalid Signature" message in the browser or the clients. Background: the `oc_filecache` database table contains the integer columns "version" and "encryptedVersion" which start with 1 and are incremented on every file modification. When using encryption, those values are used together with the ciphertext to generate a cryptographic signature for the file. The version value is required to verify the signature. In some very rare cases like timeouts or bugs etc., the value might not get updated accordingly or get lost. The brute-force approach is to use the `fix:encrypted:version` command until the file can be decrypted. Starting with ownCloud 10.8, the behavior of the command got improved so that the encryptedVersion value is reset to its original value if no correct version was found. Before that fix, the last tried value was stored in the database thus modifying the state of the system and making further rescue attempts non-deterministic. @@ -204,6 +214,8 @@ Searches in increments from -n to +n. [default: "5"] {occ-command-example-prefix} encryption:hsmdaemon [options] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Options [width="100%",cols="30%,70%",] @@ -230,6 +242,8 @@ Allows to test the `hsmdaemon` setup by providing an encrypted string to ownClou {occ-command-example-prefix} encryption:hsmdaemon:decrypt [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="30%,70%",] @@ -258,6 +272,8 @@ Set the url on which the `hsmdaemon` REST-API is reachable. {occ-command-example-prefix} config:app:set encryption hsm.url --value 'http://127.0.0.1:8513' ---- +NOTE: Run this command inside the ownCloud Docker container. + === Set the JSON Web Token Secret To access the `hsmdaemon` API, ownCloud must authenticate with a JWT (JSON Web Token). The given secret is shared between the `hsdmdaemon` (see the hsmdaemon.toml configuration file) and ownCloud to sign the JWT. See the xref:configuration/server/security/hsmdaemon/index.adoc[HSM documentation] for an example how to generate a secret. @@ -267,6 +283,8 @@ To access the `hsmdaemon` API, ownCloud must authenticate with a JWT (JSON Web T {occ-command-example-prefix} config:app:set encryption hsm.jwt.secret --value '7a7d1826-b514-4d9f-afc7-a7485084e8de' ---- +NOTE: Run this command inside the ownCloud Docker container. + === Set the JWT Clockskew The JWT described above has an expiry timestamp. In case the time clocks on ownCloud and hsmdaemon system drift or skew apart, additional time is added to the expiry time to counteract this situation. Set or change the clockskew only if ownCloud advises to do so. Defaults to 120, value is in seconds. @@ -275,3 +293,5 @@ The JWT described above has an expiry timestamp. In case the time clocks on ownC ---- {occ-command-example-prefix} config:app:set encryption hsm.jwt.clockskew --value '120' ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_federation_sync_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_federation_sync_commands.adoc index 5ddd01751..1e31a5510 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_federation_sync_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_federation_sync_commands.adoc @@ -10,4 +10,6 @@ Use this command to synchronize federated servers: {occ-command-example-prefix} federation:sync-addressbooks ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: This command is only available when the "Federation" app (`federation`) is enabled. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_federation_trusted_servers.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_federation_trusted_servers.adoc index 95d528f8c..388eac2ea 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_federation_trusted_servers.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_federation_trusted_servers.adoc @@ -19,6 +19,8 @@ This command adds a trusted federated server. {occ-command-example-prefix} federation:trusted-servers:add ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="25%,70%",] @@ -37,6 +39,8 @@ In the example below, the named trusted server is added. https://myserver:8888/server/owncloud ---- +NOTE: Run this command inside the ownCloud Docker container. + == List Trusted Servers This command lists all trusted federated servers that have been added. @@ -46,6 +50,8 @@ This command lists all trusted federated servers that have been added. {occ-command-example-prefix} federation:trusted-servers:list ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example In the example below, all trusted servers that have been added are listed. @@ -56,6 +62,8 @@ In the example below, all trusted servers that have been added are listed. ---- +NOTE: Run this command inside the ownCloud Docker container. + *Output:* [source,plaintext] @@ -77,6 +85,8 @@ This command removes a trusted federated server. {occ-command-example-prefix} federation:trusted-servers:remove ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="25%,70%",] @@ -94,6 +104,8 @@ In the example below, the trusted server with ID=2 gets removed. {occ-command-example-prefix} federation:trusted-servers:remove 2 ---- +NOTE: Run this command inside the ownCloud Docker container. + *Output:* [source,plaintext] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_file_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_file_commands.adoc index b318bb171..70df3cec1 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_file_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_file_commands.adoc @@ -42,6 +42,8 @@ This is why this command is only provided to check for one file instead of scann files:check-cache [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -66,6 +68,8 @@ Examples of checking files for user maria: welcome.txt has been accessed properly ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} files:check-cache maria maria@smbhome/myfile.txt @@ -74,6 +78,8 @@ Ignoring maria@smbhome/myfile.txt because it is shared or not inside the primary ---- +NOTE: Run this command inside the ownCloud Docker container. + == The files:checksums:verify command ownCloud supports file integrity checking, by computing and matching checksums. @@ -103,6 +109,8 @@ Mismatch for thumbnails/9/2048-2048-max.png: Actual: SHA1:da39a3ee5e6b4b0d3255bfef95601890afd80709 MD5:d41d8cd98f00b204e9800998ecf8427e ADLER32:00000001 ---- +NOTE: Run this command inside the ownCloud Docker container. + === Options [width="100%",cols="20%,70%",] @@ -133,6 +141,8 @@ When a mount point gets removed, the storage ID and file cache related info stay files:remove-storage [options] [--] []... ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="23%,70%",] @@ -164,6 +174,8 @@ This command should be handled with absolute care because *any* storage ID and t {occ-command-example-prefix} files:remove-storage --show-candidates ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- +------------+-------------------------------------------------+------------+ @@ -197,6 +209,8 @@ IMPORTANT: Scanning is only possible when using POSIX filesystems but not for ob files:scan [options] [--] []... ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -247,6 +261,8 @@ To get a list of scannable mounts for a given user, use the following command: {occ-command-example-prefix} files_external:list user_id ---- +NOTE: Run this command inside the ownCloud Docker container. + TIP: Mounts are only scannable at the point of origin. Scanning of shares including federated shares is not necessary on the receiver side and therefore not possible. @@ -281,6 +297,8 @@ This way is much faster than running the command for every user separately, but {occ-command-example-prefix} maintenance:singleuser --off ---- +NOTE: Run this command inside the ownCloud Docker container. + The following command filters by the storage of the specified user. [source,bash,subs="attributes+"] @@ -288,6 +306,8 @@ The following command filters by the storage of the specified user. {occ-command-example-prefix} files:scan USERID --repair ---- +NOTE: Run this command inside the ownCloud Docker container. + TIP: If many users are affected, it could be convenient to create a shell script, which iterates over a list of User ID's. == The files:transfer-ownership command @@ -307,6 +327,8 @@ This command is useful before removing users. files:transfer-ownership [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -338,6 +360,8 @@ For example, to move all files from `` to `` tran ---- +NOTE: Run this command inside the ownCloud Docker container. + You can also move a limited set of files from `` to `` transfer folder by making use of the `--path` switch, as in the example below. Ownership of `folder/to/move` and all files and folders which it contains will be transferred to `` transfer folder. @@ -349,6 +373,8 @@ Ownership of `folder/to/move` and all files and folders which it contains will b ---- +NOTE: Run this command inside the ownCloud Docker container. + If the entire user folder of `` needs to be migrated to `` user folder, use the `--destination-use-user-folder` switch, as in the example below. The destination user needs to be created but never log in, we recommend using owncloud maintenance mode for this operation. @@ -360,6 +386,8 @@ The destination user needs to be created but never log in, we recommend using ow ---- +NOTE: Run this command inside the ownCloud Docker container. + Please keep the following in mind when using this command: . The directory provided to the `--path` switch *must* exist inside `data//files`. @@ -385,6 +413,8 @@ NOTE: By default, the command performs a dry run and displays the problems found files:troubleshoot-transfer-ownership [options] [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="30%,90%",] @@ -409,6 +439,8 @@ Run the command with one of the type arguments: ---- +NOTE: Run this command inside the ownCloud Docker container. + The command can attempt to fix the issues with the `--fix` flag, + or execute for a single user using `--uid ` @@ -418,3 +450,5 @@ or execute for a single user using `--uid ` --fix \ --uid=UID ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_files_external_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_files_external_commands.adoc index ed0f5d8cf..383c5c3ad 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_files_external_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_files_external_commands.adoc @@ -69,6 +69,8 @@ files_external:list [--show-password] [--full] [-a|--all] [-s|--short] [--] [ ---- +NOTE: Run this command inside the ownCloud Docker container. + == Arguments [width="100%",cols="20%,70%",] @@ -24,3 +26,5 @@ This example executes the migration step for the core app: {occ-command-example-prefix} migrations:execute core 20181220085457 ---- +NOTE: Run this command inside the ownCloud Docker container. + diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_notifications_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_notifications_commands.adoc index d4b1a2bc6..52111eee6 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_notifications_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_notifications_commands.adoc @@ -15,6 +15,8 @@ notifications {occ-command-example-prefix} notifications:generate [-u|--user USER] [-g|--group GROUP] [-l|--link ] [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments: [width="100%",cols="20%,70%",] @@ -45,3 +47,5 @@ Example: {occ-command-example-prefix} notifications:generate -g Office "Emergency Alert" "Rebooting in 5min" ---- +NOTE: Run this command inside the ownCloud Docker container. + diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_previews_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_previews_commands.adoc index 4507627fb..15c839915 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_previews_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_previews_commands.adoc @@ -17,6 +17,8 @@ Removing not referenced previews can be necessary, e.g., when the image has been {occ-command-example-prefix} previews:cleanup [options] [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="25%,70%",] @@ -55,6 +57,8 @@ In the example below, you run one loop with max (default) 1000 files processed. {occ-command-example-prefix} previews:cleanup ---- +NOTE: Run this command inside the ownCloud Docker container. + Other combinations could be: * `previews:cleanup -- 50`: run once and process 50 files diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_security_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_security_commands.adoc index 7acf4338f..8235477e7 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_security_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_security_commands.adoc @@ -26,6 +26,8 @@ Example 1: {occ-command-example-prefix} security:routes ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- +-----------------------------------------------------------+-----------------+ @@ -46,6 +48,8 @@ Example 2: {occ-command-example-prefix} security:routes --output=json-pretty ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- [ @@ -64,6 +68,8 @@ Example 3: {occ-command-example-prefix} security:routes --with-details ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,plaintext] ---- +---------------------------------------------+---------+-------------------------------------------------------+--------------------------------+ @@ -92,6 +98,8 @@ This example lists your installed certificates: {occ-command-example-prefix} security:certificates ---- +NOTE: Run this command inside the ownCloud Docker container. + Import a new certificate: [source,bash,subs="attributes+"] @@ -99,9 +107,13 @@ Import a new certificate: {occ-command-example-prefix} security:certificates:import /path/to/certificate ---- +NOTE: Run this command inside the ownCloud Docker container. + Remove a certificate: [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} security:certificates:remove [certificate name] ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_sharing_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_sharing_commands.adoc index f41027ea3..442e1fec6 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_sharing_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_sharing_commands.adoc @@ -20,6 +20,8 @@ So, to cleanup all orphaned remote storages, run it as follows: {occ-command-example-prefix} sharing:cleanup-remote-storages ---- +NOTE: Run this command inside the ownCloud Docker container. + You can also set it up to run as xref:background-jobs-selector[a background job]. NOTE: These commands are not available in xref:maintenance-commands[single-user (maintenance) mode]. @@ -33,9 +35,13 @@ Currently, if a federated share is invalid or the API endpoint returns a "not fo {occ-command-example-prefix} config:app:set files_sharing enable_cleanup_invalid_external_shares --value no ---- +NOTE: Run this command inside the ownCloud Docker container. + To revert that setting to its default behavior, run: [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:delete files_sharing enable_cleanup_invalid_external_shares ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_system_command.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_system_command.adoc index 3e5a5a742..9938a2c2b 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_system_command.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_system_command.adoc @@ -13,6 +13,8 @@ system:cron [options] ---- +NOTE: Run this command inside the ownCloud Docker container. + == Options [width="100%",cols="20%,70%",] @@ -29,6 +31,8 @@ To execute xref:configuration/server/background_jobs_configuration.adoc[backgrou {occ-command-example-prefix} system:cron ---- +NOTE: Run this command inside the ownCloud Docker container. + If the `--progress` or `-p` argument is specified, then progress output will be displayed in the console, as in the example below. [source,console] @@ -60,6 +64,9 @@ Use the following one instead ---- {occ-command-example-prefix} system:cron ---- + +NOTE: Run this command inside the ownCloud Docker container. + ==== [NOTE] diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_trashbin_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_trashbin_commands.adoc index 12cc42506..b66993974 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_trashbin_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_trashbin_commands.adoc @@ -25,6 +25,8 @@ Remove deleted files for users on backend Database edward ---- +NOTE: Run this command inside the ownCloud Docker container. + This example removes the deleted files of users `molly` and `freda`: [source,bash,subs="attributes+"] @@ -34,5 +36,7 @@ Remove deleted files of molly Remove deleted files of freda ---- +NOTE: Run this command inside the ownCloud Docker container. + `trashbin:expire` deletes only expired files according to the `trashbin_retention_obligation` setting in `config.php` (see xref:configuration/server/config_sample_php_parameters.adoc[the "Deleted Files" section documentation]). The default is to delete expired files for all users, or you may list users in a space-delimited list. diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_user_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_user_commands.adoc index cbe274e6e..f45a75aea 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_user_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_user_commands.adoc @@ -42,6 +42,8 @@ You can create a new user with the `user:add` command. ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="30%,70%",] @@ -91,6 +93,8 @@ If either group does not exist, it is created. User "layla" added to group "db-admins" ---- +NOTE: Run this command inside the ownCloud Docker container. + .Create a user with a temporary password (the user will receive a link to set their password). [source,bash,subs="attributes+"] ---- @@ -107,6 +111,8 @@ User layla added to group users User layla added to group db-admins ---- +NOTE: Run this command inside the ownCloud Docker container. + == Deleting A User To delete a user, you use the `user:delete` command. @@ -116,6 +122,8 @@ To delete a user, you use the `user:delete` command. {occ-command-example-prefix} user:delete [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -138,6 +146,8 @@ To delete a user, you use the `user:delete` command. {occ-command-example-prefix} user:delete fred ---- +NOTE: Run this command inside the ownCloud Docker container. + == Disable Users Admins can disable users via the occ command too: @@ -147,6 +157,8 @@ Admins can disable users via the occ command too: {occ-command-example-prefix} user:disable ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -164,6 +176,8 @@ NOTE: Once users are disabled, their connected browsers will be disconnected. Us {occ-command-example-prefix} user:enable ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -183,6 +197,8 @@ This command is complementary when using `user:move-home`. {occ-command-example-prefix} user:home:list-dirs [options] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Options [width="100%",cols="20%,70%"] @@ -199,6 +215,8 @@ This command is complementary when using `user:move-home`. - /var/www/owncloud/data ---- +NOTE: Run this command inside the ownCloud Docker container. + == List all Users For a Given Home Directory List all users that have their home in a given path. For details see xref:configuration/user/user_management.adoc#moving-the-user-home[Moving the User Home] documentation. @@ -210,6 +228,8 @@ This command is complementary when using `user:move-home`. {occ-command-example-prefix} user:home:list-users [options] [--] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%"] @@ -243,6 +263,8 @@ Note for the example below, some user accounts originated from LDAP. - dbcca7b4-7306-103b-813a-19652cf0a9d2 ---- +NOTE: Run this command inside the ownCloud Docker container. + Run the following command to list all users from all available home directories. The example shows, that user `lisa` has been moved to a different home directory with `user:move-home`. [source,bash,subs="attributes+"] @@ -255,6 +277,8 @@ Run the following command to list all users from all available home directories. - user01 ---- +NOTE: Run this command inside the ownCloud Docker container. + == Finding Inactive Users To view a list of users who've not logged in for a given number of days, use the `user:inactive` command. @@ -264,6 +288,8 @@ To view a list of users who've not logged in for a given number of days, use the {occ-command-example-prefix} user:inactive [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -287,6 +313,8 @@ The example below searches for users inactive for five days or more: {occ-command-example-prefix} user:inactive 5 ---- +NOTE: Run this command inside the ownCloud Docker container. + By default, this will generate output in the following format: [source,plaintext] @@ -326,6 +354,8 @@ To view a user's most recent login, use the `user:lastseen` command: {occ-command-example-prefix} user:lastseen ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -342,6 +372,8 @@ Example layla's last login: 09.01.2015 18:46 ---- +NOTE: Run this command inside the ownCloud Docker container. + == Listing Users You can list existing users with the `user:list` command. @@ -351,6 +383,8 @@ You can list existing users with the `user:list` command. {occ-command-example-prefix} user:list [options] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + User IDs containing the `search-pattern` string are listed. Matching is not case-sensitive. If you do not provide a search-pattern then all users are listed. @@ -383,6 +417,8 @@ This example lists user IDs containing the string `ron` - aaron: Aaron Smith ---- +NOTE: Run this command inside the ownCloud Docker container. + The output can be formatted in JSON with the output option `json` or `json_pretty`. [source,bash,subs="attributes+"] @@ -395,6 +431,8 @@ The output can be formatted in JSON with the output option `json` or `json_prett } ---- +NOTE: Run this command inside the ownCloud Docker container. + This example lists all users including the attribute `enabled`. [source,bash,subs="attributes+"] @@ -404,6 +442,8 @@ This example lists all users including the attribute `enabled`. - foo: true ---- +NOTE: Run this command inside the ownCloud Docker container. + == Listing Group Membership of a User You can list the group membership of a user with the `user:list-groups` command. @@ -413,6 +453,8 @@ You can list the group membership of a user with the `user:list-groups` command. {occ-command-example-prefix} user:list-groups [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -440,6 +482,8 @@ This example lists group membership of user `julie`: - Finance ---- +NOTE: Run this command inside the ownCloud Docker container. + The output can be formatted in JSON with the output option `json` or `json_pretty`: [source,bash,subs="attributes+"] @@ -451,6 +495,8 @@ The output can be formatted in JSON with the output option `json` or `json_prett ] ---- +NOTE: Run this command inside the ownCloud Docker container. + == Modify User Details This command modifies either the users username or email address. @@ -460,6 +506,8 @@ This command modifies either the users username or email address. {occ-command-example-prefix} user:modify [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -481,6 +529,8 @@ All three arguments are mandatory and can not be empty. Example to set the email {occ-command-example-prefix} user:modify carla email foobar@foo.com ---- +NOTE: Run this command inside the ownCloud Docker container. + The email address of `carla` is updated to `foobar@foo.com`. == Move a Users Home Folder @@ -492,6 +542,8 @@ This command moves a user's home folder to a new location. For details see xref: {occ-command-example-prefix} user:move-home ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -518,6 +570,8 @@ Example: {occ-command-example-prefix} user:move-home lisa /mnt/newhome_1 ---- +NOTE: Run this command inside the ownCloud Docker container. + This command moves the home directory of user `lisa` to the new location `/mnt/newhome_1` == Generating a User Count Report @@ -530,6 +584,8 @@ and guest users which are created by the guests app. {occ-command-example-prefix} user:report ---- +NOTE: Run this command inside the ownCloud Docker container. + There are no arguments and no options beside the default once to parametrize the output. [source,bash,subs="attributes+"] @@ -549,6 +605,8 @@ There are no arguments and no options beside the default once to parametrize the +--------------------------+-----+ ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: A user directory is created, when a local user has logged on the first time after creation. Therefore the difference between `OC\User\Database` and `user directories` equals all users which have been created locally, but have not logged on at least once. == Setting a User's Password @@ -560,6 +618,8 @@ Resets the password of the named user. {occ-command-example-prefix} user:resetpassword [options] [--] ---- +NOTE: Run this command inside the ownCloud Docker container. + include::partial$configuration/user/update-password-note.adoc[] === Arguments @@ -615,6 +675,8 @@ You can reset any user's password, including administrators (see xref:configurat Successfully reset password for layla ---- +NOTE: Run this command inside the ownCloud Docker container. + You may also use `password-from-env` to reset passwords: [source,plaintext] @@ -638,6 +700,8 @@ Additionally, when the command completes, it outputs the password reset link to The password reset link is: http://localhost:{std-port-http}/index.php/lostpassword/reset/form/rQAlCjNeQf3aphA6Hraq2/layla ---- +NOTE: Run this command inside the ownCloud Docker container. + If the specified user does not have a valid email address set, then the following error will be output to the console, and the email will not be sent: [source,plaintext] @@ -659,6 +723,8 @@ To manage application settings for a user, use the `user:setting` command. This {occ-command-example-prefix} user:setting [options] [--] [[ []] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,40%",] @@ -725,6 +791,8 @@ To retrieve settings for a user, you need to call the `user:setting` command and {occ-command-example-prefix} user:setting [] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Arguments [width="100%",cols="20%,70%",] @@ -753,6 +821,9 @@ To retrieve settings for a user, you need to call the `user:setting` command and - settings: - email: layla@example.tld ---- + +NOTE: Run this command inside the ownCloud Docker container. + + Here we see that the user has settings for the application `core`, when they last logged in, and what their email address is. @@ -764,6 +835,9 @@ Here we see that the user has settings for the application `core`, when they las - core: - lang: en ---- + +NOTE: Run this command inside the ownCloud Docker container. + + In the output, you can see that one setting is in effect, `lang`, which is set to `en`. @@ -773,6 +847,9 @@ In the output, you can see that one setting is in effect, `lang`, which is set t ---- {occ-command-example-prefix} user:setting layla core lang ---- + +NOTE: Run this command inside the ownCloud Docker container. + + This will display the value for that setting, such as `en`. @@ -783,6 +860,8 @@ This will display the value for that setting, such as `en`. {occ-command-example-prefix} user:setting [options] [--] [] [] ---- +NOTE: Run this command inside the ownCloud Docker container. + IMPORTANT: In case you want to change the email address, use xref:modify-user-details[the `user:modify` command]. Here's an example of how you would set the language of the user `layla`. @@ -792,6 +871,8 @@ Here's an example of how you would set the language of the user `layla`. {occ-command-example-prefix} user:setting layla core lang --value=en ---- +NOTE: Run this command inside the ownCloud Docker container. + Deleting a setting is quite similar to setting a setting. In this case, you supply the username, application (or setting category) and key as above. Then, in addition, you supply the `--delete` flag. @@ -801,6 +882,8 @@ Then, in addition, you supply the `--delete` flag. {occ-command-example-prefix} user:setting layla core lang --delete ---- +NOTE: Run this command inside the ownCloud Docker container. + == Syncing User Accounts This command syncs users stored in external backend services, such as _LDAP_, _Shibboleth_, and _Samba_, with ownCloud's, internal user database. @@ -886,6 +969,8 @@ and _Shibboleth_ backend. {occ-command-example-prefix} user:sync "OCA\User_LDAP\User_Proxy" ---- +NOTE: Run this command inside the ownCloud Docker container. + === Samba [source,bash,subs="attributes+"] @@ -893,6 +978,8 @@ and _Shibboleth_ backend. {occ-command-example-prefix} user:sync "OCA\User\SMB" -vvv ---- +NOTE: Run this command inside the ownCloud Docker container. + Below are examples of how to use the command with the *LDAP* backend along with example console output. === Example 1 @@ -911,6 +998,8 @@ Below are examples of how to use the command with the *LDAP* backend along with 4 [============================] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example 2 [source,bash,subs="attributes+"] @@ -931,6 +1020,8 @@ Below are examples of how to use the command with the *LDAP* backend along with 1 [============================] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example 3 [source,bash,subs="attributes+"] @@ -952,6 +1043,8 @@ Below are examples of how to use the command with the *LDAP* backend along with 1 [============================] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example 4 [source,bash,subs="attributes+"] @@ -971,6 +1064,8 @@ Below are examples of how to use the command with the *LDAP* backend along with 4 [============================] ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example 5 [source,bash,subs="attributes+"] @@ -979,6 +1074,8 @@ Below are examples of how to use the command with the *LDAP* backend along with ---- +NOTE: Run this command inside the ownCloud Docker container. + === Example 6 [source,bash,subs="attributes+"] @@ -990,6 +1087,8 @@ If unknown users are found, what do you want to do with their accounts? (removin [2] ask later ---- +NOTE: Run this command inside the ownCloud Docker container. + === Syncing via cron job Here is an example for syncing with LDAP four times a day on Ubuntu: diff --git a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_versions_commands.adoc b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_versions_commands.adoc index 5857d89a0..51d1ed1b8 100644 --- a/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_versions_commands.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_commands/core_commands/_versions_commands.adoc @@ -12,6 +12,8 @@ These commands are not available in xref:maintenance-commands[single-user (maint {occ-command-example-prefix} versions:cleanup []... ---- +NOTE: Run this command inside the ownCloud Docker container. + Options [width="100%",cols="22%,70%",] @@ -33,6 +35,8 @@ Delete versions for users on backend Database edward ---- +NOTE: Run this command inside the ownCloud Docker container. + You can delete versions for specific users in a space-delimited list: [source,bash,subs="attributes+"] @@ -42,6 +46,8 @@ Delete versions of freda Delete versions of molly ---- +NOTE: Run this command inside the ownCloud Docker container. + == versions:expire `versions:expire` deletes only expired files according to the `versions_retention_obligation` setting in `config.php` (see the File versions section in config_sample_php_parameters). @@ -52,6 +58,8 @@ The default is to delete expired files for all users, or you may list users in a {occ-command-example-prefix} versions:expire []... ---- +NOTE: Run this command inside the ownCloud Docker container. + Options [width="100%",cols="22%,70%",] diff --git a/modules/admin_manual/pages/configuration/server/security/hsmdaemon/index.adoc b/modules/admin_manual/pages/configuration/server/security/hsmdaemon/index.adoc index 62313235a..c6c5d7c2d 100644 --- a/modules/admin_manual/pages/configuration/server/security/hsmdaemon/index.adoc +++ b/modules/admin_manual/pages/configuration/server/security/hsmdaemon/index.adoc @@ -405,6 +405,8 @@ ep6Y1aAVAYpAesZ1+sQzzUepjO82o34kjmm63Drmz+6KED4oIBARQkXeW/OoxgUg6kQhQK1thA/3Ww33 decrypted string (base64 encoded): 'SGVsbG8sIHdvcmxkIQo=' ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,bash] ---- sudo tail -5 /var/log/hsm.log @@ -500,6 +502,8 @@ Set the generated secret for ownCloud: {occ-command-example-prefix} config:app:set encryption hsm.jwt.secret --value '7a7d1826-b514-4d9f-afc7-a7485084e8de' ---- +NOTE: Run this command inside the ownCloud Docker container. + If the command succeeds, you should see the following console output: [source,plaintext] @@ -518,6 +522,8 @@ Enable the HSM mode and enable encryption by running the commands in the followi {occ-command-example-prefix} encryption:enable ---- +NOTE: Run this command inside the ownCloud Docker container. + If the commands are successful, you should see the following console output: [source,plaintext] diff --git a/modules/admin_manual/pages/configuration/server/security_setup_warnings.adoc b/modules/admin_manual/pages/configuration/server/security_setup_warnings.adoc index 682301697..4a842ba14 100644 --- a/modules/admin_manual/pages/configuration/server/security_setup_warnings.adoc +++ b/modules/admin_manual/pages/configuration/server/security_setup_warnings.adoc @@ -65,7 +65,7 @@ The following pages describe how to enable HTTPS on the Apache webserver. == The test with getenv("PATH") only returns an empty response Some environments are not passing a valid PATH variable to ownCloud. -The xref:installation/configuration_notes_and_tips.adoc#php-fpm[PHP FPM tips] provides the information about how to configure your environment. +For Docker-based installations, ensure that the PATH variable is correctly set in the container environment via your Docker Compose configuration. == The "Strict-Transport-Security" HTTP header is not configured diff --git a/modules/admin_manual/pages/configuration/server/ui-configuration.adoc b/modules/admin_manual/pages/configuration/server/ui-configuration.adoc index 35747c805..1c5965b4d 100644 --- a/modules/admin_manual/pages/configuration/server/ui-configuration.adoc +++ b/modules/admin_manual/pages/configuration/server/ui-configuration.adoc @@ -22,6 +22,8 @@ This progress bar can be hidden with the following command: {occ-command-example-prefix} config:app:set files hide_upload_estimation --value="yes" ---- +NOTE: Run this command inside the ownCloud Docker container. + To show the progress bar again, type one of the following commands: [source,bash,subs="attributes+"] @@ -29,6 +31,8 @@ To show the progress bar again, type one of the following commands: {occ-command-example-prefix} config:app:set files hide_upload_estimation --value="no" ---- +NOTE: Run this command inside the ownCloud Docker container. + or [source,bash,subs="attributes+"] @@ -36,5 +40,7 @@ or {occ-command-example-prefix} config:app:delete files hide_upload_estimation ---- +NOTE: Run this command inside the ownCloud Docker container. + The current value can be queried with the `config:app:get` or the `config:list` command. For details see the xref:configuration/server/occ_command.adoc#config-commands[occ Config Commands] diff --git a/modules/admin_manual/pages/configuration/server/virus-scanner-support.adoc b/modules/admin_manual/pages/configuration/server/virus-scanner-support.adoc index 1b8622a1f..9ba9dd219 100644 --- a/modules/admin_manual/pages/configuration/server/virus-scanner-support.adoc +++ b/modules/admin_manual/pages/configuration/server/virus-scanner-support.adoc @@ -69,12 +69,16 @@ image::configuration/server/virus-scanner-support/antivirus-app.png[Anti-Virus A {occ-command-example-prefix} market:install files_antivirus ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ and enable it with the following occ command: + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} app:enable files_antivirus ---- ++ +NOTE: Run this command inside the ownCloud Docker container. == Ways of Configuration @@ -92,6 +96,8 @@ All of the configuration settings for the Anti-Virus app are configurable by pas av_socket --value="/var/run/clamav/clamd.ctl" ---- +NOTE: Run this command inside the ownCloud Docker container. + To get a current option, run for example: [source,bash,subs="attributes+"] @@ -100,6 +106,8 @@ To get a current option, run for example: av_socket ---- +NOTE: Run this command inside the ownCloud Docker container. + [caption=] .Available configuration settings, availability is _av_mode_ dependent [cols="23%,45%,15%",options="header"] @@ -301,6 +309,8 @@ In both daemon modes, background scans are enabled by default. If you want to di ---- {occ-command-example-prefix} config:app:set files_antivirus av_scan_background --value 'false' ---- + +NOTE: Run this command inside the ownCloud Docker container. ==== [[daemon-socket-same-server]] @@ -418,6 +428,8 @@ Use the following occ commands to set configurations based on your environment: {occ-command-example-prefix} config:app:set files_antivirus \ av_host --value="172.17.0.3" ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Specify the port of the anti-virus server: + @@ -426,6 +438,8 @@ Use the following occ commands to set configurations based on your environment: {occ-command-example-prefix} config:app:set files_antivirus \ av_port --value="1344" ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Enable background scans: + @@ -434,6 +448,8 @@ Use the following occ commands to set configurations based on your environment: {occ-command-example-prefix} config:app:set files_antivirus \ av_scan_background --value="true" ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Specify what to do with the offending file: + @@ -443,6 +459,8 @@ Use the following occ commands to set configurations based on your environment: av_infected_action --value="delete" ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ Possible values are `delete` and `only_log`. + Note that this setting is only used when `av_scan_background` is set to `true`. @@ -458,6 +476,8 @@ The following settings are just examples and must be adjusted for the scanner yo {occ-command-example-prefix} config:app:set files_antivirus \ av_mode --value="icap" ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Set the request service: + @@ -466,6 +486,8 @@ The following settings are just examples and must be adjusted for the scanner yo {occ-command-example-prefix} config:app:set files_antivirus \ av_request_service --value="avscan" ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Set the response header: + @@ -474,6 +496,8 @@ The following settings are just examples and must be adjusted for the scanner yo {occ-command-example-prefix} config:app:set files_antivirus \ av_response_header --value="X-Infection-Found" ---- ++ +NOTE: Run this command inside the ownCloud Docker container. === ClamAV & Kaspersky (ICAP) diff --git a/modules/admin_manual/pages/configuration/user/oidc/oidc.adoc b/modules/admin_manual/pages/configuration/user/oidc/oidc.adoc index e5f55cee9..6174416ab 100644 --- a/modules/admin_manual/pages/configuration/user/oidc/oidc.adoc +++ b/modules/admin_manual/pages/configuration/user/oidc/oidc.adoc @@ -92,6 +92,8 @@ If a malformed JSON string is found, an error is logged. The _key->value_ pairs --value='{"provider-url":"https:\/\/idp.example.net","client-id":"fc9b5c78-ec73-47bf-befc-59d4fe780f6f","client-secret":"e3e5b04a-3c3c-4f4d-b16c-2a6e9fdd3cd1","loginButtonName":"Login via OpenId Connect"}' ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: Only set either the database or the config.php keys but not both for the OpenID Connect app. == Set Up Service Discovery diff --git a/modules/admin_manual/pages/configuration/user/reset_admin_password.adoc b/modules/admin_manual/pages/configuration/user/reset_admin_password.adoc index 0578507d0..9b1b8e995 100644 --- a/modules/admin_manual/pages/configuration/user/reset_admin_password.adoc +++ b/modules/admin_manual/pages/configuration/user/reset_admin_password.adoc @@ -22,6 +22,8 @@ Confirm the new password: Successfully reset password for admin ---- +NOTE: Run this command inside the ownCloud Docker container. + If your ownCloud username is not `admin`, then substitute your ownCloud username. diff --git a/modules/admin_manual/pages/configuration/user/user_auth_ftp_smb_imap.adoc b/modules/admin_manual/pages/configuration/user/user_auth_ftp_smb_imap.adoc index 1eff9f48e..e0b8680ba 100644 --- a/modules/admin_manual/pages/configuration/user/user_auth_ftp_smb_imap.adoc +++ b/modules/admin_manual/pages/configuration/user/user_auth_ftp_smb_imap.adoc @@ -21,9 +21,7 @@ file (`config/config.php`) using the following syntax: ], ---- -NOTE: A non-blocking or correctly configured SELinux setup is needed for these backends to work, -if SELinux is enabled on your server. Please refer to the -xref:installation/selinux_configuration.adoc[SELinux configuration] for further details. +NOTE: A non-blocking or correctly configured SELinux setup is needed for these backends to work if SELinux is enabled on your server. Currently the https://github.com/owncloud/user_external[External user support app] (user_external), _which is not enabled by default_, provides three backends. These are: diff --git a/modules/admin_manual/pages/configuration/user/user_auth_ldap.adoc b/modules/admin_manual/pages/configuration/user/user_auth_ldap.adoc index a196d9b2e..5582dee81 100644 --- a/modules/admin_manual/pages/configuration/user/user_auth_ldap.adoc +++ b/modules/admin_manual/pages/configuration/user/user_auth_ldap.adoc @@ -316,6 +316,8 @@ Disallowing login with LDAP Email Address requires enabling strict login checkin ---- {occ-command-example-prefix} config:system:set --type boolean --value true strict_login_enforced ---- + +NOTE: Run this command inside the ownCloud Docker container. ==== Other Attributes:: @@ -620,6 +622,8 @@ Since ownCloud 8.0.10 and up the home folder rule is enforced. This means that o {occ-command-example-prefix} config:app:set user_ldap enforce_home_folder_naming_rule --value=1 ---- +NOTE: Run this command inside the ownCloud Docker container. + Starting with ownCloud 10.0, the home folder naming rule is only applied when first provisioning the user. This prevents data loss due to re-provisioning the users home folder in case of unintentional changes in LDAP. -- @@ -731,6 +735,8 @@ To enable this functionality, the `reuse_accounts` config setting must be set to {occ-command-example-prefix} config:app:set user_ldap reuse_accounts --value=yes .... +NOTE: Run this command inside the ownCloud Docker container. + === ownCloud Avatar Integration ownCloud supports user profile pictures, which are also called avatars. If a user has a photo stored in the `jpegPhoto` or `thumbnailPhoto` attribute on your LDAP server, it will be used as their avatar. In this case the user cannot alter their avatar (on their Personal page) as it must be changed in LDAP. `jpegPhoto` is preferred over `thumbnailPhoto`. diff --git a/modules/admin_manual/pages/configuration/user/user_management.adoc b/modules/admin_manual/pages/configuration/user/user_management.adoc index 006bddb66..fb12f4a03 100644 --- a/modules/admin_manual/pages/configuration/user/user_management.adoc +++ b/modules/admin_manual/pages/configuration/user/user_management.adoc @@ -188,6 +188,8 @@ For details of the occ user commands used below, see the xref:configuration/serv - lisa: /var/www/owncloud/data/lisa ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ Here you can see, that the home of user `lisa` is located in `/var/www/owncloud/data/lisa` . Prepare new mounts *in advance* for one or more users: @@ -207,6 +209,8 @@ Use the OS methods to create one or more new mount points for users home directo {occ-command-example-prefix} user:move-home lisa /mnt/newhome_1 ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ The user gets disconnected and the user's home is now moved which may take a while depending on the load of the server and the bandwidth available on the mount points. When the move operation has finished, + -- @@ -227,6 +231,8 @@ NOTE: If you are using LDAP and the xref:enterprise/external_storage/ldap_home_c - lisa: /mnt/newhome_1/lisa ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ Here you can see that the home of user `lisa` is now located in `/mnt/newhome_1/lisa`. . To list the available user home root directories, use the following command: @@ -239,6 +245,8 @@ The following command lists all available user homes. Note a home only gets list - /var/www/owncloud/data - /mnt/newhome_1/lisa ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . To list all users from a users home root directory, use the following command: + @@ -250,3 +258,5 @@ The following command lists all users from a given home. - admin - user01 ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/enterprise/authentication/kerberos.adoc b/modules/admin_manual/pages/enterprise/authentication/kerberos.adoc index af192ba3c..266640e01 100644 --- a/modules/admin_manual/pages/enterprise/authentication/kerberos.adoc +++ b/modules/admin_manual/pages/enterprise/authentication/kerberos.adoc @@ -215,6 +215,8 @@ This option can also be used if you have only one web site but want to keep the {occ-command-example-prefix} app:enable kerberos ---- +NOTE: Run this command inside the ownCloud Docker container. + === Domain Controller Side ==== Service Principal Name (SPN) diff --git a/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc b/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc index 7a61be2d2..48c029f59 100644 --- a/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc +++ b/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc @@ -330,6 +330,8 @@ The simplest way, useful for initial testing is, to start the `wnd:listen` proce {occ-command-example-prefix} wnd:listen ---- +NOTE: Run this command inside the ownCloud Docker container. + The password is an optional parameter and you will be asked for it if you didn't provide it as in the example above. If necessary, the workgroup can be set together with the username as well. Use following syntax and set quotes, which is important to keep the backslash `'\'`. The whole example command looks like: [source,bash,subs="attributes+"] @@ -337,6 +339,8 @@ The password is an optional parameter and you will be asked for it if you didn't {occ-command-example-prefix} wnd:listen '\' ---- +NOTE: Run this command inside the ownCloud Docker container. + In order to start `wnd:listen` without any user interaction like as service, provide the password from a password file. [source,bash,subs="attributes+"] @@ -346,6 +350,8 @@ In order to start `wnd:listen` without any user interaction like as service, pro --password-trim ---- +NOTE: Run this command inside the ownCloud Docker container. + For additional options to provide the password, check xref:password-options[Password Options]. Note that the password must be in plain text inside the file. Neither spaces nor newline characters will be removed from the contents of the file by default, unless the `--password-trim` option is added. The password file must be readable by the apache user (or www-data). Also make sure that the password file is outside of any directory handled by apache (web-readable) for security reasons. You may use the same location when using flock in xref:execution-serialization[Execution Serialization] below. @@ -363,6 +369,8 @@ As a simple example, you can check the following: {occ-command-example-prefix} wnd:process-queue ---- +NOTE: Run this command inside the ownCloud Docker container. + You can run that command, even if there are no notifications to be processed. Depending on your requirements, you can wrap that command in a Cron job so it's run every 5 minutes for example. @@ -478,6 +486,8 @@ If you need to serialize the execution of the `wnd:process-queue`, check the fol flock -n /opt/my-lock-file {occ-command-example-prefix} wnd:process-queue ---- +NOTE: Run this command inside the ownCloud Docker container. + In that case, flock will try to get the lock of that file and won't run the command if it isn't possible. For our case, and considering that file isn't being used by any other process, it will run only one `wnd:process-queue` at a time. If someone tries to run the same command a second time while the previous one is running, the second will fail and won't be executed. The lock file `/opt/my-lock-file` itself will be created as an empty file by the `flock` command if it does not yet exist, but after it has been created the lock file doesn't change. Only an flock will be applied and removed. The file won't be removed after the script completes. @@ -489,6 +499,8 @@ You can use flock also in cron, see the example below: * * * * * flock -n /opt/my-lock-file -c 'sudo -u www-data /var/www/owncloud/occ wnd:process-queue ' ---- +NOTE: Run this command inside the ownCloud Docker container. + Check {flock-docs-url}[flock's documentation] for details and more options. === Activity Extension @@ -610,6 +622,8 @@ Take the example of attempting to connect to the host MyHost, the share named `M {occ-command-example-prefix} wnd:listen MyHost MyData user password ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: The command is case-sensitive, and that it must match the information from the mount point configuration. === Kerberos Testing @@ -719,12 +733,18 @@ There are several ways to supply a password: ---- {occ-command-example-prefix} wnd:listen ---- ++ +NOTE: Run this command inside the ownCloud Docker container. + . Sent as a parameter to the command. + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} wnd:listen ---- ++ +NOTE: Run this command inside the ownCloud Docker container. + . Read from a file, using the `--password-file` switch to specify the file to read from. Note, that the password must be in plain text inside the file, and neither spaces nor newline characters will be removed from the file by default, unless the `--password-trim` option is added. The password file must be readable by the apache user (or www-data) + [source,bash,subs="attributes+"] @@ -733,6 +753,8 @@ There are several ways to supply a password: --password-file=/my/secret/password/file ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} wnd:listen \ @@ -740,6 +762,8 @@ There are several ways to supply a password: --password-trim ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ NOTE: If you use the `--password-file` switch, the entire contents of the file will be used for the password, so please be careful with newlines. + IMPORTANT: If using `--password-file` make sure that the file is only readable by the apache / www-data user and inaccessible from the web. This prevents tampering or leaking of the information. The password won't be leaked to any other user using `ps`. @@ -752,6 +776,8 @@ IMPORTANT: If using `--password-file` make sure that the file is only readable b --password-from-service-account ---- + +NOTE: Run this command inside the ownCloud Docker container. ++ IMPORTANT: You need to ensure that the triple of ``, `` and `` (including any kind of workgroup if used) matches the configuration made for the WND collaborative share. The command will fail otherwise. === Reduce WND Notifier Memory Usage @@ -778,6 +804,8 @@ This provides a bit more security because the `/tmp/plainpass` password as shown cat /tmp/plainpass | {occ-command-example-prefix} wnd:listen --password-file=- ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== base64 Similar to plainpass, the content in this case gets encoded in the {base64-url}[Base64 format]. There's not much security, but it has additional obfuscation. @@ -788,6 +816,8 @@ base64 -d /tmp/encodedpass | \ {occ-command-example-prefix} wnd:listen --password-file=- ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== pass Example using "pass" @@ -799,6 +829,8 @@ Example using "pass" pass the-password-name | {occ-command-example-prefix} wnd:listen --password-file=- ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== HashiCorp Vault This example uses {vaultproject-url}[Vault] as the secrets store. See {hashicorp-url}[HCP Vault] on how to setup the secrets store. Then use something like the following: @@ -808,6 +840,8 @@ This example uses {vaultproject-url}[Vault] as the secrets store. See {hashicorp vault kv get -field=password secret/samba | {occ-command-example-prefix} wnd:listen --password-file=- ---- +NOTE: Run this command inside the ownCloud Docker container. + Use Vault's ACLs to limit access to the token. Destroy the token after starting the service during boot with systemd. === Password Option Precedence @@ -817,6 +851,9 @@ If both the argument and the option are passed, e.g., ---- {occ-command-example-prefix} wnd:listen --password-file=/opt/pass` ---- + +NOTE: Run this command inside the ownCloud Docker container. + then the `--password-file` option will take precedence. === Optimizing wnd:process-queue @@ -911,6 +948,8 @@ Setups with several servers might have some difficulties in some scenarios: --serializer-param file=/opt/oc/store2 ---- +NOTE: Run this command inside the ownCloud Docker container. + To set it up, make sure the listener is running as a system service: [source,bash,subs="attributes+"] @@ -918,6 +957,8 @@ To set it up, make sure the listener is running as a system service: {occ-command-example-prefix} wnd:listen host share username password ---- +NOTE: Run this command inside the ownCloud Docker container. + Setup a Cron job or similar with something like the following two commands: [source,bash,subs="attributes+"] @@ -929,6 +970,8 @@ Setup a Cron job or similar with something like the following two commands: sudo rm -f /opt/oc/store1 # With a different schedule ---- +NOTE: Run this command inside the ownCloud Docker container. + The first run will create the `/opt/oc/store1` with the serialized storages, the rest of the executions will use that file. The second Cron job, the one removing the file, will force the `wnd:process-queue` to refresh the data. diff --git a/modules/admin_manual/pages/enterprise/external_storage/wnd_quick_guide.adoc b/modules/admin_manual/pages/enterprise/external_storage/wnd_quick_guide.adoc index 33463265d..91feebd93 100644 --- a/modules/admin_manual/pages/enterprise/external_storage/wnd_quick_guide.adoc +++ b/modules/admin_manual/pages/enterprise/external_storage/wnd_quick_guide.adoc @@ -26,11 +26,15 @@ Command line:: {occ-command-example-prefix} market:install windows_network_drive ---- +NOTE: Run this command inside the ownCloud Docker container. + [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} app:enable windows_network_drive ---- +NOTE: Run this command inside the ownCloud Docker container. + == Configuration **WebUI** @@ -181,6 +185,8 @@ Running the following command would work: {occ-command-example-prefix} wnd:listen MyHost MyData svc_owncloud password ---- +NOTE: Run this command inside the ownCloud Docker container. + The command is case-sensitive, and it must match the information from the mount point configuration. * When the output of the `occ process-queue ..` command shows `0 Storages found`, then this means, diff --git a/modules/admin_manual/pages/enterprise/file_management/files_lifecycle.adoc b/modules/admin_manual/pages/enterprise/file_management/files_lifecycle.adoc index aad06616c..08a3d2eea 100644 --- a/modules/admin_manual/pages/enterprise/file_management/files_lifecycle.adoc +++ b/modules/admin_manual/pages/enterprise/file_management/files_lifecycle.adoc @@ -56,6 +56,8 @@ Example to set missing upload time values to November, 1st 2019: {occ-command-example-prefix} lifecycle:set-upload-time 2019-11-01 ---- +NOTE: Run this command inside the ownCloud Docker container. + TIP: The extension only considers files. Folder structures are kept available. === Policy Configuration @@ -77,12 +79,16 @@ Example to set the time passed since upload (or restore) for archiving files to {occ-command-example-prefix} config:app:set files_lifecycle archive_period --value='90' ---- +NOTE: Run this command inside the ownCloud Docker container. + To query existing values, use this example command: [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} config:app:get files_lifecycle archive_period ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== Restoration Policies for Users ===== Soft Policy @@ -95,6 +101,8 @@ The _soft policy_ is used by default. To switch from the hard policy to the soft {occ-command-example-prefix} config:app:set files_lifecycle policy --value='soft' ---- +NOTE: Run this command inside the ownCloud Docker container. + ===== Hard Policy The _hard policy_ is designed to enforce strict controls on user data, forcing archiving after the defined time and requiring escalated permissions in order to restore. If the archived data is still needed, users need to get in contact with a privileged manager and request the restoration. @@ -108,6 +116,8 @@ To put the _hard policy_ in place, use this _occ_ command: {occ-command-example-prefix} config:app:set files_lifecycle policy --value='hard' ---- +NOTE: Run this command inside the ownCloud Docker container. + === Archive and Expiration Background Jobs To put File Lifecycle Management into actual operation, there are two _occ_ commands for archiving files and for permanently deleting them from the archive. Scanning the database for files that are due for archiving or expiration, given the chosen policies, can take some time. For this reason, these jobs are delegated to specific _occ_ commands which should be executed using CRON on a daily schedule. @@ -120,6 +130,8 @@ To move files scheduled for archiving (days since upload/restore > `archive_time {occ-command-example-prefix} lifecycle:archive ---- +NOTE: Run this command inside the ownCloud Docker container. + TIP: There is a dry-run mode (append `-d`) that simulates the execution of this command to allow checking the configuration before putting the actual process in place. ==== Archive Expiration Background Job @@ -130,6 +142,8 @@ To permanently delete files from the archive that have met the policy rules (day {occ-command-example-prefix} lifecycle:expire ---- +NOTE: Run this command inside the ownCloud Docker container. + TIP: There is a dry-run mode (append `-d`) that simulates the execution of this command to allow checking the configuration before putting the actual process in place. === Restoring Files @@ -148,6 +162,8 @@ When a user `alice` requests to restore all files, e.g., in the folder `/work/pr {occ-command-example-prefix} lifecycle:restore /alice/archive/files/work/projects/project1 ---- +NOTE: Run this command inside the ownCloud Docker container. + ==== Restoring All Files from All Archives File Lifecycle Management provides a way to restore all files from all archives back to their owners' file directories. To do this, system administrators can use the `restore-all` _occ_ command: @@ -156,6 +172,8 @@ File Lifecycle Management provides a way to restore all files from all archives {occ-command-example-prefix} lifecycle:restore-all ---- +NOTE: Run this command inside the ownCloud Docker container. + The command will restore all files from all users and report on the progress. TIP: There is a dry-run mode (append `-d`) that simulates the execution of this command to allow checking the configuration before putting the actual process in place. @@ -169,6 +187,8 @@ In some scenarios it can be desired to disable the whole user interface for this {occ-command-example-prefix} config:app:set files_lifecycle disable_ui --value='yes' ---- +NOTE: Run this command inside the ownCloud Docker container. + To enable the user interface components again, this config value needs to be removed: [source,bash,subs="attributes+"] @@ -176,6 +196,8 @@ To enable the user interface components again, this config value needs to be rem {occ-command-example-prefix} config:app:delete files_lifecycle disable_ui ---- +NOTE: Run this command inside the ownCloud Docker container. + == Audit Events During archiving, restoring and expiration, Audit events are emitted. Logging those to the `audit.log` requires the minimum version 2.0.0 of the {oc-marketplace-url}/apps/admin_audit[Auditing] app. diff --git a/modules/admin_manual/pages/enterprise/logging/admin_audit.adoc b/modules/admin_manual/pages/enterprise/logging/admin_audit.adoc index 683b2a3dd..0edcb33db 100644 --- a/modules/admin_manual/pages/enterprise/logging/admin_audit.adoc +++ b/modules/admin_manual/pages/enterprise/logging/admin_audit.adoc @@ -53,6 +53,8 @@ To ignore all CLI triggered events (default is to include them), set the followi {occ-command-example-prefix} config:app:set admin_audit ignore_cli_events --value='yes' ---- +NOTE: Run this command inside the ownCloud Docker container. + == Grouped Logging With each log message, a number of users are calculated to be the 'audit context'. This is the list of users which are related to the log message. Additionally, each log message includes a list of groups that the users are a member of, to enable filtering / splitting of the log messages at a later date. In cases when users are members of many groups, to reduce the data output, the group list can be filtered by adding the following to your `config.php`. Change the groups needed accordingly: diff --git a/modules/admin_manual/pages/enterprise/reporting/metrics.adoc b/modules/admin_manual/pages/enterprise/reporting/metrics.adoc index 1b4c07389..4297b39ab 100644 --- a/modules/admin_manual/pages/enterprise/reporting/metrics.adoc +++ b/modules/admin_manual/pages/enterprise/reporting/metrics.adoc @@ -92,6 +92,8 @@ See the following occ command on how to set it. Make up a passphrase, referred t {occ-command-example-prefix} config:system:set "metrics_shared_secret" --value "" ---- +NOTE: Run this command inside the ownCloud Docker container. + TIP: This token gets stored in config.php as `metrics_shared_secret`, which could also be done manually instead of using the occ command. @@ -104,6 +106,8 @@ The dashboard is enabled by default. You can disable it with the following comma {occ-command-example-prefix} config:app:set metrics disable_dashboard --value=yes ---- +NOTE: Run this command inside the ownCloud Docker container. + === Endpoints and Parameters ==== Metrics Endpoint diff --git a/modules/admin_manual/pages/enterprise/user_management/saml_2.0_sso.adoc b/modules/admin_manual/pages/enterprise/user_management/saml_2.0_sso.adoc index 949679448..984367dfd 100644 --- a/modules/admin_manual/pages/enterprise/user_management/saml_2.0_sso.adoc +++ b/modules/admin_manual/pages/enterprise/user_management/saml_2.0_sso.adoc @@ -152,6 +152,8 @@ Use `upn` as `uid` and set the app mode to 'SSO Only' by running: {occ-command-example-prefix} shibboleth:mapping -u upn ---- +NOTE: Run this command inside the ownCloud Docker container. + `displayName` and email are only relevant for `autoprovisioning` mode. Add Claims in ADFS and map them in the `attribute-map.xml` if needed. diff --git a/modules/admin_manual/pages/enterprise/user_management/user_auth_shibboleth.adoc b/modules/admin_manual/pages/enterprise/user_management/user_auth_shibboleth.adoc index 892234c1c..3a7d03932 100644 --- a/modules/admin_manual/pages/enterprise/user_management/user_auth_shibboleth.adoc +++ b/modules/admin_manual/pages/enterprise/user_management/user_auth_shibboleth.adoc @@ -54,6 +54,8 @@ You can also change the app mode and environment mappings by using the `occ` com {occ-command-example-prefix} shibboleth:mapping --uid login ---- +NOTE: Run this command inside the ownCloud Docker container. + In *Single sign-on only* mode the app checks if the environment variable for the Shibboleth session, by default *Shib-Session-Id*, is set. If that is the case it will take the value of the environment variable as the `uid`, by default `eppn`, and check if a user is known by that `uid`. In effect, this allows another user backend, e.g., the LDAP app, to provide the `displayname`, `email` and `avatar`. @@ -88,6 +90,8 @@ From 3.1.2 you can now specify a mapper that is used on inbound ownCloud user ID uid_mapper --value="OCA\User_Shibboleth\Mapper\ADFSMapper" ---- +NOTE: Run this command inside the ownCloud Docker container. + You may view the currently configured mapper using: [source,bash,subs="attributes+"] @@ -95,6 +99,8 @@ You may view the currently configured mapper using: {occ-command-example-prefix} shibboleth:mapping ---- +NOTE: Run this command inside the ownCloud Docker container. + The following mappers are provided with the app: [cols="2",options="header"] diff --git a/modules/admin_manual/pages/installation/deployment_considerations.adoc b/modules/admin_manual/pages/installation/deployment_considerations.adoc index e07d1df64..a2daa7acd 100644 --- a/modules/admin_manual/pages/installation/deployment_considerations.adoc +++ b/modules/admin_manual/pages/installation/deployment_considerations.adoc @@ -64,22 +64,9 @@ deadlocks with high-level file locking. == Software -=== Operating System - -We are dependent on distributions that offer an easy way to install the -various components in up-to-date versions. ownCloud has a partnership -with RedHat and SUSE for customers who need commercial support. -Canonical, the parent company of Ubuntu Linux, also offers enterprise -service and support. Debian and Ubuntu are free of cost, and include -newer software packages. CentOS is the community-supported free-of-cost -Red Hat Enterprise Linux clone. openSUSE is community-supported, and -includes many of the same system administration tools as SUSE Linux -Enterprise Server. - -=== Web server - -Apache with mod_php is currently the best option. -Mod_php is recommended instead of PHP_FPM, because in scale-out deployments separate PHP pools are not necessary. +=== Docker Host + +ownCloud Server 11 runs exclusively in Docker containers. The host operating system only needs to provide Docker Engine and Docker Compose. The web server, PHP runtime, and application dependencies are all encapsulated within the ownCloud Docker images. === Relational Database diff --git a/modules/admin_manual/pages/installation/deployment_recommendations.adoc b/modules/admin_manual/pages/installation/deployment_recommendations.adoc index 1eaf1e85e..1346be976 100644 --- a/modules/admin_manual/pages/installation/deployment_recommendations.adoc +++ b/modules/admin_manual/pages/installation/deployment_recommendations.adoc @@ -44,11 +44,9 @@ This is because every ownCloud customer has their own particular needs and IT in The recommendations presented here are based on a standard ownCloud installation, one without any particular _apps_, _themes_, or _code changes_. But, server load is dependent upon the number of _clients_, _files_, and _user activity_, as well as other usage patterns. Therefore, these recommendations are only rules of thumb based on our experience and customer feedback. ==== -* Operating system: Linux. -* Web server: Apache 2.4. +* Docker Engine and Docker Compose on the host. See xref:installation/system_requirements.adoc[System Requirements]. * Database: MySQL/MariaDB with InnoDB storage engine (MyISAM is not supported, see: xref:configuration/database/linux_database_configuration.adoc#mysql-mariadb[MySQL / MariaDB storage engine]) -* And a recent PHP Version. See xref:installation/system_requirements.adoc[System Requirements] * Consider setting up a scale-out deployment, or using xref:classic_ui:files/federated_cloud_sharing.adoc[Federated Cloud Sharing] to keep individual ownCloud instances to a manageable size. NOTE: Whatever the size of your organization, always keep one thing in mind: + @@ -102,13 +100,13 @@ image:installation/deprecs-1.png[Network diagram for small enterprises.] One server with at least 2 CPU cores, 16GB RAM, and local storage as needed. -==== Operating system +==== Docker Host Operating System -Enterprise-grade Linux distribution with full support from an operating system vendor. We recommend Ubuntu 20.04, RedHat Enterprise Linux and SUSE Linux Enterprise Server 12+. +Any 64-bit Linux distribution capable of running Docker Engine 20.10 or later is supported. ==== SSL Configuration -The SSL termination is done in Apache. A standard SSL certificate is required to be installed. See the {apache-ssl-howto-url}[official Apache documentation] or our xref:installation/letsencrypt/index.adoc[Let's Encrypt SSL Certificates] documentation. +SSL termination is handled by a reverse proxy in front of the Docker deployment. A standard SSL certificate is required. ==== Load Balancer @@ -194,13 +192,13 @@ image:installation/deprecs-2.png[Network diagram for a mid-sized enterprise.] * 1 {haproxy-and-load-balancing-url}[HAproxy load balancer] with two sockets and 16GB RAM. * NFS storage server as needed. -==== Operating System +==== Docker Host Operating System -Enterprise grade Linux distribution with full support from an operating system vendor. We recommend both RedHat Enterprise Linux and SUSE Linux Enterprise Server 12+. +Any 64-bit Linux distribution capable of running Docker Engine 20.10 or later is supported on each application server node. ==== SSL Configuration -The SSL termination is done in the {haproxy-load-balancer-url}[HAProxy load balancer]. A standard SSL certificate is needed, installed according to the {haproxy-documentation-url}[HAProxy documentation]. +SSL termination is done in the {haproxy-load-balancer-url}[HAProxy load balancer]. A standard SSL certificate is needed, installed according to the {haproxy-documentation-url}[HAProxy documentation]. ==== Load Balancer @@ -282,9 +280,9 @@ image:installation/deprecs-3.png[image] 2 Hardware load balancer, for example, {bigip-f5-url}[BIG IP from F5]. * NFS storage server as needed. -==== Operating system +==== Docker Host Operating System -RHEL 7+ with latest service packs. +Any 64-bit Linux distribution capable of running Docker Engine 20.10 or later is supported on each application server node. ==== SSL Configuration @@ -371,18 +369,3 @@ NOTE: This setting is disabled by default. See the {galera-cluster-wsrep-docs-ur * {db-high-availability-url}[Database High Availability] * {bitnami-perf-enhancements-url}[Performance enhancements for Apache and PHP] -== Local Session Management - -Local session management on the application server. PHP sessions are stored in a temporary filesystem, mounted at the operating system-specific session storage location. You can find out where that is by running - -[source,bash] ----- -grep -R 'session.save_path' /etc/php* ----- - -and then add it to the `/etc/fstab` file, for example: - -[source,bash,subs="attributes+"] ----- -include::example$installation/deployment_recommendations/set_session_path.sh[] ----- diff --git a/modules/admin_manual/pages/installation/docker/index.adoc b/modules/admin_manual/pages/installation/docker/index.adoc index ad5fe3642..13a44130b 100644 --- a/modules/admin_manual/pages/installation/docker/index.adoc +++ b/modules/admin_manual/pages/installation/docker/index.adoc @@ -2,7 +2,6 @@ :toc: right :dockerhub-url: https://hub.docker.com/r/owncloud/server :docker-compose-url: https://docs.docker.com/compose/ -:linux-server-doc-url: https://docs.linuxserver.io/faq :docker-compose-build-url: https://docs.docker.com/compose/compose-file/build/ :description: ownCloud can be installed using the official ownCloud Docker image. @@ -396,33 +395,6 @@ The loglevel is set to the fixed value 2: _"Warnings, errors, and fatal issues"_ OWNCLOUD_LOGLEVEL=0 ---- -=== Raspberry Pi - -If your container fails to start on Raspberry Pi or other ARM devices, you most likely have an old version of `libseccomp2` on your host. This should only affect distros based on Rasbian Buster 32 bit. Install a newer version with the following command: - -[source,bash] ----- -cd /tmp -wget http://ftp.us.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.1-1_armhf.deb -sudo dpkg -i libseccomp2_2.5.1-1_armhf.deb ----- - -Alternatively you can add the backports repo for Debian Buster: - -[source,bash] ----- -sudo apt-key adv --keyserver keyserver.ubuntu.com \ - --recv-keys 04EE7237B7D453EC 648ACFD622F3D138 -echo "deb http://deb.debian.org/debian buster-backports main" | \ - sudo tee -a /etc/apt/sources.list.d/buster-backports.list -sudo apt update -sudo apt install -t buster-backports libseccomp2 ----- - -In any case, you should restart the container after confirming you have `libseccomp2.4.4` installed. - -For more information see: {linux-server-doc-url}[Linux Server Docs] - === Terminating containers If your container is terminating for whatever reason, you will not be able to run `docker(-compose) exec` to make investigations inside the container as there will be no running container. Instead you need to use `docker(-compose) run`. It's important that you prefix any command to be run by `/usr/bin/owncloud`, otherwise the container will not be initialized correctly. See the example command below: diff --git a/modules/admin_manual/pages/installation/index.adoc b/modules/admin_manual/pages/installation/index.adoc index 8a68cd5a0..5959e5d12 100644 --- a/modules/admin_manual/pages/installation/index.adoc +++ b/modules/admin_manual/pages/installation/index.adoc @@ -3,15 +3,7 @@ == Introduction -This is an overview about the possible installation options for ownCloud Server. You can install ownCloud Server manually or use a Docker-based installation. - -== Manual Installation - -* The xref:installation/manual_installation/manual_installation.adoc[Detailed Installation Guide] is a thorough guide for installing ownCloud, containing all the information needed for the prerequisites, the dependencies, the actual installation and the configuration afterwards. The example installation is based on Ubuntu Server. -+ -This guide covers Ubuntu server preparations like dependencies, required packages and other necessary components or configurations including Ubuntu upgrades if necessary, descriptions, explanations and easy copy and paste example commands where possible. You will also get directed to other necessary or recommended sections in the documentation to have a well working ownCloud Server base ready for production. - -* The xref:installation/quick_guides/ubuntu_20_04.adoc[Quick Installation Guide] is a quick guide for installing ownCloud. This guide cannot go into details and has its limits by nature. If you experience issues like with dependencies of PHP or other relevant things like the operating system, web server or database, you have to use the xref:installation/manual_installation/manual_installation.adoc[Detailed Installation Guide]. +Starting with ownCloud Server 11, the only supported installation method is a Docker-based installation. Manual installation on Linux is no longer supported. == Using a Docker-Based Installation diff --git a/modules/admin_manual/pages/installation/system_requirements.adoc b/modules/admin_manual/pages/installation/system_requirements.adoc index 4e42d051e..4f736cd6f 100644 --- a/modules/admin_manual/pages/installation/system_requirements.adoc +++ b/modules/admin_manual/pages/installation/system_requirements.adoc @@ -1,88 +1,41 @@ = System Requirements :toc: right :toclevels: 1 -:ppa-guide-url: https://itsfoss.com/ppa-guide/ :desktop-system-requirements-url: https://doc.owncloud.com/desktop/installing.html#system-requirements :ios-system-requirements-url: https://doc.owncloud.com/ios-app/ios_faq.html :android-system-requirements-url: https://doc.owncloud.com/android/faq.html -:description: Read this documentation for a recommended or supported environment for your ownCloud Server. This documentation applies to both a new installation or upgrade of an existing installation. +:description: Read this documentation for the supported environment for your ownCloud Server. Starting with ownCloud Server 11, only Docker-based installations are supported. == Introduction {description} -== General Note +== Docker Host Requirements -There is an important note about a xref:installation/manual_installation/manual_installation_prerequisites.adoc#openssl-version[prerequisite of openSSL]. We highly recommend checking this prerequisite as it needs to be checked regardless of the Operating System chosen. +ownCloud Server 11 is exclusively deployed via Docker. The following requirements apply to the Docker host: -== Officially Recommended Environment - -For _best performance_, _stability_, _support_ and _full functionality_, we officially recommend and support: - -[width="60%"cols="30%,60%a",options="header"] -|=== -| Platform -| Options - -| Operating System -| Ubuntu 20.04 LTS - -| Database -| xref:#database-requirements[MariaDB] 10.11 ^1^ - -| Redis -| >= 6 - -| Web server -| Apache 2.4 with xref:installation/manual_installation/manual_installation.adoc#configure-the-web-server[`prefork and mod_php`] - -| PHP Runtime -| {recommended-php-version} +[width="60%",cols="30%,60%a",options="header"] |=== +| Component +| Requirement -(1) MariaDB 10.6 and later is *only supported* with ownCloud release 10.9 and upwards. See the xref:installation/manual_installation/manual_installation.adoc#install-a-database[Install a Database] guide and xref:maintenance/upgrading/database_upgrade.adoc[Database Upgrade] guide. - -== Officially Supported Environments +| Docker +| Docker Engine 20.10 or later -For _best performance_, _stability_, _support_, and _full functionality_ we officially support: +| Docker Compose +| Docker Compose v2 or later -=== Server +| Architecture +| 64-bit (x86_64 / amd64) -[width="90%"cols=".^ 30%,90%a",options="header"] +| RAM +| Minimum 512MB; 1GB or more recommended |=== -| Platform -| Options - -| Operating System (64bit) -| * Debian 10 -* Red Hat Enterprise Linux 7, 8 and 9 + -including all 100% compatible derivatives (please note Red Hat Enterprise Linux 9 support is Enterprise only. Contact ownCloud support for more information) -* SUSE Linux Enterprise Server 12 with SP4/5 and 15 -* Ubuntu 20.04 and 22.04 -* openSUSE Leap 15.2 - -| Database -| * xref:#database-requirements[MySQL] 8+ or xref:#database-requirements[MariaDB] 10.2 through 10.11 ^1^ (*Recommended*) -* Oracle 11 and 12 can be run in Oracle 19c with compatibility mode (*Enterprise only*) -* PostgreSQL 9, 10, 11, 12, 13 or 14 -* SQLite (*Not for production*) - -| Redis -| * >= 6 - -|Web server -|* Apache 2.4 with xref:installation/manual_installation/manual_installation.adoc#configure-the-web-server[`prefork` and `mod_php`] - -| PHP Runtime -|* {supported-php-versions} -|=== - -(1) MariaDB 10.6 and later is *only supported* with ownCloud release 10.9 and upwards. See the xref:installation/manual_installation/manual_installation.adoc#install-a-database[Install a Database] guide and xref:maintenance/upgrading/database_upgrade.adoc[Database Upgrade] guide. [NOTE] ==== -For Linux distributions, we support, if technically feasible, the latest two versions per platform and the previous LTS Version. +The operating system, web server, PHP runtime, and database are all managed inside the Docker images provided by ownCloud. No manual configuration of these components is required on the host. ==== === Hypervisors @@ -120,16 +73,6 @@ You can find detailed system requirements in the documentation for the mobile ap You can find out more in the https://owncloud.com/changelog[changelog]. ==== -== Database Requirements - -The following database settings are currently required if you’re running ownCloud together with a MySQL or MariaDB database: - -* Disabled or `BINLOG_FORMAT = MIXED` or `BINLOG_FORMAT = ROW` configured Binary Logging (See: xref:configuration/database/linux_database_configuration.adoc#mysql-mariadb[MySQL / MariaDB with Binary Logging Enabled]) -* InnoDB storage engine (The MyISAM storage engine is *not supported*, see: -xref:configuration/database/linux_database_configuration.adoc#mysql-mariadb[MySQL / MariaDB storage engine]) -* `READ COMMITTED` transaction isolation level (See: -xref:configuration/database/linux_database_configuration.adoc#set-read-committed-as-the-transaction-isolation-level[MySQL / MariaDB `READ COMMITTED` transaction isolation level]) - == Memory Requirements Memory requirements for running an ownCloud server are greatly variable, depending on the numbers of users and files, and volume of server activity. ownCloud officially requires a minimum of 128MB RAM. diff --git a/modules/admin_manual/pages/maintenance/backup_and_restore/backup.adoc b/modules/admin_manual/pages/maintenance/backup_and_restore/backup.adoc index 949b943ce..db85ff240 100644 --- a/modules/admin_manual/pages/maintenance/backup_and_restore/backup.adoc +++ b/modules/admin_manual/pages/maintenance/backup_and_restore/backup.adoc @@ -70,6 +70,8 @@ Before backing up the database, set your ownCloud instance into maintenance mode {occ-command-example-prefix} maintenance:mode --on ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: This guide uses a backup file name like `owncloud-dbbackup_.bak`. === MySQL/MariaDB @@ -138,6 +140,8 @@ Perform the following tasks to reactivate your ownCloud instance: {occ-command-example-prefix} maintenance:mode --off ---- +NOTE: Run this command inside the ownCloud Docker container. + .Enable browser access Start your web server, or alternatively enable the virtual host serving ownCloud: [source,bash] diff --git a/modules/admin_manual/pages/maintenance/backup_and_restore/restore.adoc b/modules/admin_manual/pages/maintenance/backup_and_restore/restore.adoc index cd946538d..35505c43c 100644 --- a/modules/admin_manual/pages/maintenance/backup_and_restore/restore.adoc +++ b/modules/admin_manual/pages/maintenance/backup_and_restore/restore.adoc @@ -67,6 +67,8 @@ Before restoring the database, set your ownCloud instance into maintenance mode: {occ-command-example-prefix} maintenance:mode --on ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: This guide assumes that your previous backup is called `owncloud-dbbackup.bak`, though the file may have a timestamp added in the filename. === MySQL/MariaDB @@ -189,6 +191,8 @@ Run the following command to tell desktop and mobile clients that a server backu {occ-command-example-prefix} maintenance:data-fingerprint ---- +NOTE: Run this command inside the ownCloud Docker container. + === Bring back ownCloud into normal operation mode [source,bash,subs="attributes+"] @@ -196,6 +200,8 @@ Run the following command to tell desktop and mobile clients that a server backu {occ-command-example-prefix} maintenance:mode --off ---- +NOTE: Run this command inside the ownCloud Docker container. + === Enable browser access Start your web server, or alternatively enable the virtual host serving ownCloud: diff --git a/modules/admin_manual/pages/maintenance/enable_maintenance.adoc b/modules/admin_manual/pages/maintenance/enable_maintenance.adoc index 892586f5b..21441eb20 100644 --- a/modules/admin_manual/pages/maintenance/enable_maintenance.adoc +++ b/modules/admin_manual/pages/maintenance/enable_maintenance.adoc @@ -15,6 +15,8 @@ To enable maintenance mode, run the following command: {occ-command-example-prefix} maintenance:mode --on ---- +NOTE: Run this command inside the ownCloud Docker container. + You may also put your server into this mode by editing config/config.php. [source,php] @@ -31,6 +33,8 @@ To disable maintenance mode, run the following command: {occ-command-example-prefix} maintenance:mode --off ---- +NOTE: Run this command inside the ownCloud Docker container. + You may also put your server into this mode by editing config/config.php. + [source,php] diff --git a/modules/admin_manual/pages/maintenance/encryption/migrating-from-user-key-to-master-key.adoc b/modules/admin_manual/pages/maintenance/encryption/migrating-from-user-key-to-master-key.adoc index 521d7bbdc..87dfd15c6 100644 --- a/modules/admin_manual/pages/maintenance/encryption/migrating-from-user-key-to-master-key.adoc +++ b/modules/admin_manual/pages/maintenance/encryption/migrating-from-user-key-to-master-key.adoc @@ -49,6 +49,8 @@ You can see an example of calling the commands listed below, configured to requi {occ-command-example-prefix} app:disable --no-interaction encryption ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: The decryption of the files by the ownCloud administrator requires the current passwords of all users! This only works when users have enabled password recovery and if an admin recovery password is available. === Remove the Encryption Records from the ownCloud Database @@ -91,6 +93,8 @@ The following example shows how to do this on the command line. {occ-command-example-prefix} encryption:encrypt-all --yes ---- +NOTE: Run this command inside the ownCloud Docker container. + == Verify the Encrypted Files With the files encrypted using Master Key-based encryption, you should now verify that everything worked properly. To do so, run a `SELECT` query in your database which returns all files from the `oc_appconfig` table where the `appid` column is set to `encryption`. You should see a number of records, as in the output of the example below. diff --git a/modules/admin_manual/pages/maintenance/export_import_instance_data.adoc b/modules/admin_manual/pages/maintenance/export_import_instance_data.adoc index eb600ff85..df0d1e4d9 100644 --- a/modules/admin_manual/pages/maintenance/export_import_instance_data.adoc +++ b/modules/admin_manual/pages/maintenance/export_import_instance_data.adoc @@ -46,6 +46,8 @@ This will create a folder `/tmp/export/user1` which contains all the files and m {occ-command-example-prefix} instance:export:user user1 /tmp/export ---- +NOTE: Run this command inside the ownCloud Docker container. + === Copy the Export to the Target Instance Copy the created export to the target instance, for example, using `scp`: @@ -65,6 +67,8 @@ to federated shares pointing to the source instance: {occ-command-example-prefix} instance:import:user /tmp/export/user1 ---- +NOTE: Run this command inside the ownCloud Docker container. + NOTE: A new user's last login timestamp on the target instance will be set to the current time. The import command sets up the user's file system and the system does not need to do any further "first login" processing when the user first logs in to the target instance. === Recreate all Shares to Point to the Target Instance @@ -77,6 +81,8 @@ they point to the target instance. To do so, run this command on the source inst {occ-command-example-prefix} instance:export:migrate:share user1 https://newinstance.com ---- +NOTE: Run this command inside the ownCloud Docker container. + === Delete the User on the Source Instance Finally delete `user1` on the source instance: @@ -91,6 +97,8 @@ on the target instance. See xref:known-limitations[Known Limitations] for furthe {occ-command-example-prefix} user:delete user1 ---- +NOTE: Run this command inside the ownCloud Docker container. + == What is Exported - Files (Local) diff --git a/modules/admin_manual/pages/maintenance/manually-moving-data-folders.adoc b/modules/admin_manual/pages/maintenance/manually-moving-data-folders.adoc index 91069ee2f..6a44c1314 100644 --- a/modules/admin_manual/pages/maintenance/manually-moving-data-folders.adoc +++ b/modules/admin_manual/pages/maintenance/manually-moving-data-folders.adoc @@ -53,6 +53,8 @@ To enable maintenance mode, run the following command. {occ-command-example-prefix} maintenance:mode --on ---- +NOTE: Run this command inside the ownCloud Docker container. + == Sync your Data Directory [source,bash] @@ -158,6 +160,8 @@ To fix the config.php settings: {occ-command-example-prefix} config:system:set --value /mnt/owncloud/data datadirectory ---- +NOTE: Run this command inside the ownCloud Docker container. + === Adjust config.php . Change the `datadirectory` key in your `config.php` to the new path. @@ -174,6 +178,8 @@ To disable maintenance mode of your instance run the following command: {occ-command-example-prefix} maintenance:mode --off ---- +NOTE: Run this command inside the ownCloud Docker container. + == Start the Web Server [source,bash] @@ -187,3 +193,5 @@ sudo service apache2 start ---- {occ-command-example-prefix} files:scan --all ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/maintenance/migrating.adoc b/modules/admin_manual/pages/maintenance/migrating.adoc index eedecc486..0bb108a29 100644 --- a/modules/admin_manual/pages/maintenance/migrating.adoc +++ b/modules/admin_manual/pages/maintenance/migrating.adoc @@ -152,6 +152,8 @@ cd /var/www/owncloud/ {occ-command-example-prefix} maintenance:mode --on ---- +NOTE: Run this command inside the ownCloud Docker container. + After that’s done, then wait a few minutes and stop your web server, in this case Apache: [source,bash] @@ -227,6 +229,8 @@ first verify that ownCloud is in maintenance mode. {occ-command-example-prefix} maintenance:mode ---- +NOTE: Run this command inside the ownCloud Docker container. + Next, start up the database and web server on the new machine. [source,bash] @@ -245,6 +249,8 @@ maintenance mode. {occ-command-example-prefix} maintenance:mode --off ---- +NOTE: Run this command inside the ownCloud Docker container. + And finally, log in as admin and confirm normal function of ownCloud. If you have a domain name, and you want an SSL certificate, we recommend https://certbot.eff.org/[certbot]. diff --git a/modules/admin_manual/pages/maintenance/upgrading/database_upgrade.adoc b/modules/admin_manual/pages/maintenance/upgrading/database_upgrade.adoc index e526f030e..212f6f45d 100644 --- a/modules/admin_manual/pages/maintenance/upgrading/database_upgrade.adoc +++ b/modules/admin_manual/pages/maintenance/upgrading/database_upgrade.adoc @@ -41,6 +41,8 @@ xref:maintenance/backup_and_restore/backup.adoc[Backing up ownCloud] guide. ---- {occ-command-example-prefix} maintenance:mode --on ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Prevent browser access + + @@ -59,6 +61,8 @@ sudo service apache2 stop ---- {occ-command-example-prefix} db:restore-default-row-format ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Upgrade MariaDB to version 10.6+ + @@ -80,6 +84,8 @@ when using a dockerized environment as part of the upgrade procedure. ---- {occ-command-example-prefix} maintenance:mode --off ---- ++ +NOTE: Run this command inside the ownCloud Docker container. . Enable browser access + Start your web server, Alternatively, enable the virtual host serving ownCloud again: diff --git a/modules/admin_manual/pages/troubleshooting/providing_logs_and_config_files.adoc b/modules/admin_manual/pages/troubleshooting/providing_logs_and_config_files.adoc index 16318b6cb..df300c1cc 100644 --- a/modules/admin_manual/pages/troubleshooting/providing_logs_and_config_files.adoc +++ b/modules/admin_manual/pages/troubleshooting/providing_logs_and_config_files.adoc @@ -20,12 +20,16 @@ Check if it is disabled: {occ-command-example-prefix} app:list --disabled configreport ---- +NOTE: Run this command inside the ownCloud Docker container. + Enable it if it was formerly disabled: [source,bash,subs="attributes+"] ---- {occ-command-example-prefix} app:enable configreport ---- +NOTE: Run this command inside the ownCloud Docker container. + === Generate via webUI To generate a config report using the webUI, navigate to: + @@ -40,6 +44,8 @@ To generate a config report from the command line, run the following command fro {occ-command-example-prefix} configreport:generate > config_report.txt ---- +NOTE: Run this command inside the ownCloud Docker container. + == ownCloud Server Log File === Generate via webUI @@ -71,3 +77,5 @@ If LDAP is used, viewing the LDAP configuration is important when checking for e ---- {occ-command-example-prefix} ldap:show-config > ldap_config.txt ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/pages/troubleshooting/remove_non_existent_bg_jobs.adoc b/modules/admin_manual/pages/troubleshooting/remove_non_existent_bg_jobs.adoc index b93808621..14ec92d89 100644 --- a/modules/admin_manual/pages/troubleshooting/remove_non_existent_bg_jobs.adoc +++ b/modules/admin_manual/pages/troubleshooting/remove_non_existent_bg_jobs.adoc @@ -38,6 +38,8 @@ Use the following command to list all active background jobs triggered by ownClo {occ-command-example-prefix} background:queue:status --display-invalid-jobs ---- +NOTE: Run this command inside the ownCloud Docker container. + The output may look like the following: [source,plaintext] @@ -63,6 +65,8 @@ When you have identified the `ID` of the background job to be removed, run foll {occ-command-example-prefix} background:queue:delete ID ---- +NOTE: Run this command inside the ownCloud Docker container. + WARNING: Deleting a job cannot be undone. Be sure that you want to delete the job before doing so. === Remove Jobs Manually Added via Crontab diff --git a/modules/admin_manual/partials/configuration/server/disable-single-user-mode.adoc b/modules/admin_manual/partials/configuration/server/disable-single-user-mode.adoc index 3e7a3d3ec..809cb7b20 100644 --- a/modules/admin_manual/partials/configuration/server/disable-single-user-mode.adoc +++ b/modules/admin_manual/partials/configuration/server/disable-single-user-mode.adoc @@ -6,3 +6,5 @@ With encryption migrated from User Key-based encryption to Master Key-based, dis ---- {occ-command-example-prefix} maintenance:singleuser --off ---- + +NOTE: Run this command inside the ownCloud Docker container. diff --git a/modules/admin_manual/partials/nav.adoc b/modules/admin_manual/partials/nav.adoc index 3ca238b18..63444a28e 100644 --- a/modules/admin_manual/partials/nav.adoc +++ b/modules/admin_manual/partials/nav.adoc @@ -10,30 +10,15 @@ *** xref:admin_manual:installation/deployment_recommendations.adoc[Deployment Recommendations] **** xref:admin_manual:installation/deployment_recommendations/nfs.adoc[NFS] *** xref:admin_manual:installation/system_requirements.adoc[System Requirements] -*** xref:admin_manual:installation/configuration_notes_and_tips.adoc[Configuration Notes and Tips] *** xref:admin_manual:installation/index.adoc[Installation Options] **** xref:admin_manual:installation/docker/index.adoc[Installing With Docker] -**** Manual Installation on Linux -***** Detailed Installation Guide -****** xref:admin_manual:installation/manual_installation/manual_installation.adoc[Detailed Installation on Ubuntu (various versions)] -***** Quick Installation Guide -****** xref:admin_manual:installation/quick_guides/ubuntu_20_04.adoc[On Ubuntu 20.04] -****** xref:admin_manual:installation/quick_guides/ubuntu_22_04.adoc[On Ubuntu 22.04] -***** Linux Package Manager -**** xref:admin_manual:installation/installation_wizard.adoc[The Installation Wizard] *** xref:admin_manual:installation/troubleshooting.adoc[Troubleshooting] -*** xref:admin_manual:installation/changing_the_web_route.adoc[Changing Your ownCloud URL] *** xref:admin_manual:installation/apps_management_installation.adoc[Installing and Managing Apps] *** xref:admin_manual:installation/apps_supported.adoc[Supported Apps] **** xref:admin_manual:installation/apps/mediaviewer/index.adoc[Media Viewer] -*** xref:admin_manual:installation/selinux_configuration.adoc[SELinux Configuration] -*** xref:admin_manual:installation/letsencrypt/index.adoc[Using Let's Encrypt SSL Certificates] -**** xref:admin_manual:installation/letsencrypt/using_letsencrypt.adoc[Using Letsencrypt] -**** xref:admin_manual:installation/letsencrypt/apache.adoc[Apache] ** Configuration *** xref:admin_manual:configuration/database/index.adoc[Database] -**** xref:admin_manual:configuration/database/db_conversion.adoc[Database Conversion] **** xref:admin_manual:configuration/database/linux_database_configuration.adoc[Database Configuration] *** xref:admin_manual:configuration/files/encryption/index.adoc[Encryption]