A LucidLink Filespace provides multiple configuration parameters applicable both locally or globally across all clients participating in the global namespace. 

While in most circumstances the defaults are sufficient, it is important to understand the many configurable options built into our service.

The control panel enables the configuring of your frequently administered Filespace settings including your Users, Shares, Local and Global operating system client settings. 

Managing Filespace Users, administering their Shares and setting up point-in-time Snapshots are covered in separate knowledge base articles. In this article we will focus specifically on settings.

Locate the LucidLinklogo within the Taskbar to access the control panel. Type your password and select Open control panel.

Each setting option within the control panel is accompanied by an informationtooltip to provide guidance and a detailed explanation on the setting's function.

Typical operations are:

  • Set the location your Filespace is mounted
  • Increase or decrease cache size
  • Tune your parallel upload and download connection counts
  • Apply download and upload transfer rates to suit available bandwidth
  • Adjust file locking file extension types
Please reach out to LucidLink Support for guidance and make changes carefully as the performance of your Filespace or network could be affected by incorrectly set parameters.

When logged in as Root you will have access to the full control panel including Users, Shares, along with Local and Global settings.

Global settings will be used as defaults for all machines connecting to this Filespace. Changing some settings may require machines to reconnect to the Filespace in order to take effect.

Note that users may still override their local settings.

Logged in as a regular User will present you with options to change only the local LucidLink client settings for your current machine, not Global settings or Users and Shares.

Local settings will affect this machine only. Changing some settings may require a reconnect to the Filespace in order to take effect.

Advanced Filespace configuration

Lucid config command-line interface provides far more detailed administration of your Filespace than what is available in control panel.

Make changes carefully as the performance of your Filespace or network could be affected by incorrectly set parameters.
lucid config

Outputs the effective, configured, scope and status of each config key.

Usage:

lucid config --list [--effective]
lucid config --list --local
lucid config --list --global
lucid config --explain [--KEY1 --KEY2 ...]
lucid config --set [--local] --KEY1 VALUE1 [--KEY2 VALUE2 ...] [--password rootPassword]
lucid config --set --global --KEY1 VALUE1 [--KEY2 VALUE2 ...] [--password rootPassword]
lucid config --delete [--local] --KEY1 [--KEY2 ...] [--password rootPassword]
lucid config --delete --global --KEY1 [--KEY2 ...] [--password rootPassword]

Set local or global scope filespace configurations

Options:

    --list                   Display the configuration settings per scope
    --effective              Currently effective filespace configurations for this client
    --local                  Local configurations scope. Affects only client where setting is applied
    --global                 Global configurations scope. Affects each client that connects to the filespace unless overridden with --local for a particular client
    --set                    Set configuration key(s). Defaults to `local` scope
    --delete                 Delete configuration key(s). Defaults to `local` scope
    --password password      Root user's password. Used with --global and --local options
    --explain                Describe what each configuration key affects within Lucid and list its value constraints. Can be used with --KEY

