Citrix ShareFile
At a glance
Section titled “At a glance”| Capability | Support |
|---|---|
| rclone support tier | Tier 5: Deprecated |
| Checksums | MD5 |
| Modification times | Kept, to 1 s |
| Case-insensitive names | No |
| Duplicate names allowed | No |
| Server-side copy | No |
| Server-side move and rename | No |
| Folder move and rename | No: each file is moved in turn |
| Free space reporting | No |
| Empty folders | No: folders exist only while they hold files |
| Change notifications | No |
| Uploads of unknown size | No |
| Public links | No |
Citrix ShareFile is a secure file sharing and transfer service aimed as business.
Setup notes
Section titled “Setup notes”In CloudMount you add this drive from the Add drive screen, and the wizard asks for the options listed under Options. The notes below come from rclone’s setup guide.
Modification times and hashes
Section titled “Modification times and hashes”ShareFile allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.
ShareFile supports MD5 type hashes, so you can use the --checksum
flag.
Transfers
Section titled “Transfers”For files above 128 MiB rclone will use a chunked transfer. Rclone will
upload up to --transfers chunks at the same time (shared among all
the multipart uploads). Chunks are buffered in memory and are
normally 64 MiB so increasing --transfers will increase memory use.
Restricted filename characters
Section titled “Restricted filename characters”In addition to the default restricted characters set the following characters are also replaced:
| Character | Value | Replacement |
|---|---|---|
| \ | 0x5C | ＼ |
| * | 0x2A | ＊ |
| < | 0x3C | ＜ |
| > | 0x3E | ＞ |
| ? | 0x3F | ？ |
| : | 0x3A | ： |
| | | 0x7C | ｜ |
| “ | 0x22 | ＂ |
File names can also not start or end with the following characters. These only get replaced if they are the first or last character in the name:
| Character | Value | Replacement |
|---|---|---|
| SP | 0x20 | ␠ |
| . | 0x2E | ． |
Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON strings.
Options
Section titled “Options”Standard options
Section titled “Standard options”The wizard asks for these when you add the drive.
client_id
Section titled “client_id”OAuth Client Id.
Leave blank normally.
Type: string
client_secret
Section titled “client_secret”OAuth Client Secret.
Leave blank normally.
Type: string
root_folder_id
Section titled “root_folder_id”ID of the root folder.
Leave blank to access “Personal Folders”. You can use one of the standard values here or any folder ID (long hex number ID).
Type: string
Choices:
(empty): Access the Personal Folders (default).favorites: Access the Favorites folder.allshared: Access all the shared folders.connectors: Access all the individual connectors.top: Access the home, favorites, and shared folders as well as the connectors.
Advanced options
Section titled “Advanced options”The wizard shows these under Advanced options. Most drives work without changing any of them.
OAuth Access Token as a JSON blob.
Type: string
auth_url
Section titled “auth_url”Auth server URL.
Leave blank to use the provider defaults.
Type: string
token_url
Section titled “token_url”Token server url.
Leave blank to use the provider defaults.
Type: string
client_credentials
Section titled “client_credentials”Use client credentials OAuth flow.
This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
Note that this option is NOT supported by all backends.
Type: bool · Default: false
upload_cutoff
Section titled “upload_cutoff”Cutoff for switching to multipart upload.
Type: SizeSuffix · Default: 128Mi
chunk_size
Section titled “chunk_size”Upload chunk size.
Must a power of 2 >= 256k.
Making this larger will improve performance, but note that each chunk is buffered in memory one per transfer.
Reducing this will reduce memory usage but decrease performance.
Type: SizeSuffix · Default: 64Mi
endpoint
Section titled “endpoint”Endpoint for API calls.
This is usually auto discovered as part of the oauth process, but can be set manually to something like: https://XXX.sharefile.com
Type: string
encoding
Section titled “encoding”The encoding for the backend.
See the encoding section in the overview for more info.
Type: Encoding · Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot
description
Section titled “description”Description of the remote.
Type: string
Limitations
Section titled “Limitations”Note that ShareFile is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”.
ShareFile only supports filenames up to 256 characters in length.
rclone about is not supported by the Citrix ShareFile backend. Backends without
this capability cannot determine free space for an rclone mount or
use policy mfs (most free space) as a member of an rclone union
remote.
See List of backends that do not support rclone about and rclone about.