commit 6416b3a941079e069c76a96d235dedc6d5eb9385 · pyrox.dev/nixpkgs

+53 -39

nixos/modules/services/networking/syncthing.nix

···

       25
        
           folder.enable

     

       26
        
         ) cfg.declarative.folders);

     

       27
        
       

     

       28
       -
         # get the api key by parsing the config.xml

     

       29
       -
         getApiKey = pkgs.writers.writeDash "getAPIKey" ''

     

       30
       -
           ${pkgs.libxml2}/bin/xmllint \

     

       31
       -
             --xpath 'string(configuration/gui/apikey)'\

     

       32
       -
             ${cfg.configDir}/config.xml

     

       33
       -
         '';

     

       34
       -
       

     

       35
        
         updateConfig = pkgs.writers.writeDash "merge-syncthing-config" ''

     

       36
        
           set -efu

     

       37
       -
           # wait for syncthing port to open

     

       38
       -
           until ${pkgs.curl}/bin/curl -Ss ${cfg.guiAddress} -o /dev/null; do

     

       39
       -
             sleep 1

     

       40
       -
           done

     

       41
        
       

     

       42
       -
           API_KEY=$(${getApiKey})

     

       43
       -
           OLD_CFG=$(${pkgs.curl}/bin/curl -Ss \

     

       44
       -
             -H "X-API-Key: $API_KEY" \

     

       45
       -
             ${cfg.guiAddress}/rest/system/config)

     

       0
        
       
     

       0
        
       
     

       46
        
       

     

       47
       -
           # generate the new config by merging with the nixos config options

     

       48
       -
           NEW_CFG=$(echo "$OLD_CFG" | ${pkgs.jq}/bin/jq -s '.[] as $in | $in * {

     

       49
       -
             "devices": (${builtins.toJSON devices}${optionalString (! cfg.declarative.overrideDevices) " + $in.devices"}),

     

       50
       -
             "folders": (${builtins.toJSON folders}${optionalString (! cfg.declarative.overrideFolders) " + $in.folders"})

     

       51
       -
           }')

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       52
        
       

     

       53
       -
           # POST the new config to syncthing

     

       54
       -
           echo "$NEW_CFG" | ${pkgs.curl}/bin/curl -Ss \

     

       55
       -
             -H "X-API-Key: $API_KEY" \

     

       56
       -
             ${cfg.guiAddress}/rest/system/config -d @-

     

       57
        
       

     

       58
       -
           # restart syncthing after sending the new config

     

       59
       -
           ${pkgs.curl}/bin/curl -Ss \

     

       60
       -
             -H "X-API-Key: $API_KEY" \

     

       61
       -
             -X POST \

     

       62
       -
             ${cfg.guiAddress}/rest/system/restart

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       63
        
         '';

     

       64
        
       in {

     

       65
        
         ###### interface

     
···

       77
        
                 type = types.nullOr types.str;

     

       78
        
                 default = null;

     

       79
        
                 description = ''

     

       80
       -
                   Path to users cert.pem file, will be copied into the syncthing's

     

       81
        
                   <literal>configDir</literal>

     

       82
        
                 '';

     

       83
        
               };

     
···

       86
        
                 type = types.nullOr types.str;

     

       87
        
                 default = null;

     

       88
        
                 description = ''

     

       89
       -
                   Path to users key.pem file, will be copied into the syncthing's

     

       90
        
                   <literal>configDir</literal>

     

       91
        
                 '';

     

       92
        
               };

     