Configuration keys:

    --Compressor.Concurrency [value] Maximum parallel compression/decompression tasks (0 means auto).
    --Compressor.DestageThreshold [value] The threshold block size in bytes, at which blocks get destaged for parallel execution.
    --Compressor.Enabled [value] Turns compression on and off.
    --Compressor.Lz4Acceleration [value] Controls compression ratio vs. compression speed. 1 means maximum data compression (takes more resources on the local machine but reduces the network traffic).
    --CryptoStore.Concurrency [value] Maximum parallel encryption/decryption tasks (0 means auto).
    --CryptoStore.DestageThreshold [value] The threshold block size in bytes, at which blocks get destaged for parallel execution.
    --DataCache.Size [value] Local data cache size. The default is 5GB. Configuration will be applied after the client reconnects to the filespace.
    --FileStore.MemCacheSize [value] In-memory data cache size. The default is 64MiB.
    --FileSystem.DefaultMountPointScheme [value] Determines where the filespace will be mounted when no mount point is explicitly provided.
    --FileSystem.LockingExtensions [value] Windows only. File extensions for which locking will be applied on open.
    --FileSystem.MountPointLinux [value] Linux only. Path which will be used as a mount point.
    --FileSystem.MountPointOSX [value] macOS only. Path which will be used as a mount point.
    --FileSystem.MountPointWindows [value] Windows only. Path which will be used as a mount point and drive letter.
    --FileSystem.WindowsPermissions [value] Windows only. Enable or disable Windows NTFS permissions. Requires root permissions.
    --ObjectScheduler.GetLatencyHighAlert [value] GET request latency high alert threshold in milliseconds.
    --ObjectScheduler.GetLatencyLowAlert [value] GET request latency low alert threshold in milliseconds.
    --ObjectScheduler.GetLatencyMediumAlert [value] GET request latency medium alert threshold in milliseconds.
    --ObjectScheduler.MaxDownloadConns [value] Maximum parallel download connections - object store to client.
    --ObjectScheduler.MaxDownloadRate [value] Maximum download rate in bytes/s - object store to client. The default is unlimited.
    --ObjectScheduler.MaxUploadConns [value] Maximum parallel upload connections - client to object store.
    --ObjectScheduler.MaxUploadRate [value] Maximum upload rate in bytes/s - client to object store. The default is unlimited.
    --ObjectScheduler.PutLatencyHighAlert [value] PUT request latency high alert threshold in milliseconds.
    --ObjectScheduler.PutLatencyLowAlert [value] PUT request latency low alert threshold in milliseconds.
    --ObjectScheduler.PutLatencyMediumAlert [value] PUT request latency medium alert threshold in milliseconds.

A detailed explanation of what each configuration Key affects and list their default values or constraints can be retrieved via --explain option.

lucid config --explain

Key names:

Key:               Compressor.Concurrency
Description:       Maximum parallel compression/decompression tasks (0 means auto).
Value constraints: Integer between 0 and 1024
Default value:     0

Key:               Compressor.DestageThreshold
Description:       The threshold block size in bytes, at which blocks get destaged for parallel execution.
Value constraints: Integer between 1 and 2^32 - 1
Default value:     1024

Key:               Compressor.Enabled
Description:       Turns compression on and off.
Value constraints: 0 = disabled, 1 = enabled
Default value:     1

Key:               Compressor.Lz4Acceleration
Description:       Controls compression ratio vs. compression speed. 1 means maximum data compression (takes more resources on the local machine but reduces the network traffic).
Value constraints: Integer between 1 and 100
Default value:     1

Key:               CryptoStore.Concurrency
Description:       Maximum parallel encryption/decryption tasks (0 means auto).
Value constraints: Integer between 0 and 1024
Default value:     0

Key:               CryptoStore.DestageThreshold
Description:       The threshold block size in bytes, at which blocks get destaged for parallel execution.
Value constraints: Integer between 1 and 2^32 - 1
Default value:     1024

Key:               DataCache.Size
Description:       Local data cache size. The default is 5GB. Configuration will be applied after the client reconnects to the filespace.
Value constraints: Min 100MB. Max 1TB. Supported units: MB, GB, TB.
Default value:     5GiB

Key:               FileStore.MemCacheSize
Description:       In-memory data cache size. The default is 64MiB.
Value constraints: Set to 0 to disable in-memory cache. Max 1TiB. Supported unit suffixes: M(iB), G(iB).
Default value:     64MiB

Key:               FileSystem.DefaultMountPointScheme
Description:       Determines where the filespace will be mounted when no mount point is explicitly provided.
Value constraints: 'UserHome' or 'GenericVolume'.
Default value:     UserHome

Key:               FileSystem.LockingExtensions
Description:       Windows only. File extensions for which locking will be applied on open.
Value constraints: Comma separated e.g. ("docx,pptx,rvt"). Empty string disables file locking.
Default value:     rvt,dwl,dwl2,dwt,dwg,pptx,xlsx,doc,docx

