Difference between revisions of "StableBit CloudDrive Advanced Settings"

From Covecube - Wiki
Line 1: Line 1:
== CloudDrive.Service.config ==
 
 
You can tweak advanced settings in Stablebit CloudDrive by editing a .config file in notepad.
 
 
The file is located in '''C:\Program Files\StableBit\CloudDrive\CloudDrive.Service.exe.default.config'''.
 
 
In order to put the file into effect, you will need to rename the .config file to '''CloudDrive.Service.exe.config''' and restart the StableBit CloudDrive system service (or reboot).
 
 
Any time you upgrade, or reinstall CloudDrive, it writes an updated "default" config file, but leaves the current "CloudDrive.Service.exe.config" alone so it doesn't alter any of your settings.
 
 
=== Editing the config file ===
 
Open the file in notepad. You will see an XML formatted file. If you're not familiar with XML then all that you need to know is that the values that you can change look like this:
 
 
<value>'''True'''</value>
 
 
You can change this line to:
 
 
<value>'''False'''</value>
 
 
The setting name is right above that line:
 
 
<setting name="'''CoveFsLogSizeMB'''" serializeAs="String">
 
 
In this case the name is ''CoveFsLogSizeMB''.
 
 
There are also numerical values and time values.
 
 
 
== Settings.json ==
 
== Settings.json ==
  

Revision as of 20:37, 23 February 2018

Settings.json

In the newer versions, we've depreciated the config file and have moved over to a JSON file. There are a number of reasons for this, but the best is that we include the default values here, as well.

The file is located in C:\ProgramData\StableBit CloudDrive\Service\Settings.json. Note that this file is in "ProgramData", and not "Program Files". This folder is hidden by default, so you must type in the path, or enable "Show Hidden Files" in Windows Explorer.

Editing

Open the file in notepad. You'll see a JSON formatted file.

if you're not familiar with editing a JSON file, then you just edit the value for "Override", rather than the "Default" value. This will allow you to easily revert values to the default, by changing the override back to "null".

For instance, the default settings may look like this:

 "BitLocker_CloudPartUnlockDetect": {
   "Default": true,
   "Override": null
 },

The default value means that whichever value is enabled by default. If you change the "null" in the override line to "false" and save the file, it will disable the setting in the future:

 "BitLocker_CloudPartUnlockDetect": {
   "Default": true,
   "Override": false
 },

This example would disable the BitLocker pool detection feature, meaning that you may need to manually restart the service to detect unlocked drives.

Settings

Settings are organized by function.

AmazonCloudDrive

  • AmazonCloudDrive_ClientId - Override the client ID to use with Amazon Cloud Drive.
  • AmazonCloudDrive_ClientSecret - Override the client secret to use with Amazon Cloud Drive.

BitLocker

  • BitLocker_CloudPartUnlockDetect (Default: "True") - Adds support for BitLocker encrypted StableBit CloudDrive cache drives. You must still manually unlock the drives, unless the system disk is also encrypted and configured to auto-unlock the other drives. This does cause the software to periodically "ping" the disk (this happens via WMI and not our software, directly).