···

       105
        
               devices = mkOption {

     

       106
        
                 default = {};

     

       107
        
                 description = ''

     

       108
       -
                   Peers/devices which syncthing should communicate with.

     

       109
        
                 '';

     

       110
        
                 example = {

     

       111
        
                   bigbox = {

     
···

       168
        
               folders = mkOption {

     

       169
        
                 default = {};

     

       170
        
                 description = ''

     

       171
       -
                   folders which should be shared by syncthing.

     

       172
        
                 '';

     

       173
        
                 example = literalExample ''

     

       174
        
                   {

     
···

       227
        
                     versioning = mkOption {

     

       228
        
                       default = null;

     

       229
        
                       description = ''

     

       230
       -
                         How to keep changed/deleted files with syncthing.

     

       231
        
                         There are 4 different types of versioning with different parameters.

     

       232
        
                         See https://docs.syncthing.net/users/versioning.html

     

       233
        
                       '';

     
···

       335
        
                         upstream's docs</link>.

     

       336
        
                       '';

     

       337
        
                     };

     

       338
       -
       

     

       339
        
                   };

     

       340
        
                 }));

     

       341
        
               };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       342
        
             };

     

       343
        
       

     

       344
        
             guiAddress = mkOption {

     
···

       378
        
               default = null;

     

       379
        
               example = "socks5://address.com:1234";

     

       380
        
               description = ''

     

       381
       -
                 Overwrites all_proxy environment variable for the syncthing process to

     

       382
        
                 the given value. This is normaly used to let relay client connect

     

       383
        
                 through SOCKS5 proxy server.

     

       384
        
               '';

     
···

       412
        
                 Open the default ports in the firewall:

     

       413
        
                   - TCP 22000 for transfers

     

       414
        
                   - UDP 21027 for discovery

     

       415
       -
                 If multiple users are running syncthing on this machine, you will need to manually open a set of ports for each instance and leave this disabled.

     

       416
        
                 Alternatively, if are running only a single instance on this machine using the default ports, enable this.

     

       417
        
               '';

     

       418
        
             };

     
···

       431
        
       

     

       432
        
         imports = [

     

       433
        
           (mkRemovedOptionModule ["services" "syncthing" "useInotify"] ''

     

       434
       -
             This option was removed because syncthing now has the inotify functionality included under the name "fswatcher".

     

       435
        
             It can be enabled on a per-folder basis through the webinterface.

     

       436
        
           '')

     

       437
        
         ];

     
···

       516
        
               };

     

       517
        
             };

     

       518
        
             syncthing-init = mkIf (

     

       519
       -
               cfg.declarative.devices != {} || cfg.declarative.folders != {}

     

       520
        
             ) {

     

       0
        
       
     

       521
        
               after = [ "syncthing.service" ];

     

       522
        
               wantedBy = [ "multi-user.target" ];

     

       523

···

       25
        
           folder.enable

     

       26
        
         ) cfg.declarative.folders);

     

       27
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       28
        
         updateConfig = pkgs.writers.writeDash "merge-syncthing-config" ''

     

       29
        
           set -efu

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       30
        
       

     

       31
       +
           # get the api key by parsing the config.xml

     

       32
       +
           while

     

       33
       +
               ! api_key=$(${pkgs.libxml2}/bin/xmllint \

     

       34
       +
                   --xpath 'string(configuration/gui/apikey)' \

     

       35
       +
                   ${cfg.configDir}/config.xml)

     

       36
       +
           do sleep 1; done

     

       37
        
       

     

       38
       +
           curl() {

     

       39
       +
               while

     

       40
       +
                   ${pkgs.curl}/bin/curl -Ss -H "X-API-Key: $api_key" \

     

       41
       +
                       --retry 100 --retry-delay 1 --retry-connrefused "$@"

     

       42
       +
                   status=$?

     

       43
       +
                   [ "$status" -eq 52 ] # retry on empty reply from server

     

       44
       +
               do sleep 1; done

     

       45
       +
               return "$status"

     

       46
       +
           }

     

       47
        
       

     

       48
       +
           # query the old config

     

       49
       +
           old_cfg=$(curl ${cfg.guiAddress}/rest/config)

     

       0
        
       
     

       0
        
       
     

       50
        
       

     

       51
       +
           # generate the new config by merging with the NixOS config options

     

       52
       +
           new_cfg=$(echo "$old_cfg" | ${pkgs.jq}/bin/jq -c '. * {

     

       53
       +
               "devices": (${builtins.toJSON devices}${optionalString (! cfg.declarative.overrideDevices) " + .devices"}),

     

       54
       +
               "folders": (${builtins.toJSON folders}${optionalString (! cfg.declarative.overrideFolders) " + .folders"})

     

       55
       +
           } * ${builtins.toJSON cfg.declarative.extraOptions}')

     

       56
       +
       

     

       57
       +
           # send the new config

     

       58
       +
           curl -X PUT -d "$new_cfg" ${cfg.guiAddress}/rest/config

     

       59
       +
       

     

       60
       +
           # restart Syncthing if required

     

       61
       +
           if curl ${cfg.guiAddress}/rest/config/restart-required |

     

       62
       +
              ${pkgs.jq}/bin/jq -e .requiresRestart > /dev/null; then

     

       63
       +
               curl -X POST ${cfg.guiAddress}/rest/system/restart

     

       64
       +
           fi

     

       65
        
         '';

     

       66
        
       in {

     

       67
        
         ###### interface

     
···

       79
        
                 type = types.nullOr types.str;

     

       80
        
                 default = null;

     

       81
        
                 description = ''

     

       82
       +
                   Path to users cert.pem file, will be copied into Syncthing's

     

       83
        
                   <literal>configDir</literal>

     

       84
        
                 '';

     

       85
        
               };

     
