Share feedback
Answers are generated based on the documentation.

Filesystem mount rule syntax

Filesystem mount rules make up organization filesystem access policies. Each rule lists host paths that sandboxes can mount as workspaces, and the access it allows or denies on them: read, write, or both. To add rules to a policy, see Create and manage organization policies.

When a sandbox mounts a workspace, Docker Sandboxes checks the path against these rules for the access the mount needs. A read-only workspace needs only read. A writable workspace needs both read and write, so the path must be allowed for both actions.

Path patterns

Home directory

~ expands to the user's home directory on every platform, including Windows, where it resolves to %USERPROFILE%. A single ~/** rule therefore matches each user's home tree on macOS, Linux, and Windows. Write ~ with a forward slash, such as ~/**, on every platform, including Windows. The policy engine expands only ~: it does not expand environment variables, so a pattern such as %USERPROFILE%\** or $HOME/** matches nothing.

Operating system formats

For a path outside the home directory, write it in the format the user's operating system uses. A macOS or Linux path doesn't match a Windows or WSL path, so a location that several platforms share needs a rule for each:

Operating systemExample path
macOS, Linux/data/project/**
WindowsC:\data\project\**
WSL\\wsl.localhost\<distro>\data\project\**

On Windows, *: matches any drive letter, so *:\data\** matches the path on any drive.

Wildcards

Wildcards behave the same way in every path format:

PatternExampleMatches
Exact path/data/data only
Segment wildcard/data/*/data/project, one path segment only, not subdirectories
Recursive wildcard/data/**/data/project, /data/project/src, any depth

For example, ~/** matches all paths under the home directory, while ~/* matches only its direct children.

Case and separators

Matching ignores some differences in how a path is written:

DifferenceIgnoredExample
Slash directionYes, except after ~C:/data/** and C:\data\** are the same
Case in Windows drive and UNC paths, including WSLYesC:\Data\** matches c:\data\project
Case in macOS and Linux pathsNo/Data/** doesn't match /data/project
WSL prefixYes\\wsl$\ and \\wsl.localhost\ are the same

macOS paths are case sensitive even on a case-insensitive volume, so write rules with the directory names' capitalization on disk.

How mount paths are resolved

Docker Sandboxes checks the rules against the resolved workspace path, not the path a developer passes to sbx run or sbx create. It expands ~, makes the path absolute, removes . and .. segments, and resolves the path as follows:

Developer passesPath checked
A relative path, such as .The absolute path
A symbolic linkThe link's target

Because symbolic links are followed, a link under an allowed path is denied when it points to a directory that no rule allows.