syncthing: expand declarative config to Darwin #6104
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
karaolidis
approved these changes
Nov 19, 2024
rycee
reviewed
Dec 1, 2024
Comment on lines
+15
to
+18
| syncthing_dir = if pkgs.stdenv.isDarwin then | ||
| "$HOME/Library/Application Support/Syncthing" | ||
| else | ||
| "\${XDG_STATE_HOME:-$HOME/.local/state}/syncthing"; |
There was a problem hiding this comment.
Quick question. Will the Darwin directory be used even if the XDG_STATE_HOME variable is set?
There was a problem hiding this comment.
I think so, that's at least how I understood the documentation.
Anyway, I remember that I was also a bit surprised by this when I wrote the module. So just to be sure, this time I took a quick look at the source code (release tag v1.28.0, as used in NixOS 24.11). Indeed, XDG_STATE_HOME is only considered when not on Windows/Darwin and for Darwin the location is hardcoded as $HOME/Library/Application Support/Syncthing.
This makes it possible to reuse the script in launchd setup.
Is set according to the corresponding OS default, see https://docs.syncthing.net/users/config.html.
Allows us to reuse the function in different scripts.
Make launchd.agents an explicit attribute set, since we're going to add another agent.
This extends the recently merged PR nix-community#5616, which expanded the Synching config to allow declarative settings under Linux, such that it also works under Darwin. Changes: * Update the module's `syncthing` launchd agent to copy the synching key/certificate before starting syncthing, analogously to the systemd service from the above mentioned PR nix-community#5616. * Adds an `syncthing-init`launchd agent (analogously to the systemd service `synching-init` from the above mentioned PR nix-community#5616) that updates the configuration files. Since this must be run after the syncthing service started, we use a `WatchPath` to coordinate both launchd agents.
pitkling
force-pushed
the
syncthing-declarative-macos
branch
from
2d676db to
eaee6ea
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PRs extends the recently merged PR #5616, which expanded the Synching config to allow declarative settings under Linux, such that it also works under Darwin.
To simplify the review process, I left split the PR into several commits for now:
syncthinglaunchd agent to copy the synching key/certificate before starting syncthing, analogously to the systemd service from the above mentioned PR syncthing: expand declarative config #5616.syncthing-initlaunchd agent (analogously to the systemd servicesynching-initfrom the above mentioned PR syncthing: expand declarative config #5616) that updates the configuration files. Since this must be run after the syncthing service started, we use aWatchPathto coordinate both launchd agents.formattool.There might be better ways to coordinate the two launchd agents I'm not aware of. But I have had this running flawlessly for over two months now (on four Darwin and two Linux machines sharing various folders).
Fixes #4049 for Darwin systems.
Checklist
Change is backwards compatible.
Code formatted with
./format.Code tested through
nix-shell --pure tests -A run.allornix develop --ignore-environment .#allusing Flakes.Test cases updated/added. See example.
Commit messages are formatted (see commit 6; I'll squash the other commits into it after the review process)
Maintainer CC
@karaolidis (pinging as author of the original (linux-specific) PR #5616)
@rycee (maintainer)