Syncthing: Difference between revisions

Line 27:

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

<~~syntaxHighlight~~ lang="nix">

services = {

syncthing = {

Line 42:

};

folders = {

"Documents" = { # ~~Name of folder~~ in Syncthing, also the folder ID

"Documents" = { # Folder ID in Syncthing, also the name of folder (label) by default

path = "/home/myusername/Documents"; # Which folder to add to Syncthing

devices = [ "device1" "device2" ]; # Which devices to share the folder with

};

"Example" = {

label = "Private"; # Optional label for the folder

path = "/home/myusername/Example";

devices = [ "device1" ];

Line 55:

Line 56:

};

</~~syntaxHighlight~~>Beware when adding additional settings via <code>services.syncthing.settings</code>, because sometimes you cannot use the key as in the documentation. For example, when setting the ''Sync Protocol Listen Address'': The key in the [https://docs.syncthing.net/users/config.html#config-file-format documentation] is <code>listenAddress</code>, however, because the value is a list the key used in <code>services.syncthing.settings</code> has to be <code>listenAddresses</code> (notice the extra <code>es</code>). See the following example:<syntaxhighlight lang="nix">

</syntaxhighlight>Beware when adding additional settings via <code>services.syncthing.settings</code>, because sometimes you cannot use the key as in the documentation. For example, when setting the ''Sync Protocol Listen Address'': The key in the [https://docs.syncthing.net/users/config.html#config-file-format documentation] is <code>listenAddress</code>, however, because the value is a list the key used in <code>services.syncthing.settings</code> has to be <code>listenAddresses</code> (notice the extra <code>es</code>). See the following example:<syntaxhighlight lang="nix">

settings = {

options = {

@@ Line 27: / Line 27: @@
 (Note: Before NixOS 21.11, declarative configuration was done in the <code>services.syncthing.declarative</code> option, such as <code>services.syncthing.declarative.folders = {};</code>)
-<syntaxHighlight lang="nix">
+<syntaxhighlight lang="nix">
 services = {
    syncthing = {
@@ Line 42: / Line 42: @@
        };
        folders = {
-         "Documents" = {         # Name of folder in Syncthing, also the folder ID
+         "Documents" = {         # Folder ID in Syncthing, also the name of folder (label) by default
            path = "/home/myusername/Documents";    # Which folder to add to Syncthing
            devices = [ "device1" "device2" ];      # Which devices to share the folder with
          };
          "Example" = {
+          label = "Private";                      # Optional label for the folder
            path = "/home/myusername/Example";
            devices = [ "device1" ];
@@ Line 55: / Line 56: @@
    };
 };
-</syntaxHighlight>Beware when adding additional settings via <code>services.syncthing.settings</code>, because sometimes you cannot use the key as in the documentation. For example, when setting the ''Sync Protocol Listen Address'': The key in the [https://docs.syncthing.net/users/config.html#config-file-format documentation] is <code>listenAddress</code>, however, because the value is a list the key used in <code>services.syncthing.settings</code> has to be <code>listenAddresses</code> (notice the extra <code>es</code>). See the following example:<syntaxhighlight lang="nix">
+</syntaxhighlight>Beware when adding additional settings via <code>services.syncthing.settings</code>, because sometimes you cannot use the key as in the documentation. For example, when setting the ''Sync Protocol Listen Address'': The key in the [https://docs.syncthing.net/users/config.html#config-file-format documentation] is <code>listenAddress</code>, however, because the value is a list the key used in <code>services.syncthing.settings</code> has to be <code>listenAddresses</code> (notice the extra <code>es</code>). See the following example:<syntaxhighlight lang="nix">
 settings = {
    options = {