Skip to content

Commit

Permalink
Update usage.md
Browse files Browse the repository at this point in the history
* Update notes
  • Loading branch information
abraunegg committed Jan 21, 2025
1 parent c60a889 commit 3b74d2d
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@ The above guidelines are essential for maintaining synchronisation integrity wit

### Support for Microsoft Azure Information Protected Files
> [!CAUTION]
> If you are using OneDrive Business Accounts and your organisation implements Azure Information Protection, these AIP files will report as one size & hash online, but when downloaded, will report a totally different size and hash.
> If you are using OneDrive Business Accounts and your organisation implements Azure Information Protection, these AIP files will report as one size & hash online, but when downloaded, will report a totally different size and hash. This is due to how the Microsoft Graph API handles AIP files and how Microsoft SharePoint (the technology behind Microsoft OneDrive for Business) serves these files via the API.
>
> By default these files will fail integrity checking and be deleted locally, meaning that AIP files will not reside on your platform. These AIP files will be flagged as a failed download.
> By default these files will fail integrity checking and be deleted locally, meaning that AIP files will not reside on your platform. These AIP files will be flagged as a failed download during application operation.
>
> If you chose to enable `--disable-download-validation` , the AIP files will download to your platform, however, if there are any other genuine download failures where the size and hash are different, these too will be retained locally meaning you may experience data integrity loss. This is due to the Microsoft Graph API lacking any capability to identify up-front that a file utilises AIP, thus zero capability to differentiate between AIP and non-AIP files for failure.
> If you chose to enable `--disable-download-validation` , the AIP files will download to your platform, however, if there are any other genuine download failures where the size and hash are different, these too will be retained locally meaning you may experience data integrity loss. This is due to the Microsoft Graph API lacking any capability to identify up-front that a file utilises AIP, thus zero capability to differentiate between AIP and non-AIP files for failure detection.
>
> Please use the `--disable-download-validation` option with extreme caution and understand the risk if you enable it.
Expand Down Expand Up @@ -165,6 +165,9 @@ If you explicitly want to use HTTP/1.1, you can do so by using the `--force-http
| 8.5.0 | Alpine Linux 3.15, Ubuntu 24.04 LTS (Noble Numbat) | 8,9,10,11,12,13 |
| 8.10.0 | Alpine Linux 3.17 | 13 |

> [!CAUTION]
> If you use a curl/libcurl version with known HTTP/2 bugs you will experience application runtime issues such as randomly exiting for zero reason or incomplete download/upload of your data potentially leading to file deletion.
> [!IMPORTANT]
> If your distribution provides one of these curl versions you must upgrade your curl version to the latest available, or get your distribution to provide a more modern version of curl. Refer to [curl releases](https://curl.se/docs/releases.html) for curl version information.
>
Expand All @@ -175,17 +178,21 @@ If you explicitly want to use HTTP/1.1, you can do so by using the `--force-http
> Downgrading all application operations to use HTTP/1.1 to ensure maximum operational stability.
> Please read https://github.com/abraunegg/onedrive/blob/master/docs/usage.md#compatibility-with-curl for more information.
> ```
>
> The WARNING line will be sent to the GUI for notification purposes if notifications have been enabled. To avoid this message and/or the GUI notification your only path of remediation is to upgrade your curl version on your platform.
>
> If you are unable to upgrade your version of curl, you must add the following to your config file:
> ```text
> force_http_11 = "true"
> ip_protocol_version = "1"
> ```
> When these two options are applied to your application configuration, the following application message will be generated:
> When these two options are applied to your application configuration, the following application message will be generated and no GUI alert will be sent:
> ```text
> WARNING: Your curl/libcurl version (curl.version.number) has known operational bugs that impact the use of this application.
> Please report this to your distribution and request that they provide a newer curl version for your platform or upgrade this yourself.
> ```
> In both cases, the WARNING line will be sent to the GUI for notification purposes if notifications have been enabled. To avoid this message and/or the GUI notification your only path of remediation is to upgrade your curl version on your platform.
>
> The WARNING line will be now only be written to application logging output, no longer sending a GUI notification message.
> [!IMPORTANT]
> There are significant HTTP/2 bugs in all curl versions < 8.6.x that can lead to HTTP/2 errors such as `Error in the HTTP2 framing layer on handle` or `Stream error in the HTTP/2 framing layer on handle`
Expand All @@ -207,7 +214,7 @@ If you explicitly want to use HTTP/1.1, you can do so by using the `--force-http
> 2. Configure the client to only use IPv4 DNS resolution via setting the configuration option `ip_protocol_version = "1"`
> [!IMPORTANT]
> If you are using Debian 12 or Linux Mint Debian Edition (LMDE) 6, you can install curl version 8.10.1 from the respective backports repositories to address the bugs present in the default curl version.
> If you are using Debian 12 or Linux Mint Debian Edition (LMDE) 6, you can install curl version 8.10.1 from the respective backports repositories to address the bugs present in the default Debian 12 curl version.
## First Steps
Expand Down

0 comments on commit 3b74d2d

Please sign in to comment.