syncthing / syncthing/docs

Improve the Folder Sync Ownership documentation

Open
#866 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs-triage
Dominant language
Python
Stars
327
Forks
653
PR merge metrics
No merged PRs in 30d

Description

Feature description

Add more OS-specific details in:

https://docs.syncthing.net/advanced/folder-sync-ownership.html#unix-implementation

that cover various recommended options for configuring this feature on multiple systems.

Problem or use case

The documentation is very sparse for this feature. It has a Unix implementation and Windows implementation sections, but makes no specific mention of Linux or macOS, despite the fact that the suggestion about using setcap only works on Linux, and will not work on macOS.

Alternatives or workarounds

Browsing the forums or figuring it out for oneself.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the Unix implementation section at docs.syncthing.net/advanced/folder-sync-ownership.html, then compare the setcap suggestion with the Linux and macOS behavior described in the issue. Document recommended configuration options for both systems, making clear which guidance applies to each; done means the feature has useful OS-specific coverage beyond the current Unix and Windows sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
linux, macos
Domain
documentation, operating-systems
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.