odrive

The odrive Developer Hub

Welcome to the odrive developer hub. You'll find comprehensive guides and documentation to help you start working with odrive as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Advanced client options

INTRODUCTION

There are two files located in the root of the odrive folder that can be used for advanced configuration.

odrive_user_general_conf.txt - The configuration items in this file are available to all users.

odrive_user_premium_conf.txt - The configuration items in this file are available to Premium subscribers.

🚧

Important Note:

The default settings are intended to satisfy the needs of the vast majority of odrive users and should not be modified in most cases. Deviating from the defaults can create issues with odrive functionality and performance if they are set incorrectly, or beyond acceptable thresholds.

If your version of the configuration file(s) do not have all of the listed features, make sure you are running the latest version of odrive. If you are, delete the current configuration files and then restart odrive. This will regenerate them.

To make changes to the advanced settings:
  • Open up the desired file in a text editor
  • Change the value of the parameter you want to modify
  • Save the file
  • Restart odrive (only needed for settings to take effect on older client versions)

GENERAL SETTINGS

odrive_user_general_conf.txt

ignoreSizeMismatch

default: false

odrive has an extra check on download to make sure that the downloaded file size matches what the remote storage is reporting. If it doesn’t match, odrive will abort the download. Unfortunately some storage providers have been seen to misreport proper file sizes, preventing the affected file from ever reaching your system. In this case you will get an error pop-up indicating that there was a size mismatch. If you continue to get this error for specific files, you may need to temporarily enable this feature to get past the error.

To enable, change the default value of 'false' to 'true'.

maxDownloadRetries

default: 3

odrive will transparently retry file downloads for transient errors. This setting can be used to adjust the number of retries attempted before giving up.

Change the default value of '3' to your desired number.

allowOldDownload

default: false

By default the odrive client will not automatically download and replace a local file if the remote file is seen as an older version. This behavior was added to address issues where users were inadvertently copying older files on top of newer files and then those were distributed to everyone who was sharing that storage. We've found that users rarely ever want to overwrite a newer file with an older one, but it can happen accidentally and cause data loss if the remote storage does not support versioning.

When a scenario where an older remote file is detected, that remote file will be held in the "not allowed" queue.

To enable behavior where older files will overwrite newer local files, change the default value of 'false' to 'true'

supressTrashNotifications

default: false

odrive will display a notification when local items have been detected as deleted and are being held in the odrive trash. This setting can be used to disable these notifications.

To enable, change the default value of 'false' to 'true'

localScanIntervalSecs

*default: 3600 or 1200

This setting can be used to change the interval at which odrive periodically scans for local changes. The default is 3600 seconds (60 minutes) in the odrive desktop clients and 1200 seconds (20 minutes) in the odrive agents. This should not need to be changed in most circumstances.

Change the default value to your desired number.

disableFSEvents

default: false

odrive utilizes filesystem events to help detect local changes. The events are sent to odrive from the operating system and provide notification of adds, deletes, moves, and updates. This provides the ability for odrive to react quickly to changes and ensure that your data is uploaded as quickly as possible.

There are some scenarios where it may be helpful to disable these filesystem events. If disabled, odrive will rely on periodic scans of the local filesystem to detect changes. Some scenarios where this can be useful is during bulk operations, to reduce event feedback, or in cases where a user is rapidly making and saving file edits causing odrive to upload more frequently than desired. To account for the lack of immediate events, you may also want to adjust the localScanIntervalSecs option to a lower number, like 600 (10 minutes).

disableSparse

default: false

Sparse files are a special file type that allows native representation of file size without taking up actual disk space. odrive utilizes sparse files for placeholders, which allows the remote file size to be listed locally while still maintaining zero impact on the local disk space.

Disabling sparse files will revert to the previous placeholder behavior, where placeholders are shown as 0 bytes instead of representing the remote size. This change is not retroactive, so any placeholders that were already created using the new method will still show size and vice-versa.

To disable, change the default value of 'false' to 'true'

disableAutoupdateRestart

default: false