Key:               FileSystem.MountPointLinux
Description:       Linux only. Path which will be used as a mount point.
Value constraints: Valid absolute path (e.g. "/media/myfilespace").
Default value:     

Key:               FileSystem.MountPointOSX
Description:       macOS only. Path which will be used as a mount point.
Value constraints: Valid absolute path (e.g. "/Volumes/myfilespace").
Default value:     

Key:               FileSystem.MountPointWindows
Description:       Windows only. Path which will be used as a mount point and drive letter.
Value constraints: Valid absolute path and semicolon separated drive letter (e.g. "\\lucid\myfilespace;L:").
Default value:     

Key:               FileSystem.WindowsPermissions
Description:       Windows only. Enable or disable Windows NTFS permissions. Requires root permissions.
Value constraints: 0 = disabled, 1 = enabled.
Default value:     1

Key:               ObjectScheduler.GetLatencyHighAlert
Description:       GET request latency high alert threshold in milliseconds.
Value constraints: Integer between 1 and 60000
Default value:     10000

Key:               ObjectScheduler.GetLatencyLowAlert
Description:       GET request latency low alert threshold in milliseconds.
Value constraints: Integer between 1 and 60000
Default value:     2500

Key:               ObjectScheduler.GetLatencyMediumAlert
Description:       GET request latency medium alert threshold in milliseconds.
Value constraints: Integer between 1 and 60000
Default value:     5000

Key:               ObjectScheduler.MaxDownloadConns
Description:       Maximum parallel download connections - object store to client.
Value constraints: Integer between 1 and 1000
Default value:     64

Key:               ObjectScheduler.MaxDownloadRate
Description:       Maximum download rate in bytes/s - object store to client. The default is unlimited.
Value constraints: Integer. Supported units: KB, MB, GB, TB
Default value:     unlimited

Key:               ObjectScheduler.MaxUploadConns
Description:       Maximum parallel upload connections - client to object store.
Value constraints: Integer between 1 and 1000
Default value:     64

Key:               ObjectScheduler.MaxUploadRate
Description:       Maximum upload rate in bytes/s - client to object store. The default is unlimited.
Value constraints: Integer. Supported units: KB, MB, GB, TB
Default value:     unlimited

Key:               ObjectScheduler.PutLatencyHighAlert
Description:       PUT request latency high alert threshold in milliseconds.
Value constraints: Integer between 1 and 60000
Default value:     15000

Key:               ObjectScheduler.PutLatencyLowAlert
Description:       PUT request latency low alert threshold in milliseconds.
Value constraints: Integer between 1 and 60000
Default value:     5000

Key:               ObjectScheduler.PutLatencyMediumAlert
Description:       PUT request latency medium alert threshold in milliseconds.
Value constraints: Integer between 1 and 60000
Default value:     10000

Each key can be applied across the entire Filespace, all clients participating within the Filespace using --global or locally applied to current client instance with --local.

Certain operations are effective immediately, others applied when the Filespace is next activated.
Global operations require root password.

Add txt file locking extension (default rvt,dwl,dwl2,dwt,dwg,pptx,xlsx,doc,docx) to local instance:

lucid config --set --local --FileSystem.LockingExtensions rvt,dwl,dwl2,dwt,dwg,pptx,xlsx,doc,docx,txt

Confirm effective configuration:

lucid config --effective

List local settings:

lucid config --list --local

List global settings:

lucid config --list --global

Increase parallel download connection count to 128 (default 64):

lucid config --set --local --ObjectScheduler.MaxDownloadConns 128

Limit local download rate to 1MB (default unlimited):

lucid config --set --local --ObjectScheduler.MaxDownloadRate 1M

Set global download rate to unlimited (default):

lucid config --set --global --ObjectScheduler.MaxDownloadRate 

Please reach out to LucidLink Support should you require any further assistance.