docs: added section on symlinks when using SFS (#21712)

<!--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 <102604716+aevesdocker@users.noreply.github.com>
This commit is contained in:
Monica Chao 2025-01-06 10:28:57 -06:00 committed by GitHub
parent 3cac036e93
commit 66eb22e5fa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 0 deletions

View File

@ -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. - 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 ## Feedback and support
To give feedback or report bugs, visit: To give feedback or report bugs, visit: