commit b474de47797ef17172dfb1b4c0015696c59cf82d · pyrox.dev/nixpkgs

+9 -15
nixos/modules/services/misc/anki-sync-server.nix
···

       2
       2
        
         config,

     

       3
       3
        
         lib,

     

       4
       4
        
         pkgs,

     

       5
       5
       -
         utils,

     

       6
       5
        
         ...

     

       7
       6
        
       }:

     

       8
       7
        
       with lib; let

     
···

       41
       40
        
         '';

     

       42
       41
        
       in {

     

       43
       42
        
         options.services.anki-sync-server = {

     

       44
       44
       -
           enable = mkEnableOption (lib.mdDoc "anki-sync-server");

     

       43
       43
       +
           enable = mkEnableOption "anki-sync-server";

     

       45
       44
        
       

     

       46
       46
       -
           package = mkOption {

     

       47
       47
       -
             type = types.package;

     

       48
       48
       -
             default = pkgs.anki-sync-server;

     

       49
       49
       -
             defaultText = literalExpression "pkgs.anki-sync-server";

     

       50
       50
       -
             description = lib.mdDoc "The package to use for the anki-sync-server command.";

     

       51
       51
       -
           };

     

       45
       45
       +
           package = mkPackageOption pkgs "anki-sync-server" { };

     

       52
       46
        
       

     

       53
       47
        
           address = mkOption {

     

       54
       48
        
             type = types.str;

     

       55
       49
        
             default = "::1";

     

       56
       56
       -
             description = lib.mdDoc ''

     

       50
       50
       +
             description = ''

     

       57
       51
        
               IP address anki-sync-server listens to.

     

       58
       52
        
               Note host names are not resolved.

     

       59
       53
        
             '';

     
···

       62
       56
        
           port = mkOption {

     

       63
       57
        
             type = types.port;

     

       64
       58
        
             default = 27701;

     

       65
       65
       -
             description = lib.mdDoc "port anki-sync-server listens to";

     

       59
       59
       +
             description = "Port number anki-sync-server listens to.";

     

       66
       60
        
           };

     

       67
       61
        
       

     

       68
       62
        
           openFirewall = mkOption {

     

       69
       63
        
             default = false;

     

       70
       64
        
             type = types.bool;

     

       71
       71
       -
             description = lib.mdDoc "Whether to open the firewall for the specified port.";

     

       65
       65
       +
             description = "Whether to open the firewall for the specified port.";

     

       72
       66
        
           };

     

       73
       67
        
       

     

       74
       68
        
           users = mkOption {

     
···

       77
       71
        
                 options = {

     

       78
       72
        
                   username = mkOption {

     

       79
       73
        
                     type = str;

     

       80
       80
       -
                     description = lib.mdDoc "User name accepted by anki-sync-server.";

     

       74
       74
       +
                     description = "User name accepted by anki-sync-server.";

     

       81
       75
        
                   };

     

       82
       76
        
                   password = mkOption {

     

       83
       77
        
                     type = nullOr str;

     

       84
       78
        
                     default = null;

     

       85
       85
       -
                     description = lib.mdDoc ''

     

       79
       79
       +
                     description = ''

     

       86
       80
        
                       Password accepted by anki-sync-server for the associated username.

     

       87
       81
        
                       **WARNING**: This option is **not secure**. This password will

     

       88
       82
        
                       be stored in *plaintext* and will be visible to *all users*.

     
···

       93
       87
        
                   passwordFile = mkOption {

     

       94
       88
        
                     type = nullOr path;

     

       95
       89
        
                     default = null;

     

       96
       96
       -
                     description = lib.mdDoc ''

     

       90
       90
       +
                     description = ''

     

       97
       91
        
                       File containing the password accepted by anki-sync-server for

     

       98
       92
        
                       the associated username.  Make sure to make readable only by

     

       99
       93
        
                       root.

     
···

       101
       95
        
                   };

     

       102
       96
        
                 };

     

       103
       97
        
               });

     

       104
       104
       -
             description = lib.mdDoc "List of user-password pairs to provide to the sync server.";

     

       98
       98
       +
             description = "List of user-password pairs to provide to the sync server.";

     

       105
       99
        
           };

     

       106
       100
        
         };

     

       107
       101