github-mirror/rclone
2
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-06-03 02:23:16 +08:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

67
docs/content/swift.md
View File

@ -17,6 +17,8 @@ Commercial implementations of that being:
Paths are specified as `remote:container` (or `remote:` for the `lsd`
command.) You may put subdirectories in too, e.g. `remote:container/path/to/dir`.
## Configuration
Here is an example of making a swift configuration. First run
rclone config
@ -133,7 +135,7 @@ excess files in the container.
rclone sync -i /home/local/directory remote:container
### Configuration from an OpenStack credentials file ###
### Configuration from an OpenStack credentials file
An OpenStack credentials file typically looks something something
like this (without the comments)
@ -165,7 +167,7 @@ tenant = $OS_TENANT_NAME
Note that you may (or may not) need to set `region` too - try without first.
### Configuration from the environment ###
### Configuration from the environment
If you prefer you can configure rclone to use swift using a standard
set of OpenStack environment variables.
@ -179,7 +181,7 @@ the
variables](https://godoc.org/github.com/ncw/swift#Connection.ApplyEnvironment)
in the docs for the swift library.
### Using an alternate authentication method ###
### Using an alternate authentication method
If your OpenStack installation uses a non-standard authentication method
that might not be yet supported by rclone or the underlying swift library,
@ -190,7 +192,7 @@ If they are both provided, the other variables are ignored. rclone will
not try to authenticate but instead assume it is already authenticated
and use these two variables to access the OpenStack installation.
#### Using rclone without a config file ####
#### Using rclone without a config file
You can use rclone with swift without a config file, if desired, like
this:
@ -202,13 +204,13 @@ export RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true
rclone lsd myremote:
```
### --fast-list ###
### --fast-list
This remote supports `--fast-list` which allows you to use fewer
transactions in exchange for more memory. See the [rclone
docs](/docs/#fast-list) for more details.
### --update and --use-server-modtime ###
### --update and --use-server-modtime
As noted below, the modified time is stored on metadata on the object. It is
used by default for all operations that require checking the time a file was
@ -221,6 +223,25 @@ sufficient to determine if it is "dirty". By using `--update` along with
`--use-server-modtime`, you can avoid the extra API call and simply upload
files whose local modtime is newer than the time it was last uploaded.
### Modified time
The modified time is stored as metadata on the object as
`X-Object-Meta-Mtime` as floating point since the epoch accurate to 1
ns.
This is a de facto standard (used in the official python-swiftclient
amongst others) for storing the modification time for an object.
### Restricted filename characters
| Character | Value | Replacement |
| --------- |:-----:|:-----------:|
| NUL | 0x00 | ␀ |
| / | 0x2F | ／ |
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings.
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/swift/swift.go then run make backenddocs" >}}
### Standard Options
@ -481,34 +502,15 @@ See: the [encoding section in the overview](/overview/#encoding) for more info.
{{< rem autogenerated options stop >}}
### Modified time ###
The modified time is stored as metadata on the object as
`X-Object-Meta-Mtime` as floating point since the epoch accurate to 1
ns.
This is a de facto standard (used in the official python-swiftclient
amongst others) for storing the modification time for an object.
### Restricted filename characters
| Character | Value | Replacement |
| --------- |:-----:|:-----------:|
| NUL | 0x00 | ␀ |
| / | 0x2F | ／ |
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
as they can't be used in JSON strings.
### Limitations ###
## Limitations
The Swift API doesn't return a correct MD5SUM for segmented files
(Dynamic or Static Large Objects) so rclone won't check or use the
MD5SUM for these.
### Troubleshooting ###
## Troubleshooting
#### Rclone gives Failed to create file system for "remote:": Bad Request ####
### Rclone gives Failed to create file system for "remote:": Bad Request
Due to an oddity of the underlying swift library, it gives a "Bad
Request" error rather than a more sensible error when the
@ -520,19 +522,20 @@ investigate further with the `--dump-bodies` flag.
This may also be caused by specifying the region when you shouldn't
have (e.g. OVH).
#### Rclone gives Failed to create file system: Response didn't have storage url and auth token ####
### Rclone gives Failed to create file system: Response didn't have storage url and auth token
This is most likely caused by forgetting to specify your tenant when
setting up a swift remote.
### OVH Cloud Archive ###
## OVH Cloud Archive
To use rclone with OVH cloud archive, first use `rclone config` to set up a `swift` backend with OVH, choosing `pca` as the `storage_policy`.
#### Uploading Objects ####
### Uploading Objects
Uploading objects to OVH cloud archive is no different to object storage, you just simply run the command you like (move, copy or sync) to upload the objects. Once uploaded the objects will show in a "Frozen" state within the OVH control panel.
#### Retrieving Objects ####
### Retrieving Objects
To retrieve objects use `rclone copy` as normal. If the objects are in a frozen state then rclone will ask for them all to be unfrozen and it will wait at the end of the output with a message like the following: