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, Filespace Groups, 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 LucidLink
logo 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 information tooltip to provide guidance and a detailed explanation of 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 the 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 --no-trim Do not trim long configuration values --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.Location [value] Change the location of your data cache. --DataCache.Size [value] Local data cache size. The default is 5GB. 80% of the size is available for pinning. --External.UpdateNotification [value] Enable or disable notifications for new versions of Lucid. --FileLockingGC.RetentionTime [value] The amount of time lucid service will wait disconnected clients, before collecting their file locks --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.ForbidSpecialCharacters [value] Forbid creating file names which contain a special character: \/:*?"<>| or one in the range 0-31 --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.MountPointWindowsLabel [value] Windows only. The label of the filespace drive. --FileSystem.RootPoint [value] Folder within the filespace to appear as the root folder. Path starts at the Lucid filespace root, not the local file system root. --FileSystem.WindowsPermissions [value] Windows only. Enable or disable Windows NTFS permissions. Requires root permissions. --GCScheduler.SoftMemoryLimit [value] Soft memory limit for the HUB process. The default is 400 MiB. --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. --PasswordComplexity.DifferentCaseRequired [value] At least one uppercase and one lowercase characters required. Defaults to 0 (not enforced). --PasswordComplexity.DigitRequired [value] At least one digit required. Defaults to 0 (not enforced). --PasswordComplexity.MinimumLength [value] Minimum password length required. Defaults to 1. --PasswordComplexity.NotContainUsername [value] The password is not allowed to contain the username. Defaults to 0 (not enforced). --PasswordComplexity.SpecialCharacterRequired [value] At least one special character required (e.g. !,$,#,%, etc.). Defaults to 0 (not enforced). --RemoteKeystore.MetadataUpdatesTimeout [value] File index sync request timeout. The default is 120 (2 min). --Sso.AppId [value] Application ID --Sso.OpenIdClientId [value] OpenID client ID configured for Lucid --Sso.OpenIdConnectUrl [value] OpenID Connect URL --Sso.Provider [value] The SSO provider
A detailed explanation of what each configuration Key affects and a list of their default values or constraints can be retrieved via the --explain option.
lucid config --explainKey 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.Location
Description: Change the location of your data cache.
Value constraints: A valid path to a folder on the local file system
Default value:
Key: DataCache.Size
Description: Local data cache size. The default is 5GB. 80% of the size is available for pinning.
Value constraints: Min 100MB. Max 10TB. Supported units: MB, GB, TB.
Default value: 5GiB
Key: External.UpdateNotification
Description: Enable or disable notifications for new versions of Lucid.
Value constraints: 0 = disabled, 1 = enabled.
Default value: 1
Key: FileLockingGC.RetentionTime
Description: The amount of time lucid service will wait disconnected clients, before collecting their file locks
Value constraints: A numeric value which will represent the duration in seconds
Default value: 60
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.ForbidSpecialCharacters
Description: Forbid creating file names which contain a special character: \/:*?"<>| or one in the range 0-31
Value constraints: 0 = allow special characters, 1 = forbid special characters
Default value: 0
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,xls,xlsx,doc,docx,indd,idlk
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.MountPointWindowsLabel
Description: Windows only. The label of the filespace drive.
Value constraints: A string with a maximum length of 32 characters
Default value: Lucid
Key: FileSystem.RootPoint
Description: Folder within the filespace to appear as the root folder. Path starts at the Lucid filespace root, not the local file system root.
Value constraints: Valid Lucid path (e.g. /dir1/dir2)
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: GCScheduler.SoftMemoryLimit
Description: Soft memory limit for the HUB process. The default is 400 MiB.
Value constraints: The value in bytes. Valid range: 1 MiB - 1 TiB.
Default value: 419430400
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
Key: PasswordComplexity.DifferentCaseRequired
Description: At least one uppercase and one lowercase characters required. Defaults to 0 (not enforced).
Value constraints: 0 = disabled, 1 = enabled.
Default value: 0
Key: PasswordComplexity.DigitRequired
Description: At least one digit required. Defaults to 0 (not enforced).
Value constraints: 0 = disabled, 1 = enabled.
Default value: 0
Key: PasswordComplexity.MinimumLength
Description: Minimum password length required. Defaults to 1.
Value constraints: Integer between 1 and 64.
Default value: 1
Key: PasswordComplexity.NotContainUsername
Description: The password is not allowed to contain the username. Defaults to 0 (not enforced).
Value constraints: 0 = disabled, 1 = enabled.
Default value: 0
Key: PasswordComplexity.SpecialCharacterRequired
Description: At least one special character required (e.g. !,$,#,%, etc.). Defaults to 0 (not enforced).
Value constraints: 0 = disabled, 1 = enabled.
Default value: 0
Key: RemoteKeystore.MetadataUpdatesTimeout
Description: File index sync request timeout. The default is 120 (2 min).
Value constraints: The timeout value in seconds. Valid range: 1 - 300 sec (5 min).
Default value: 120
Key: Sso.AppId
Description: Application ID
Value constraints: The application ID when different than the Client ID
Default value:
Key: Sso.OpenIdClientId
Description: OpenID client ID configured for Lucid
Value constraints: A unique identifier for Lucid generated by your Identity Provider
Default value:
Key: Sso.OpenIdConnectUrl
Description: OpenID Connect URL
Value constraints: The OpenID Connect URL
Default value:
Key: Sso.Provider
Description: The SSO provider
Value constraints: Supported providers: azure, okta
Default value: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 the 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
Forbid special characters (locally):
lucid config --set --FileSystem.ForbidSpecialCharacters 1
Please reach out to LucidLink Support should you require any further assistance.