ChunkId

  • ChunkId_MemoryLimit - The amount of memory (RAM) to use for caching chunk IDs (for providers that don't have a way of downloading files by file name).
  • ChunkId_RequeryOnVerify - This will requery for the Chunk ID when verifying chunks. This is off by default.

CloudDrive

  • CloudDrive_CultureOverride - Overrides the UI culture setting. When set, text will appear in a different language than your OS culture. Set to a culture string such as "de", "es", "fr", etc... This works with remote control as well. When connecting to a StableBit CloudDrive machine with an overridden culture, the UI on the connecting machine will be in the overridden culture.
  • CloudDrive_PingHost - The IP to ping in order to determine if there is an Internet connection available. StableBit CloudDrive will delay service startup and cloud drive mounting until there is an Internet connection available.
  • CloudDrive_ServiceLoggingEnabled - Enables normal service logging, such as remote control info, cloud provider I/O info, etc...
  • CloudDrive_WaitForInternetS - How long to wait for an Internet connection to become available before allowing the service to complete startup and mount the first cloud drive (set to 0 to start immediately and not wait).

CloudFsDisk

  • CloudFsDisk_IsDriveRemovable - Causes the CloudDrive disks to be marked as removable drives, and exposes the "Removal Policy" tab in Device Manager. This is enabled by default.
  • CloudFsDisk_IsQuickRemoval - Controls whether the drive is set to "Quick Removal" or "Better performance" in the "Removal Policy" tab in Device Manager. This is enabled by default.
  • CloudFs_LogSizeMB - The binary kernel log size. 100MB can be from a few minutes to 10 minutes worth of logs, depending on I/O activity. The kernel binary log records every operation on the cloud drive in a high performance and compact log file.
  • CloudFsDisk_MaximumConsecutiveIoFailures - This setting controls how many unrecoverable I/O failures can occur before the drive is forcifully unmounted from the system. Increasing or disabling this setting can cause issues where the system may hang/lock up, as Windows will wait on the I/O to finish. The window for these errors is 120 seconds, and if this time is exceeded without an error, the count is reset. The default value for this is "3".
  • CloudFsDisk_Tracing - When set to True, kernel driver tracing will be enabled by default at all times. Tracing logs are written to %ProgramData%\StableBit CloudDrive\Service\Logs\CloudFsDisk. They are written in a binary format and can be submitted to technical support for analysis.
  • CloudFs_TracingFlushS - This sets flush to disk the interval. 0 will flush on every trace.


CreateDrive

  • CreateDrive_AllowCacheOnDrivePool - Allows the cache to be created on a DrivePool disk. Default behavior is to exclude Pool drives, due to the fact that the cache files will always be locked and will not be rebalanced, nor can be duplicated if real time duplication is disabled.

DeleteCloudDrive

  • DeleteCloudDrive_Retries - How many times to retry deleting a cloud drive's metadata and data when an error is encountered.

FTP

  • Ftp_DefaultMaximumConnections - Sets the default maximum number of connections for the FTP provider.

IoManager

  • IoManager_DefaultConnectionLimit - The maximum number of simultaneous HTTP connections that the service is allowed to create.
    • Clarification needed.
  • IoManager_DefaultMaximumReadAggregation - Sets the maximum read I/O aggregation for providers that don't explicitly define one.
  • IoManager_HttpConnectionTimeoutMS - The maximum allowed duration of an HTTP connection in MS. The duration is calculated from the time that a connection is attempted until the final response is received.
  • IoManager_HttpReadWriteTimeoutMS - The maximum allowed duration of an HTTP upload / download in MS.
  • IoManager_ReadAbort - Maximum amount of time that a read thread is allowed to run before the thread is aborted (this is a secondary safety measure, if the timeout fails).
  • IoManager_ReadRetries - How many times to retry provider reads before returning an error to the disk.
  • IoManager_ReadThreads - The default number of read threads when creating a new cloud drive, unless overridden by the provider.
  • IoManager_ThrottlingCatchupS - The set limit for the I/O Manager can now be temporarily exceeded in order to "catch up" due to a previous slow down. Set to 0.0 to disable.
  • IoManager_UseHttpCompression - Set to True to use HTTP compression, set to False otherwise.
  • IoManager_WriteAbort - Maximum amount of time that a write thread is allowed to run before the thread is aborted (this is a secondary safety measure, if the timeout fails).
  • IoManager_WriteRetries - How many times to retry provider reads before giving up and showing an error to the user.
  • IoManager_WriteThreads - The default number of write threads when creating a new cloud drive, unless overridden by the provider.

LocalIo

  • LocalIo_ReleaseHandlesDelayMS - For the Local Disk provider and the File Share provider, how long to wait (in MS) after the last provider I/O call before closing all of the handles to the provider's data.

PinDiskMetadata

  • PinDiskMetadata_IntervalM - This sets how often to check for file system metadata changes when pinning data to the local cache, in minutes.

RemoteControl

  • RemoteControl_Port - Specifies the port used by StableBit CloudDrive for remote management.
  • RemoteControl_MulticastGroupIp - The multicast group IP to use for peer discovery.
  • RemoteControl_MulticastGroupPort - The multicast group port to use for peer discovery.
  • RemoteControl_MulticastTimeToLive - Controls the number of "hops" the remote control packets will travel before being dropped, to prevent the network from being flooded.
  • RemoteControl_StaticPeerSeekTime - How often to check whether an offline static peer has gone online.

ValidateLogins

  • ValidateLogins_MaxDegreeOfParallelism - When first starting StableBit CloudDrive, how many threads to use in order to validate your existing login credentials.
  • ValidateLogins_Timeout - Sets the timeout length that the software will wait for a response when waiting for the provider to respond to refreshing credentials.

WholeChunkIoImplementation

  • WholeChunkIoImplementation_PartialWriteAggregationMS - When a cloud provider doesn't support writing partial chunks (which is very common), we aggregate partial shared write requests into a master chunk write request. This is a very complicated optimization and you shouldn't change this value unless instructed to do so by technical support.

Don't forget to rename the config file after you make the change and restart the server (or service), as noted at the top of this page.

RemoteControl.xml

Allows you to configure some of the settings for the Remote Control features of the CloudDrive User Interface.

The file is located in C:\Program Files\StableBit\CloudDrive\RemoteControl.default.xml on the server.

In order to put the file into effect, you will need to rename it to RemoteControl.xml and restart the server (or just restart the StableBit CloudDrive system service).

Any time you upgrade, or reinstall CloudDrive, it writes an updated RemoteControl.default.xml file, so it will include any updated settings but leaves the current RemoteControl.xml alone so it doesn't alter any of your settings.

MulticastDiscovery

This setting is configured to be "enabled" by default, so that the User Interface will automatically find clients. However, you can set the value to "False" and this will only list entries that you have manually added to the "Peer" list.

The setting should look like this:

<MulticastDiscovery Enabled="True" />

Peers

The Peers Section allows you to specify a list of computers that you want available, in cases such as a specific computer isn't picked up by the automatic discovery, or if you want to disable automatic discovery and manually list the computers available.

All clients must be running the same version of CloudDrive, and you must have any additional balancer Plugins installed as well.

Peer

You need to manually create an entry for each computer to be added. You can use the computer's host/DNS name, or the IP address, and you can specify a different port (if the service is configured for that, see Control above).


<Peer>192.168.0.123</Peer>
<Peer>STORAGESERVER</Peer>
<Peer>192.168.0.123:27515</Peer>
<Peer>STORAGESERVER:27515</Peer>


Don't forget to rename the config file after you make the change and restart the server (or service), as noted at the top of this page.