From 71dbd1103f96ea909e79e8c2d4f87331b248d73a Mon Sep 17 00:00:00 2001 From: Jos Poortvliet Date: Thu, 14 Apr 2022 15:35:15 +0200 Subject: [PATCH] Update documentation. - Fix table that was missing - Updates targetChunkUploadDuration and maxChunkSize. - Adds section about Cloudflare. Signed-off-by: Jos Poortvliet --- doc/conffile.rst | 56 ++++++++++++++++++++--------------------- doc/troubleshooting.rst | 25 ++++++++++++++++++ 2 files changed, 53 insertions(+), 28 deletions(-) diff --git a/doc/conffile.rst b/doc/conffile.rst index 86b8f729a..278aae5b9 100644 --- a/doc/conffile.rst +++ b/doc/conffile.rst @@ -33,35 +33,35 @@ Some interesting values that can be set on the configuration file are: +---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ -+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ``[General]`` section | -+==================================+===============+=================================================================================================================+ -| Variable | Default | Meaning | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ -| ``chunkSize`` | ``10000000`` (10 MB) | Specifies the chunk size of uploaded files in bytes. | -| | | The client will dynamically adjust this size within the maximum and minimum bounds (see below). | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[General]`` section | ++==================================+==========================+========================================================================================================+ +| Variable | Default | Meaning | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``chunkSize`` | ``10000000`` (10 MB) | Specifies the chunk size of uploaded files in bytes. | +| | | The client will dynamically adjust this size within the maximum and minimum bounds (see below). | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``minChunkSize`` | ``1000000`` (1 MB) | Specifies the minimum chunk size of uploaded files in bytes. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ | ``maxChunkSize`` | ``1000000000`` (1000 MB) | Specifies the maximum chunk size of uploaded files in bytes. | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ -| ``minChunkSize`` | ``1000000`` (1 MB) | Specifies the minimum chunk size of uploaded files in bytes. | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ -| ``targetChunkUploadDuration`` | ``6000`` (1 minute) | Target duration in milliseconds for chunk uploads. | -| | | The client adjusts the chunk size until each chunk upload takes approximately this long. | -| | | Set to 0 to disable dynamic chunk sizing. | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ -| ``promptDeleteAllFiles`` | ``true`` | If a UI prompt should ask for confirmation if it was detected that all files and folders were deleted. | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ -| ``timeout`` | ``300`` | The timeout for network connections in seconds. | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ -| ``moveToTrash`` | ``false`` | If non-locally deleted files should be moved to trash instead of deleting them completely. | -| | | This option only works on linux | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ -| ``showExperimentalOptions`` | ``false`` | Whether to show experimental options that are still undergoing testing in the user interface. | -| | | Turning this on does not enable experimental behavior on its own. It does enable user inferface | -| | | options that can be used to opt in to experimental features. | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ -| ``showMainDialogAsNormalWindow`` | ``false`` | Whether the main dialog should be shown as a normal window even if tray icons are available. | -+----------------------------------+------------------------+--------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``targetChunkUploadDuration`` | ``60000`` (1 minute) | Target duration in milliseconds for chunk uploads. | +| | | The client adjusts the chunk size until each chunk upload takes approximately this long. | +| | | Set to 0 to disable dynamic chunk sizing. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``promptDeleteAllFiles`` | ``true`` | If a UI prompt should ask for confirmation if it was detected that all files and folders were deleted. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``timeout`` | ``300`` | The timeout for network connections in seconds. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``moveToTrash`` | ``false`` | If non-locally deleted files should be moved to trash instead of deleting them completely. | +| | | This option only works on linux | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``showExperimentalOptions`` | ``false`` | Whether to show experimental options that are still undergoing testing in the user interface. | +| | | Turning this on does not enable experimental behavior on its own. It does enable user inferface | +| | | options that can be used to opt in to experimental features. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``showMainDialogAsNormalWindow`` | ``false`` | Whether the main dialog should be shown as a normal window even if tray icons are available. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +----------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst index bdafba18f..1a1be3251 100644 --- a/doc/troubleshooting.rst +++ b/doc/troubleshooting.rst @@ -66,6 +66,31 @@ configured on your client. See https://github.com/owncloud/client/issues/5226 for more discussion of this issue. +"Connection closed" message when syncing files +--------------------- + +This message can be caused by using chunks that are too big or time-outs that +are set too liberally. You can configure the chunking behavior of the client in +the config file. For example, change these settings: + ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``chunkSize`` | ``10000000`` (10 MB) | Specifies the chunk size of uploaded files in bytes. | +| | | The client will dynamically adjust this size within the maximum and minimum bounds (see below). | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``minChunkSize`` | ``1000000`` (1 MB) | Specifies the minimum chunk size of uploaded files in bytes. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``maxChunkSize`` | ``50000000`` (1000 MB) | Specifies the maximum chunk size of uploaded files in bytes. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ +| ``targetChunkUploadDuration`` | ``6000`` (1 minute) | Target duration in milliseconds for chunk uploads. | +| | | The client adjusts the chunk size until each chunk upload takes approximately this long. | +| | | Set to 0 to disable dynamic chunk sizing. | ++----------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------+ + +Setting ``maxChunkSize`` to 50000000, for example, will decrease the +individual chunk to about 50 mb. This causes additional overhead but +might be required in some situations, for example behind CloudFlare which +has been seen limiting upload chunks to 100mb. In other situations, +limiting ``targetChunkUploadDuration`` can help to avoid time-outs. Isolating other issues ----------------------