The article contains a list of all options available for configuration in LucidLink filespaces.
Not all options are available for all plans. Some options can only be configured via CLI and are marked accordingly. Settings not exposed via the user interface are generally considered advanced options and should be adjusted with care.
Lucid Config
All filespace settings can be configured through the following Terminal command:
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 adminPassword]
lucid config --set --global --KEY1 VALUE1 [--KEY2 VALUE2 ...] [--password adminPassword]
lucid config --delete [--local] --KEY1 [--KEY2 ...] [--password adminPassword]
lucid config --delete --global --KEY1 [--KEY2 ...] [--password adminPassword]
Set local or global scope filespace configurations
Options:
--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 An admin user's password. Used with --global and --local options
--list Display the configuration settings per scope
--no-trim Do not trim long configuration values
--explain Describe what each configuration key affects within Lucid and list its value constraints. Can be used with --KEY
Configuration keys:
--Audit.FsEvents [value] Flag denoting whether the audit log for filesystem events is enabled. The option must always be preceded by the '--global' option.
--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 25GiB. 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.
--FileStore.StuckStateInterval [value] The Stuck State Interval represents the length of time that has elapsed since the last known activity observed for that unique upload. Once this interval has been reached, the visible icon indicating an upload is in progress will change to indicate that there is a problem with that upload. Default value is 7200 seconds (2 hours).
--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 are not compatible with Windows. These are names containing a special character \/:*?"<>| , have a trailing space or dot or represent a reserved name on Windows. Since Lucid version 2.0.3633, this setting is set globally to 1 upon Filespace initialization
--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 admin privileges.
--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.
--RemoteKeystore.MetadataUpdatesTimeout [value] File index sync request timeout. The default is 120 (2 min).
Settings keys and descriptions
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 --explain
Key names:
Key: Audit.FsEvents
Description: Flag denoting whether the audit log for filesystem events is enabled. The option must always be preceded by the '--global' option.
Value constraints: Boolean flag, 0 - False (default), 1 - True
Default value: 0
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)
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 locally attached USB 3.0 or greater, or SSD or NVMe drive formatted as APFS or NTFS. macOS typically mounts devices at "/Volumes/". Windows devices can be accessed by Drive Letter, for example: "E:\".
Default value:
Key: DataCache.Size
Description: Local data cache size. The default is 25GiB. 80% of the size is available for pinning.
Value constraints: Min 100MiB. Max 10TiB. Supported units: M(iB), G(iB), T(iB).
Default value: 25GiB
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: FileStore.StuckStateInterval
Description: The Stuck State Interval represents the length of time that has elapsed since the last known activity observed for that unique upload. Once this interval has been reached, the visible icon indicating an upload is in progress will change to indicate that there is a problem with that upload. Default value is 7200 seconds (2 hours).
Value constraints: Min 1 second. Max 2,592,000 seconds (30 days).
Default value: 7200
Key: FileSystem.DefaultMountPointScheme
Description: Determines where the filespace will be mounted when no mount point is explicitly provided.
Value constraints: 'UserHome' or 'GenericVolume' or 'SystemPath'
Default value: UserHome
Key: FileSystem.ForbidSpecialCharacters
Description: Forbid creating file names which are not compatible with Windows. These are names containing a special character \/:*?"<>| , have a trailing space or dot or represent a reserved name on Windows. Since Lucid version 2.0.3633, this setting is set globally to 1 upon Filespace initialization
Value constraints: 0 = allow special characters and filenames, 1 = forbid special characters and filenames
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: indd,idlk,dbl,dwl,dwl2,dwt,dwg,ppt,pptx,xls,xlsx,doc,docx,rvt,revit:dat
Key: FileSystem.MaxFsEntries
Description: Maximum number of entries (files + directories + symlinks). The option must always be preceded by the '--global' option. Setting it to 0 removes the limit.
Value constraints:
Default value: 0
Key: FileSystem.MaxFsSize
Description: Sets the maximum file system size. The option must always be preceded by the '--global' option. Setting it to 0 removes the limit.
Value constraints: Supported units: B, MB, GB, TB.
Default value: 0B
Key: FileSystem.MaxStorageSize
Description: Sets the maximum object storage consumed by user data. The option must always be preceded by the '--global' option. Setting it to 0 removes the limit.
Value constraints: Supported units: B, MB, GB, TB.
Default value: 0B
Key: FileSystem.MountPointLinux
Description: Linux only. Path which will be used as a mount point.
Value constraints: Valid absolute path (e.g. "/media/domain/filespace").
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/domain/filespace").
Default value:
Key: FileSystem.MountPointWindows
Description: Windows only. Path which will be used as a mount point and drive letter.
Value constraints: Specify a full folder path (e.g. C:\Volumes\domain\filespace), a drive letter (e.g. L:), or a network path (limited support: e.g. \\lucid\filespace or \\lucid\filespace;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 admin privileges.
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
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: 60
Keys 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.
Examples
Add txt file locking extension (default rvt,dwl,dwl2,dwt,dwg,pptx,xlsx,doc,docx):
lucid config --set --global --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 32 (default 64):
lucid config --set --local --ObjectScheduler.MaxDownloadConns 32
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
Enable special characters for the filespace:
lucid config --set --global --FileSystem.ForbidSpecialCharacters 0
Please reach out to LucidLink Support should you require any further assistance.