docs: cleanup header levels in backend docs (#5698)

This commit is contained in:
albertony
2021-10-14 15:40:18 +02:00
committed by GitHub
parent ceaafe6620
commit c2597a4fa3
45 changed files with 608 additions and 523 deletions

View File

@@ -9,6 +9,8 @@ Paths are specified as `remote:path`
Paths may be as deep as required, e.g. `remote:directory/subdirectory`.
## Configuration
The initial setup for OneDrive involves getting a token from
Microsoft which you need to do in your browser. `rclone config` walks
you through it.
@@ -116,7 +118,7 @@ To copy a local directory to an OneDrive directory called backup
rclone copy /home/source remote:backup
### Getting your own Client ID and Key ###
### Getting your own Client ID and Key
You can use your own Client ID if the default (`client_id` left blank)
one doesn't work for you or you see lots of throttling. The default
@@ -135,7 +137,7 @@ Client ID and Key by following the steps below:
Now the application is complete. Run `rclone config` to create or edit a OneDrive remote.
Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps.
### Modification time and hashes ###
### Modification time and hashes
OneDrive allows modification times to be set on objects accurate to 1
second. These will be used to detect whether objects need syncing or
@@ -147,7 +149,7 @@ Sharepoint Server support
For all types of OneDrive you can use the `--checksum` flag.
### Restricted filename characters ###
### Restricted filename characters
In addition to the [default restricted characters set](/overview/#restricted-characters)
the following characters are also replaced:
@@ -182,7 +184,7 @@ These only get replaced if they are the first character in the name:
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings.
### Deleting files ###
### Deleting files
Any files you delete with rclone will end up in the trash. Microsoft
doesn't provide an API to permanently delete files, nor to empty the
@@ -409,14 +411,14 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
{{< rem autogenerated options stop >}}
### Limitations
## Limitations
If you don't use rclone for 90 days the refresh token will
expire. This will result in authorization problems. This is easy to
fix by running the `rclone config reconnect remote:` command to get a
new token and refresh token.
#### Naming ####
### Naming
Note that OneDrive is case insensitive so you can't have a
file called "Hello.doc" and one called "hello.doc".
@@ -427,15 +429,15 @@ platforms they are common. Rclone will map these names to and from an
identical looking unicode equivalent. For example if a file has a `?`
in it will be mapped to `` instead.
#### File sizes ####
### File sizes
The largest allowed file size is 250 GiB for both OneDrive Personal and OneDrive for Business [(Updated 13 Jan 2021)](https://support.microsoft.com/en-us/office/invalid-file-names-and-file-types-in-onedrive-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa?ui=en-us&rs=en-us&ad=us#individualfilesize).
#### Path length ####
### Path length
The entire path, including the file name, must contain fewer than 400 characters for OneDrive, OneDrive for Business and SharePoint Online. If you are encrypting file and folder names with rclone, you may want to pay attention to this limitation because the encrypted names are typically longer than the original ones.
#### Number of files ####
### Number of files
OneDrive seems to be OK with at least 50,000 files in a folder, but at
100,000 rclone will get errors listing the directory like `couldnt
@@ -444,7 +446,7 @@ list files: UnknownError:`. See
An official document about the limitations for different types of OneDrive can be found [here](https://support.office.com/en-us/article/invalid-file-names-and-file-types-in-onedrive-onedrive-for-business-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa).
### Versions
## Versions
Every change in a file OneDrive causes the service to create a new
version of the the file. This counts against a users quota. For
@@ -500,7 +502,7 @@ Note: This will disable the creation of new file versions, but will not remove a
8. Use rclone to upload or modify files. (I also use the --no-update-modtime flag)
9. Restore the versioning settings after using rclone. (Optional)
### Cleanup
## Cleanup
OneDrive supports `rclone cleanup` which causes rclone to look through
every file under the path supplied and delete all version but the
@@ -514,15 +516,15 @@ is a great way to see what it would do.
**NB** Onedrive personal can't currently delete versions
### Troubleshooting ###
## Troubleshooting ##
#### Excessive throttling or blocked on SharePoint
### Excessive throttling or blocked on SharePoint
If you experience excessive throttling or is being blocked on SharePoint then it may help to set the user agent explicitly with a flag like this: `--user-agent "ISV|rclone.org|rclone/v1.55.1"`
The specific details can be found in the Microsoft document: [Avoid getting throttled or blocked in SharePoint Online](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online#how-to-decorate-your-http-traffic-to-avoid-throttling)
#### Unexpected file size/hash differences on Sharepoint ####
### Unexpected file size/hash differences on Sharepoint ####
It is a
[known](https://github.com/OneDrive/onedrive-api-docs/issues/935#issuecomment-441741631)
@@ -546,7 +548,7 @@ file to be converted in place to a format that is functionally equivalent
but which will no longer trigger the size discrepancy. Once all problematic files
are converted you will no longer need the ignore options above.
#### Replacing/deleting existing files on Sharepoint gets "item not found" ####
### Replacing/deleting existing files on Sharepoint gets "item not found" ####
It is a [known](https://github.com/OneDrive/onedrive-api-docs/issues/1068) issue
that Sharepoint (not OneDrive or OneDrive for Business) may return "item not
@@ -561,7 +563,7 @@ the directory `rclone-backup-dir` on backend `mysharepoint`, you may use:
--backup-dir mysharepoint:rclone-backup-dir
```
#### access\_denied (AADSTS65005) ####
### access\_denied (AADSTS65005) ####
```
Error: access_denied
@@ -573,7 +575,7 @@ This means that rclone can't use the OneDrive for Business API with your account
However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint
#### invalid\_grant (AADSTS50076) ####
### invalid\_grant (AADSTS50076) ####
```
Error: invalid_grant
@@ -583,7 +585,7 @@ Description: Due to a configuration change made by your administrator, or becaus
If you see the error above after enabling multi-factor authentication for your account, you can fix it by refreshing your OAuth refresh token. To do that, run `rclone config`, and choose to edit your OneDrive backend. Then, you don't need to actually make any changes until you reach this question: `Already have a token - refresh?`. For this question, answer `y` and go through the process to refresh your token, just like the first time the backend is configured. After this, rclone should work again for this backend.
#### Invalid request when making public links ####
### Invalid request when making public links ####
On Sharepoint and OneDrive for Business, `rclone link` may return an "Invalid
request" error. A possible cause is that the organisation admin didn't allow