Configure Filespace Settings

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

While in most circumstances the defaults are sufficient, it is important to understand the many configurable options are built into our service to improve both the performance and the overall experience while using LucidLink.

Those familiar with the filespace settings available in LucidLink Classic can find many of the same settings in the new LucidLink as of a product update released on March 19, 2025. The LucidLink web application provides this product update automatically with no action required on the part of the end user. If however you are running a version of the LucidLink 3.0 desktop client released prior to this date, please update your desktop client to the most current version available found here.

Managing Filespace Users, Filespace Groups, administering their Permissions, and setting up point-in-time Snapshots are covered in separate knowledge base articles. In this article, we will focus specifically on the filespace settings currently available in the new LucidLink.

Getting started with filespace settings

Open your LucidLink desktop client application, navigate to the LucidLink workspace needed, and select the relevant filespace from the list of available filespaces found on the left hand side of the client. You can then use the drop-down menu and select "Filespace settings" to access the available settings.

Administrator and standard user views

Depending on your user type, you will see a different representation of the filespace settings available to you. The account owner will see the administrator view, which provides general, global defaults and local settings tabs at the top. Settings can be adjusted here to suit specific workflow or environmental needs.

A standard user however, who does not have administrative privileges, has a more limited view of filespace settings, and can only adjust their own unique local settings.

Note that local settings, for both the account owner and the standard user, are only accessible from the LucidLink desktop client. The LucidLink web application provides the account owner the general and global defaults tab, but does not provide the local settings. The standard user does not have access to any settings in the web application, and is instead prompted to open the desktop client to make changes to their unique local settings.

Currently available filespace settings

The product update released on March 19, 2025 provides these commonly used settings directly in the desktop client and the web application (depending on the user type). More settings are available in LucidLink version 3.0 by using the command-line interface, explained in the section below.

Cache location This allows users to change the location of their LucidLink data cache. This setting is only available as a local setting, and can only be changed within the desktop client (i.e. not available within the web application)
Cache size This allow users to control the size of their local cache. The default is 25GiB, with 80% of the size available for pinning. The maximum cache size is 10TiB.
Mount point per OS (Windows, macOS, Linux) This defines the path which will be used as a mount point. (e.g. "/Volumes/domain/filespace" on macOS, C:\Volumes\domain\filespace or a drive letter (e.g. L:) on Windows)
ForbidSpecialCharacters (global-only) This setting allows an administrator to forbid or to allow creating file names which are not compatible with the Windows operating system. These are names containing a special character \/:*?"<>| , have a trailing space or dot, or represent a reserved name on Windows.
LockingExtensions (global-only) This setting defines which file types, as defined by their file type extension, allow for file-locking when that file type is open by an end user. Currently this feature is available only on the Windows operating system. Adobe InDesign, however, does support file locking on the macOS platform.

Advanced filespace configuration

The lucid3 config command-line interface provides far more detailed administration of your Filespace than what is currently available in "Filespace settings".

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

lucid3 config

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

Usage:

lucid3 config --list [--effective]
lucid3 config --list --local
lucid3 config --list --global
lucid3 config --explain [--KEY1 --KEY2 ...]
lucid3 config --set [--local] --KEY1 VALUE1 [--KEY2 VALUE2 ...] [--password adminPassword]
lucid3 config --set --global --KEY1 VALUE1 [--KEY2 VALUE2 ...] [--password adminPassword]
lucid3 config --delete [--local] --KEY1 [--KEY2 ...] [--password adminPassword]
lucid3 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)

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.

lucid3 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, M(iB), G(iB), T(iB).
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, M(iB), G(iB), T(iB).
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

Each key can be applied across all clients participating in the filespace, by using --global or locally applied only to the current client instance with --local.

Global operations require the root (or admin) password. Certain operations are effective immediately, while others are only applied when the filespace is next activated.

Examples:

Add txt to the file locking extension list (globally):

default: rvt,dwl,dwl2,dwt,dwg,pptx,xlsx,doc,docx

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

Confirm effective configuration:

lucid3 config --effective

List local settings:

lucid3 config --list --local

List global settings:

lucid3 config --list --global

Increase local parallel download connection count to 32 (default 64):

lucid3 config --set --local --ObjectScheduler.MaxDownloadConns 32

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

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

Set global download rate to unlimited (default):

lucid3 config --set --global --ObjectScheduler.MaxDownloadRate

Forbid special characters (locally):

lucid3 config --set --FileSystem.ForbidSpecialCharacters 1

Should you require any further assistance, please reach out to LucidLink Support.

Configure Filespace Settings

Was this article helpful?