From f94eedaee347f1228c6c3b21616ef22962d2815c Mon Sep 17 00:00:00 2001 From: Klaas Freitag Date: Mon, 24 Mar 2025 17:23:20 +0100 Subject: [PATCH] Clean invalid documentation links --- deployments/examples/opencloud_full/.env | 14 +++++--------- services/storage-users/README.md | 9 ++++----- 2 files changed, 9 insertions(+), 14 deletions(-) diff --git a/deployments/examples/opencloud_full/.env b/deployments/examples/opencloud_full/.env index dc968051c..858047056 100644 --- a/deployments/examples/opencloud_full/.env +++ b/deployments/examples/opencloud_full/.env @@ -50,11 +50,11 @@ OC_DOMAIN= ADMIN_PASSWORD= # Demo users should not be created on a production instance, # because their passwords are public. Defaults to "false". -# Also see: https://doc.opencloud.eu/opencloud/latest/deployment/general/general-info.html#demo-users-and-groups +# If demo users is set to "true", the following user accounts are created automatically: +# alan, mary, margaret, dennis and lynn - the password is 'demo' for all. DEMO_USERS= # Define the openCloud loglevel used. -# For more details see: -# https://doc.opencloud.eu/opencloud/latest/deployment/services/env-vars-special-scope.html +# LOG_LEVEL= # Define the kind of logging. # The default log can be read by machines. @@ -64,8 +64,6 @@ LOG_LEVEL= # Define the openCloud storage location. Set the paths for config and data to a local path. # Note that especially the data directory can grow big. # Leaving it default stores data in docker internal volumes. -# For more details see: -# https://doc.opencloud.eu/opencloud/next/deployment/general/general-info.html#default-paths # OC_CONFIG_DIR=/your/local/opencloud/config # OC_DATA_DIR=/your/local/opencloud/data @@ -74,7 +72,7 @@ LOG_LEVEL= # Per default, S3 storage is disabled and the decomposed storage driver is used. # To enable S3 storage, uncomment the following line and configure the S3 storage. # For more details see: -# https://doc.opencloud.eu/opencloud/next/deployment/storage/decomposeds3.html +# https://docs.opencloud.eu/docs/admin/configuration/storage-decomposeds3 # Note: the leading colon is required to enable the service. #DECOMPOSEDS3=:decomposeds3.yml # Configure the S3 storage endpoint. Defaults to "http://minio:9000" for testing purposes. @@ -102,8 +100,7 @@ MINIO_DOMAIN= #POSIX=:posix.yml # Define SMPT settings if you would like to send OpenCloud email notifications. -# For more details see: -# https://doc.opencloud.eu/opencloud/latest/deployment/services/s-list/notifications.html +# # NOTE: when configuring Inbucket, these settings have no effect, see inbucket.yml for details. # SMTP host to connect to. SMTP_HOST= @@ -205,7 +202,6 @@ COLLABORA_SSL_VERIFICATION=false ### Debugging - Monitoring ### -# Please see documentation at: https://opencloud.dev/opencloud/deployment/monitoring-tracing/ # Note: the leading colon is required to enable the service. #MONITORING=:monitoring_tracing/monitoring.yml diff --git a/services/storage-users/README.md b/services/storage-users/README.md index 28ec07390..0289db18f 100644 --- a/services/storage-users/README.md +++ b/services/storage-users/README.md @@ -12,7 +12,7 @@ When hard-stopping OpenCloud, for example with the `kill ` command (SIGKILL * With the value of the environment variable `STORAGE_USERS_GRACEFUL_SHUTDOWN_TIMEOUT`, the `storage-users` service will delay its shutdown giving it time to finalize writing necessary data. This delay can be necessary if there is a lot of data to be saved and/or if storage access/thruput is slow. In such a case you would receive an error log entry informing you that not all data could be saved in time. To prevent such occurrences, you must increase the default value. -* If a shutdown error has been logged, the command-line maintenance tool [Inspect and Manipulate Node Metadata](https://doc.opencloud.eu/maintenance/commands/commands.html#inspect-and-manipulate-node-metadata) can help to fix the issue. Please contact support for details. +* If a shutdown error has been logged, the command-line maintenance tool to inspect and manipulate node metadata can help to fix the issue. Please contact support for details. ## CLI Commands @@ -142,8 +142,7 @@ opencloud storage-users uploads sessions --processing=false --has-virus=false -- ### Manage Trash-Bin Items -This command set provides commands to get an overview of trash-bin items, restore items and purge old items of `personal` spaces and `project` spaces (spaces that have been created manually). `trash-bin` commands require a `spaceID` as parameter. See [List all spaces -](https://doc.opencloud.eu/apis/http/graph/spaces/#list-all-spaces-get-drives) or [Listing Space IDs](https://doc.opencloud.eu/maintenance/space-ids/space-ids.html) for details of how to get them. +This command set provides commands to get an overview of trash-bin items, restore items and purge old items of `personal` spaces and `project` spaces (spaces that have been created manually). `trash-bin` commands require a `spaceID` as parameter. ```bash opencloud storage-users trash-bin @@ -170,10 +169,10 @@ The behaviour of the `purge-expired` command can be configured by using the foll Used to obtain space trash-bin information and takes the system admin user as the default which is the `OC_ADMIN_USER_ID` but can be set individually. It should be noted, that the `OC_ADMIN_USER_ID` is only assigned automatically when using the single binary deployment and must be manually assigned in all other deployments. The command only considers spaces to which the assigned user has access and delete permission. * `STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE`\ -Has a default value of `720h` which equals `30 days`. This means, the command will delete all files older than `30 days`. The value is human-readable, for valid values see the duration type described in the [Environment Variable Types](https://doc.opencloud.eu/deployment/services/envvar-types-description.html). A value of `0` is equivalent to disable and prevents the deletion of `personal space` trash-bin files. +Has a default value of `720h` which equals `30 days`. This means, the command will delete all files older than `30 days`. The value is human-readable. A value of `0` is equivalent to disable and prevents the deletion of `personal space` trash-bin files. * `STORAGE_USERS_PURGE_TRASH_BIN_PROJECT_DELETE_BEFORE`\ -Has a default value of `720h` which equals `30 days`. This means, the command will delete all files older than `30 days`. The value is human-readable, for valid values see the duration type described in the [Environment Variable Types](https://doc.opencloud.eu/latest/deployment/services/envvar-types-description.html). A value of `0` is equivalent to disable and prevents the deletion of `project space` trash-bin files. +Has a default value of `720h` which equals `30 days`. This means, the command will delete all files older than `30 days`. The value is human-readable. A value of `0` is equivalent to disable and prevents the deletion of `project space` trash-bin files. #### List and Restore Trash-Bins Items