Skip to content

Commit

Permalink
docs: added section on symlinks when using SFS (#21712)
Browse files Browse the repository at this point in the history
<!--Delete sections as needed -->

## Description

Based on customer feedback, it was not clear how to resolve the `unable
to create symbolic link` error which can result from a user without
permissions to create symbolic links when using a synchronized file
share.

## Related issues or tickets

- SEG-689

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [X] Editorial review
- [ ] Product review

---------

Co-authored-by: Allie Sadler <[email protected]>
  • Loading branch information
chaomonica and aevesdocker authored Jan 6, 2025
1 parent 3cac036 commit 66eb22e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions content/manuals/desktop/features/synchronized-file-sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ In general, use your `.syncignore` file to exclude items that aren't critical to

- POSIX-style Windows paths are not supported. Avoid setting the [`COMPOSE_CONVERT_WINDOWS_PATHS`](/manuals/compose/how-tos/environment-variables/envvars.md#compose_convert_windows_paths) environment variable in Docker Compose.

- If you don't have the correct permissions to create symbolic links and your container attempts to create symbolic links in your file share instance, an **unable to create symbolic link** error message displays. For Windows users, see Microsoft's [Create symbolic links documentation](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-10/security/threat-protection/security-policy-settings/create-symbolic-links) for best practices and location of the **Create symbolic links** security policy setting. For Mac and Linux users, check that you have write permissions on the folder.

## Feedback and support

To give feedback or report bugs, visit:
Expand Down

0 comments on commit 66eb22e

Please sign in to comment.