commit 9563f469c17e05274be15ee13d276f3e6fb4fbcc · pyrox.dev/nixpkgs

+125
nixos/modules/services/misc/duckdns.nix
···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         lib,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.duckdns;

     

       9
       9
       +
         duckdns = pkgs.writeShellScriptBin "duckdns" ''

     

       10
       10
       +
           DRESPONSE=$(curl -sS --max-time 60 --no-progress-meter -k -K- <<< "url = \"https://www.duckdns.org/update?verbose=true&domains=$DUCKDNS_DOMAINS&token=$DUCKDNS_TOKEN&ip=\"")

     

       11
       11
       +
           IPV4=$(echo "$DRESPONSE" | awk 'NR==2')

     

       12
       12
       +
           IPV6=$(echo "$DRESPONSE" | awk 'NR==3')

     

       13
       13
       +
           RESPONSE=$(echo "$DRESPONSE" | awk 'NR==1')

     

       14
       14
       +
           IPCHANGE=$(echo "$DRESPONSE" | awk 'NR==4')

     

       15
       15
       +
       

     

       16
       16
       +
           if [[ "$RESPONSE" = "OK" ]] && [[ "$IPCHANGE" = "UPDATED" ]]; then

     

       17
       17
       +
               if [[ "$IPV4" != "" ]] && [[ "$IPV6" == "" ]]; then

     

       18
       18
       +
                   echo "Your IP was updated at $(date) to IPv4: $IPV4"

     

       19
       19
       +
               elif [[ "$IPV4" == "" ]] && [[ "$IPV6" != "" ]]; then

     

       20
       20
       +
                   echo "Your IP was updated at $(date) to IPv6: $IPV6"

     

       21
       21
       +
               else

     

       22
       22
       +
                   echo "Your IP was updated at $(date) to IPv4: $IPV4 & IPv6 to: $IPV6"

     

       23
       23
       +
               fi

     

       24
       24
       +
           elif [[ "$RESPONSE" = "OK" ]] && [[ "$IPCHANGE" = "NOCHANGE" ]]; then

     

       25
       25
       +
               echo "DuckDNS request at $(date) successful. IP(s) unchanged."

     

       26
       26
       +
           else

     

       27
       27
       +
               echo -e "Something went wrong, please check your settings\nThe response returned was:\n$DRESPONSE\n"

     

       28
       28
       +
               exit 1

     

       29
       29
       +
           fi

     

       30
       30
       +
         '';

     

       31
       31
       +
       in

     

       32
       32
       +
       {

     

       33
       33
       +
         options.services.duckdns = {

     

       34
       34
       +
           enable = lib.mkEnableOption "DuckDNS Dynamic DNS Client";

     

       35
       35
       +
           tokenFile = lib.mkOption {

     

       36
       36
       +
             default = null;

     

       37
       37
       +
             type = lib.types.path;

     

       38
       38
       +
             description = ''

     

       39
       39
       +
               The path to a file containing the token

     

       40
       40
       +
               used to authenticate with DuckDNS.

     

       41
       41
       +
             '';

     

       42
       42
       +
           };

     

       43
       43
       +
       

     

       44
       44
       +
           domains = lib.mkOption {

     

       45
       45
       +
             default = null;

     

       46
       46
       +
             type = lib.types.nullOr (lib.types.listOf lib.types.str);

     

       47
       47
       +
             example = [ "examplehost" ];

     

       48
       48
       +
             description = ''

     

       49
       49
       +
               The domain(s) to update in DuckDNS

     

       50
       50
       +
               (without the .duckdns.org suffix)

     

       51
       51
       +
             '';

     

       52
       52
       +
           };

     

       53
       53
       +
       

     

       54
       54
       +
           domainsFile = lib.mkOption {

     

       55
       55
       +
             default = null;

     

       56
       56
       +
             type = lib.types.nullOr lib.types.path;

     

       57
       57
       +
             example = lib.literalExpression ''

     

       58
       58
       +
               pkgs.writeText "duckdns-domains.txt" '''

     

       59
       59
       +
                 examplehost

     

       60
       60
       +
                 examplehost2

     

       61
       61
       +
                 examplehost3

     

       62
       62
       +
               '''

     

       63
       63
       +
             '';

     

       64
       64
       +
             description = ''

     

       65
       65
       +
               The path to a file containing a

     

       66
       66
       +
               newline-separated list of DuckDNS

     

       67
       67
       +
               domain(s) to be updated

     

       68
       68
       +
               (without the .duckdns.org suffix)

     

       69
       69
       +
             '';

     

       70
       70
       +
           };

     

       71
       71
       +
       

     

       72
       72
       +
         };

     

       73
       73
       +
       

     

       74
       74
       +
         config = lib.mkIf cfg.enable {

     

       75
       75
       +
           assertions = [

     

       76
       76
       +
             {

     

       77
       77
       +
               assertion = cfg.domains != null || cfg.domainsFile != null;

     

       78
       78
       +
               message = "Either services.duckdns.domains or services.duckdns.domainsFile has to be defined";

     

       79
       79
       +
             }

     

       80
       80
       +
             {

     

       81
       81
       +
               assertion = !(cfg.domains != null && cfg.domainsFile != null);

     

       82
       82
       +
               message = "services.duckdns.domains and services.duckdns.domainsFile can't both be defined at the same time";

     

       83
       83
       +
             }

     

       84
       84
       +
             {

     

       85
       85
       +
               assertion = (cfg.tokenFile != null);

     

       86
       86
       +
               message = "services.duckdns.tokenFile has to be defined";

     

       87
       87
       +
             }

     

       88
       88
       +
           ];

     

       89
       89
       +
       

     

       90
       90
       +
           environment.systemPackages = [ duckdns ];

     

       91
       91
       +
       

     

       92
       92
       +
           systemd.services.duckdns = {

     

       93
       93
       +
             description = "DuckDNS Dynamic DNS Client";

     

       94
       94
       +
             after = [ "network.target" ];

     

       95
       95
       +
             wantedBy = [ "multi-user.target" ];

     

       96
       96
       +
             startAt = "*:0/5";

     

       97
       97
       +
             path = [

     

       98
       98
       +
               pkgs.gnused

     

       99
       99
       +
               pkgs.systemd

     

       100
       100
       +
               pkgs.curl

     

       101
       101
       +
               pkgs.gawk

     

       102
       102
       +
               duckdns

     

       103
       103
       +
             ];

     

       104
       104
       +
             serviceConfig = {

     

       105
       105
       +
               Type = "simple";

     

       106
       106
       +
               LoadCredential = [

     

       107
       107
       +
                 "DUCKDNS_TOKEN_FILE:${cfg.tokenFile}"

     

       108
       108
       +
               ] ++ lib.optionals (cfg.domainsFile != null) [ "DUCKDNS_DOMAINS_FILE:${cfg.domainsFile}" ];

     

       109
       109
       +
               DynamicUser = true;

     

       110
       110
       +
             };

     

       111
       111
       +
             script = ''

     

       112
       112
       +
               export DUCKDNS_TOKEN=$(systemd-creds cat DUCKDNS_TOKEN_FILE)

     

       113
       113
       +
               ${lib.optionalString (cfg.domains != null) ''

     

       114
       114
       +
                 export DUCKDNS_DOMAINS='${lib.strings.concatStringsSep "," cfg.domains}'

     

       115
       115
       +
               ''}

     

       116
       116
       +
               ${lib.optionalString (cfg.domainsFile != null) ''

     

       117
       117
       +
                 export DUCKDNS_DOMAINS=$(systemd-creds cat DUCKDNS_DOMAINS_FILE | sed -z 's/\n/,/g')

     

       118
       118
       +
               ''}

     

       119
       119
       +
               exec ${lib.getExe duckdns}

     

       120
       120
       +
             '';

     

       121
       121
       +
           };

     

       122
       122
       +
         };

     

       123
       123
       +
       

     

       124
       124
       +
         meta.maintainers = with lib.maintainers; [ notthebee ];

     

       125
       125
       +
       }