Syncthing: Difference between revisions
Appearance
imported>Klaymore Added section for declarative folder configuration |
imported>Klaymore m Comments for dataDir and configDir options |
||
| Line 3: | Line 3: | ||
<nowiki>nix-env -iA nixos.syncthing</nowiki> | <nowiki>nix-env -iA nixos.syncthing</nowiki> | ||
It can also be enabled as a service. You'll typically want to configure the user and the path to the configuration directory, as with the | It can also be enabled as a service. You'll typically want to configure the user and the path to the configuration directory, as with the defaultvalues ("syncthing" for the user, "/var/lib/syncthing" for the dir) you won't be able to access the files: | ||
<nowiki> | <nowiki> | ||
| Line 11: | Line 10: | ||
enable = true; | enable = true; | ||
user = "myusername"; | user = "myusername"; | ||
dataDir = "/home/myusername/Documents"; | dataDir = "/home/myusername/Documents"; # Default folder for new synced folders | ||
configDir = "/home/myusername/Documents/.config/syncthing"; | configDir = "/home/myusername/Documents/.config/syncthing"; # Folder for Syncthing's settings and keys | ||
}; | }; | ||
}; | }; | ||
Revision as of 01:28, 24 November 2021
Syncthing is available as a standalone package:
nix-env -iA nixos.syncthing
It can also be enabled as a service. You'll typically want to configure the user and the path to the configuration directory, as with the defaultvalues ("syncthing" for the user, "/var/lib/syncthing" for the dir) you won't be able to access the files:
services = {
syncthing = {
enable = true;
user = "myusername";
dataDir = "/home/myusername/Documents"; # Default folder for new synced folders
configDir = "/home/myusername/Documents/.config/syncthing"; # Folder for Syncthing's settings and keys
};
};
You can confirm Syncthing runs by visiting http://127.0.0.1:8384/ and follow the official Getting Started guide: https://docs.syncthing.net/intro/getting-started.html
Declarative Configuration
You can declaratively set your Syncthing folders by using the services.syncthing.declarative options:
services = {
syncthing = {
enable = true;
declarative = {
overrideDevices = true; # overrides any devices added or deleted through the WebUI
overrideFolders = true; # overrides any folders added or deleted through the WebUI
devices = {
"device1" = { id = "DEVICE-ID-GOES-HERE"; };
"device2" = { id = "DEVICE-ID-GOES-HERE"; };
};
folders = {
"Documents" = { # Name of folder in Syncthing, also the folder ID
path = "/home/myusername/Documents"; # Which folder to add to Syncthing
devices = [ "device1" "device2" ]; # Which devices to share the folder with
};
"Example" = {
path = "/home/myusername/Example";
devices = [ "device1" ];
ignorePerms = false; # By default, Syncthing doesn't sync file permissions. This line enables it for this folder.
};
};
};
};
};
home-manager service
https://github.com/nix-community/home-manager/blob/master/modules/services/syncthing.nix