Syncthing: Difference between revisions

From NixOS Wiki
imported>Zwerdlds
m Added section on public-facing GUI and firewall ports to enable.
imported>Me00001
m added missing space
Line 55: Line 55:
<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
   # Syncthing ports
   # Syncthing ports
   networking.firewall.allowedTCPPorts = [ 8384 22000];
   networking.firewall.allowedTCPPorts = [ 8384 22000 ];
   networking.firewall.allowedUDPPorts = [ 22000 21027];
   networking.firewall.allowedUDPPorts = [ 22000 21027 ];
</syntaxHighlight>
</syntaxHighlight>



Revision as of 00:07, 18 March 2023

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 default values ("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.devices and services.syncthing.folders options:

(Note: Before NixOS 21.11, declarative configuration was done in the services.syncthing.declarative option, such as services.syncthing.declarative.folders = {};)

services = {
  syncthing = {
    enable = true;
    dataDir = "/home/myusername/Documents";
    configDir = "/home/myusername/Documents/.config/syncthing";
    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.
      };
    };
  };
};

If running a headless server, you should also change guiAddress to a publicly visible one (or just 0.0.0.0:8384, for example). You will also probaly have to open a few ports in the firewall:

   # Syncthing ports
   networking.firewall.allowedTCPPorts = [ 8384 22000 ];
   networking.firewall.allowedUDPPorts = [ 22000 21027 ];


home-manager service

https://github.com/nix-community/home-manager/blob/master/modules/services/syncthing.nix