···

       88
        
                 type = types.nullOr types.str;

     

       89
        
                 default = null;

     

       90
        
                 description = ''

     

       91
       +
                   Path to users key.pem file, will be copied into Syncthing's

     

       92
        
                   <literal>configDir</literal>

     

       93
        
                 '';

     

       94
        
               };

     
···

       107
        
               devices = mkOption {

     

       108
        
                 default = {};

     

       109
        
                 description = ''

     

       110
       +
                   Peers/devices which Syncthing should communicate with.

     

       111
        
                 '';

     

       112
        
                 example = {

     

       113
        
                   bigbox = {

     
···

       170
        
               folders = mkOption {

     

       171
        
                 default = {};

     

       172
        
                 description = ''

     

       173
       +
                   Folders which should be shared by Syncthing.

     

       174
        
                 '';

     

       175
        
                 example = literalExample ''

     

       176
        
                   {

     
···

       229
        
                     versioning = mkOption {

     

       230
        
                       default = null;

     

       231
        
                       description = ''

     

       232
       +
                         How to keep changed/deleted files with Syncthing.

     

       233
        
                         There are 4 different types of versioning with different parameters.

     

       234
        
                         See https://docs.syncthing.net/users/versioning.html

     

       235
        
                       '';

     
···

       337
        
                         upstream's docs</link>.

     

       338
        
                       '';

     

       339
        
                     };

     

       0
        
       
     

       340
        
                   };

     

       341
        
                 }));

     

       342
        
               };

     

       343
       +
       

     

       344
       +
               extraOptions = mkOption {

     

       345
       +
                 type = types.addCheck (pkgs.formats.json {}).type isAttrs;

     

       346
       +
                 default = {};

     

       347
       +
                 description = ''

     

       348
       +
                   Extra configuration options for Syncthing.

     

       349
       +
                 '';

     

       350
       +
                 example = {

     

       351
       +
                   options.localAnnounceEnabled = false;

     

       352
       +
                   gui.theme = "black";

     

       353
       +
                 };

     

       354
       +
               };

     

       355
        
             };

     

       356
        
       

     

       357
        
             guiAddress = mkOption {

     
···

       391
        
               default = null;

     

       392
        
               example = "socks5://address.com:1234";

     

       393
        
               description = ''

     

       394
       +
                 Overwrites all_proxy environment variable for the Syncthing process to

     

       395
        
                 the given value. This is normaly used to let relay client connect

     

       396
        
                 through SOCKS5 proxy server.

     

       397
        
               '';

     
···

       425
        
                 Open the default ports in the firewall:

     

       426
        
                   - TCP 22000 for transfers

     

       427
        
                   - UDP 21027 for discovery

     

       428
       +
                 If multiple users are running Syncthing on this machine, you will need to manually open a set of ports for each instance and leave this disabled.

     

       429
        
                 Alternatively, if are running only a single instance on this machine using the default ports, enable this.

     

       430
        
               '';

     

       431
        
             };

     
