Document that Syncthing may need extra permissions to access some paths on macOS
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 327
- Forks
- 653
- PR merge metrics
- No merged PRs in 30d
Description
Does your log mention database corruption?
No
Required information
- which version of Syncthing and what operating system you are using
- macOS 12.3
- browser and version, if applicable
- N/A
- what happened
- Browsed to the install and auto instructions ( https://docs.syncthing.net/users/autostart.html#macos )
- Ran
brew install syncthing- It was successful. I got the following prompt:
To start syncthing now and restart at login: brew services start syncthing
- It was successful. I got the following prompt:
brew services start syncthing=>==> Successfully startedsyncthing(label: homebrew.mxcl.syncthing)- Configured it in the WebUI and added my device
- Had consistent errors in the UI:
Failed to create path for auto-accepted folder ... operation not permittedFailed to create older root directory mkdir ... operation not permittedError on folder ... folder path missing
- Attempted troubleshooting by creating folders and changing folder/file permissions. This did change the errors, which felt like progress.
- Attempted troubleshooting by stopping the service and starting syncthing in terminal. This worked, which makes sense now but was confusing at the time.
- Found https://forum.syncthing.net/t/scanner-operation-not-permitted/15329 and gave the service full disk permissions. This solved it
- what you expected to happen instead
- Expected
To start syncthing now and restart at login:to be followed byAfter it starts, you will likely have to allow full disk permissions in "macOS Peferences" > "Security" > “full disk access” - Alternately, having it documented on https://docs.syncthing.net/users/autostart.html#macos
- Further possibility: Clearly state the permission issue in the Web UI.
Have you allowed disk access in the Security tab?
- Expected
- any steps to reproduce the problem
- See above
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the macOS section of docs/users/autostart.html, linked from the issue, and review the reported Homebrew service behavior and permission errors. Update the documentation to explain that Syncthing may need macOS Full Disk Access for some paths, then verify the page builds and the guidance is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- macos
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100