When the sync app detects that an autoupdate is available, it will download the update and restart the app immediately to apply the update. Disabling the autoupdate restart will still result in the update being downloaded, but the app will not restart itself to apply the update. The update is applied when the app next restarts (either by user action or after a reboot, etc.).

processMemoryLimitMBytes

default: 3584

Over time the odrive app may accumulate a fair amount of memory overhead when dealing with large scale repositories and operations. This settings acts as a "release valve" if the memory pressure exceeds the set value. The vast majority of users will never encounter this, but this can be useful for those that are dealing with extremely large datasets or performing very large bulk operations.

Important Note: Setting this value too low can hinder odrive's ability to function correctly.

PREMIUM SETTINGS

odrive_user_premium_conf.txt
PREMIUM FEATURE

The settings below require a premium subscription to work.

backupIntervalMinutes

default: 1440

Backup jobs run daily by default. You can change the setting to some other value in minutes, if desired. This time interval is the time between when a backup job run finishes and the next run is kicked off.

backupDisableMerge

default: false

Set this to true to prevent setting a backup destination folder that is not empty.

blackListContains, blackListExtensions, blackListNames, blackListPrefixes

These settings allow you to specify custom blacklist patterns for files and folders. Please see https://docs.odrive.com/docs/sync-changes#section-custom-ignore-list-blacklist for more information.

forgetEncPassphrase

default: false

By default, odrive will save your Encryptor passphrases locally in the client (your passphrase is never transmitted to any remote server) so that you do not need to enter them whenever odrive starts. This setting can be used to disable saving the Encryptor passphrase when you are requested to enter it for Encryptor folders. If enabled, you will need to enter the passphrase every time odrive is started and you want to access your encrypted content.

To enable, change the default value of 'false' to 'true'

initialUploadBatchSize, maxConcurrentDownloads, maxConcurrentJobs, maxConcurrentUploads, maxTransferMBytes

These settings allow you to tweak the upload and download behavior of your odrive client.

initialUploadBatchSize

default: 1

This setting represents the initial number of files that odrive will attempt to upload concurrently. The default value is 1. odrive will upload the number defined, analyze its performance, and then scale-up when appropriate. This setting can be used for large file uploads on high-speed, high-bandwidth network connections to prevent the need to wait for a single large file to finish uploading before scaling up. The maxConcurrentUploads and maxTransferBytes settings may need to be adjusted to coincide with changes to this setting, as well.

Change the default value of '1' to your desired number.

maxConcurrentDownloads

default: 4

This setting represents the maximum number of concurrent downloads in a "job" (there can be multiple jobs, depending on what the maxConcurrentJobs setting is and how odrive has processed your requests). For example, a right-click->sync action on a folder to recursively download that folder is considered one "job".

Change the default value of '4' to your desired number.

maxConcurrentUploads

default: 4

This setting represents the maximum number of concurrent uploads in a "job" (there can be multiple jobs, depending on what the maxConcurrentJobs setting is and how odrive has processed your requests). Generally, jobs are allocated to mounts and directory structures. For example, adding a new folder (with files and folders underneath) will usually be processed as one "job".

Change the default value of '4' to your desired number.

maxConcurrentJobs

default: 4

This setting represents the maximum number of "jobs" that can run concurrently. A job is generally associated with a upload or download action within a single mount (sync to odrive) or folder heiracrchy. Each refresh job has its own upload/download limits, as defined by the 'maxConcurrentUploads' and 'maxConcurrentDownloads' settings. This setting can be used, for example, to restrict the total number of jobs to 1 to guarantee that you can only have one total concurrent upload, globally.

Change the default value of '4' to your desired number.

maxTransferMBytes

default: 256

This setting represents the maximum size (in MB) allowed for concurrent transfers. Uploads and downloads are counted separately. This option is used by odrive to keep large file transfers under control. Users who have access to very high-speed, very high-bandwidth connections may want to increase this. Conversely, users with very low-bandwidth or very low-speed connections may want to reduce this.

Change the default value of '256' to your desired number.

Updated about 6 hours ago

Advanced client options


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.