···

       444
        
       

     

       445
        
         imports = [

     

       446
        
           (mkRemovedOptionModule ["services" "syncthing" "useInotify"] ''

     

       447
       +
             This option was removed because Syncthing now has the inotify functionality included under the name "fswatcher".

     

       448
        
             It can be enabled on a per-folder basis through the webinterface.

     

       449
        
           '')

     

       450
        
         ];

     
···

       529
        
               };

     

       530
        
             };

     

       531
        
             syncthing-init = mkIf (

     

       532
       +
               cfg.declarative.devices != {} || cfg.declarative.folders != {} || cfg.declarative.extraOptions != {}

     

       533
        
             ) {

     

       534
       +
               description = "Syncthing configuration updater";

     

       535
        
               after = [ "syncthing.service" ];

     

       536
        
               wantedBy = [ "multi-user.target" ];

     

       537

nixos/tests/syncthing-init.nix

···

       17
        
                 path = "/tmp/test";

     

       18
        
                 devices = [ "testDevice" ];

     

       19
        
               };

     

       0
        
       
     

       20
        
             };

     

       21
        
           };

     

       22
        
         };

     
···

       27
        
       

     

       28
        
           assert "testFolder" in config

     

       29
        
           assert "${testId}" in config

     

       0
        
       
     

       30
        
         '';

     

       31
        
       })

···

       17
        
                 path = "/tmp/test";

     

       18
        
                 devices = [ "testDevice" ];

     

       19
        
               };

     

       20
       +
               extraOptions.gui.user = "guiUser";

     

       21
        
             };

     

       22
        
           };

     

       23
        
         };

     
···

       28
        
       

     

       29
        
           assert "testFolder" in config

     

       30
        
           assert "${testId}" in config

     

       31
       +
           assert "guiUser" in config

     

       32
        
         '';

     

       33
        
       })

+2 -2

nixos/tests/syncthing.nix

···

       25
        
                   "xmllint --xpath 'string(configuration/gui/apikey)' %s/config.xml" % confdir

     

       26
        
               ).strip()

     

       27
        
               oldConf = host.succeed(

     

       28
       -
                   "curl -Ssf -H 'X-API-Key: %s' 127.0.0.1:8384/rest/system/config" % APIKey

     

       29
        
               )

     

       30
        
               conf = json.loads(oldConf)

     

       31
        
               conf["devices"].append({"deviceID": deviceID, "id": name})

     
···

       39
        
               )

     

       40
        
               newConf = json.dumps(conf)

     

       41
        
               host.succeed(

     

       42
       -
                   "curl -Ssf -H 'X-API-Key: %s' 127.0.0.1:8384/rest/system/config -d %s"

     

       43
        
                   % (APIKey, shlex.quote(newConf))

     

       44
        
               )

     

       45

···

       25
        
                   "xmllint --xpath 'string(configuration/gui/apikey)' %s/config.xml" % confdir

     

       26
        
               ).strip()

     

       27
        
               oldConf = host.succeed(

     

       28
       +
                   "curl -Ssf -H 'X-API-Key: %s' 127.0.0.1:8384/rest/config" % APIKey

     

       29
        
               )

     

       30
        
               conf = json.loads(oldConf)

     

       31
        
               conf["devices"].append({"deviceID": deviceID, "id": name})

     
···

       39
        
               )

     

       40
        
               newConf = json.dumps(conf)

     

       41
        
               host.succeed(

     

       42
       +
                   "curl -Ssf -H 'X-API-Key: %s' 127.0.0.1:8384/rest/config -X PUT -d %s"

     

       43
        
                   % (APIKey, shlex.quote(newConf))

     

       44
        
               )

     

       45