commit 22d14ed8a2e51684d4bb3c17295adabfa705691d · pyrox.dev/nixpkgs

+42 -45

nixos/modules/services/misc/gollum.nix

···

       4
        
         pkgs,

     

       5
        
         ...

     

       6
        
       }:

     

       7
       -
       

     

       8
       -
       with lib;

     

       9
       -
       

     

       10
        
       let

     

       11
        
         cfg = config.services.gollum;

     

       12
        
       in

     

       13
        
       

     

       14
        
       {

     

       15
        
         imports = [

     

       16
       -
           (mkRemovedOptionModule

     

       17
        
             [

     

       18
        
               "services"

     

       19
        
               "gollum"

     
···

       24
        
         ];

     

       25
        
       

     

       26
        
         options.services.gollum = {

     

       27
       -
           enable = mkEnableOption "Gollum, a git-powered wiki service";

     

       28
        
       

     

       29
       -
           address = mkOption {

     

       30
       -
             type = types.str;

     

       31
        
             default = "0.0.0.0";

     

       32
        
             description = "IP address on which the web server will listen.";

     

       33
        
           };

     

       34
        
       

     

       35
       -
           port = mkOption {

     

       36
       -
             type = types.port;

     

       37
        
             default = 4567;

     

       38
        
             description = "Port on which the web server will run.";

     

       39
        
           };

     

       40
        
       

     

       41
       -
           extraConfig = mkOption {

     

       42
       -
             type = types.lines;

     

       43
        
             default = "";

     

       44
        
             description = "Content of the configuration file";

     

       45
        
           };

     

       46
        
       

     

       47
       -
           math = mkOption {

     

       48
       -
             type = types.bool;

     

       49
        
             default = false;

     

       50
        
             description = "Enable support for math rendering using KaTeX";

     

       51
        
           };

     

       52
        
       

     

       53
       -
           allowUploads = mkOption {

     

       54
       -
             type = types.nullOr (

     

       55
       -
               types.enum [

     

       56
        
                 "dir"

     

       57
        
                 "page"

     

       58
        
               ]

     
···

       61
        
             description = "Enable uploads of external files";

     

       62
        
           };

     

       63
        
       

     

       64
       -
           user-icons = mkOption {

     

       65
       -
             type = types.nullOr (

     

       66
       -
               types.enum [

     

       67
        
                 "gravatar"

     

       68
        
                 "identicon"

     

       69
        
               ]

     
···

       72
        
             description = "Enable specific user icons for history view";

     

       73
        
           };

     

       74
        
       

     

       75
       -
           emoji = mkOption {

     

       76
       -
             type = types.bool;

     

       77
        
             default = false;

     

       78
        
             description = "Parse and interpret emoji tags";

     

       79
        
           };

     

       80
        
       

     

       81
       -
           h1-title = mkOption {

     

       82
       -
             type = types.bool;

     

       83
        
             default = false;

     

       84
        
             description = "Use the first h1 as page title";

     

       85
        
           };

     

       86
        
       

     

       87
       -
           no-edit = mkOption {

     

       88
       -
             type = types.bool;

     

       89
        
             default = false;

     

       90
        
             description = "Disable editing pages";

     

       91
        
           };

     

       92
        
       

     

       93
       -
           local-time = mkOption {

     

       94
       -
             type = types.bool;

     

       95
        
             default = false;

     

       96
        
             description = "Use the browser's local timezone instead of the server's for displaying dates.";

     

       97
        
           };

     

       98
        
       

     

       99
       -
           branch = mkOption {

     

       100
       -
             type = types.str;

     

       101
        
             default = "master";

     

       102
        
             example = "develop";

     

       103
        
             description = "Git branch to serve";

     

       104
        
           };

     

       105
        
       

     

       106
       -
           stateDir = mkOption {

     

       107
       -
             type = types.path;

     

       108
        
             default = "/var/lib/gollum";

     

       109
        
             description = "Specifies the path of the repository directory. If it does not exist, Gollum will create it on startup.";

     

       110
        
           };

     

       111
        
       

     

       112
       -
           package = mkPackageOption pkgs "gollum" { };

     

       113
        
       

     

       114
       -
           user = mkOption {

     

       115
       -
             type = types.str;

     

       116
        
             default = "gollum";

     

       117
        
             description = "Specifies the owner of the wiki directory";

     

       118
        
           };

     

       119
        
       

     

       120
       -
           group = mkOption {

     

       121
       -
             type = types.str;

     

       122
        
             default = "gollum";

     

       123
        
             description = "Specifies the owner group of the wiki directory";

     

       124
        
           };

     

       125
        
         };

     

       126
        
       

     

       127
       -
         config = mkIf cfg.enable {

     

       128
        
       

     

       129
       -
           users.users.gollum = mkIf (cfg.user == "gollum") {

     

       130
        
             group = cfg.group;

     

       131
        
             description = "Gollum user";

     

       132
        
             createHome = false;

     
···

       158
        
                   --host ${cfg.address} \

     

       159
        
                   --config ${pkgs.writeText "gollum-config.rb" cfg.extraConfig} \

     

       160
        
                   --ref ${cfg.branch} \

     

       161
       -
                   ${optionalString cfg.math "--math"} \

     

       162
       -
                   ${optionalString cfg.emoji "--emoji"} \

     

       163
       -
                   ${optionalString cfg.h1-title "--h1-title"} \

     

       164
       -
                   ${optionalString cfg.no-edit "--no-edit"} \

     

       165
       -
                   ${optionalString cfg.local-time "--local-time"} \

     

       166
       -
                   ${optionalString (cfg.allowUploads != null) "--allow-uploads ${cfg.allowUploads}"} \

     

       167
       -
                   ${optionalString (cfg.user-icons != null) "--user-icons ${cfg.user-icons}"} \

     

       168
        
                   ${cfg.stateDir}

     

       169
        
               '';

     

       170
        
             };

···

       4
        
         pkgs,

     

       5
        
         ...

     

       6
        
       }:

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       7
        
       let

     

       8
        
         cfg = config.services.gollum;

     

       9
        
       in

     

       10
        
       

     

       11
        
       {

     

       12
        
         imports = [

     

       13
       +
           (lib.mkRemovedOptionModule

     

       14
        
             [

     

       15
        
               "services"

     

       16
        
               "gollum"

     
···

       21
        
         ];

     

       22
        
       

     

       23
        
         options.services.gollum = {

     

       24
       +
           enable = lib.mkEnableOption "Gollum, a git-powered wiki service";

     

       25
        
       

     

       26
       +
           address = lib.mkOption {

     

       27
       +
             type = lib.types.str;

     

       28
        
             default = "0.0.0.0";

     

       29
        
             description = "IP address on which the web server will listen.";

     

       30
        
           };

     

       31
        
       

     

       32
       +
           port = lib.mkOption {

     

       33
       +
             type = lib.types.port;

     

       34
        
             default = 4567;

     

       35
        
             description = "Port on which the web server will run.";

     

       36
        
           };

     

       37
        
       

     

       38
       +
           extraConfig = lib.mkOption {

     

       39
       +
             type = lib.types.lines;

     

       40
        
             default = "";

     

       41
        
             description = "Content of the configuration file";

     

       42
        
           };

     

       43
        
       

     

       44
       +
           math = lib.mkOption {

     

       45
       +
             type = lib.types.bool;

     

       46
        
             default = false;

     

       47
        
             description = "Enable support for math rendering using KaTeX";

     

       48
        
           };

     

       49
        
       

     

       50
       +
           allowUploads = lib.mkOption {

     

       51
       +
             type = lib.types.nullOr (

     

       52
       +
               lib.types.enum [

     

       53
        
                 "dir"

     

       54
        
                 "page"

     

       55
        
               ]

     
···

       58
        
             description = "Enable uploads of external files";

     

       59
        
           };

     

       60
        
       

     

       61
       +
           user-icons = lib.mkOption {

     

       62
       +
             type = lib.types.nullOr (

     

       63
       +
               lib.types.enum [

     

       64
        
                 "gravatar"

     

       65
        
                 "identicon"

     

       66
        
               ]

     
···

       69
        
             description = "Enable specific user icons for history view";

     

       70
        
           };

     

       71
        
       

     

       72
       +
           emoji = lib.mkOption {

     

       73
       +
             type = lib.types.bool;

     

       74
        
             default = false;

     

       75
        
             description = "Parse and interpret emoji tags";

     

       76
        
           };

     

       77
        
       

     

       78
       +
           h1-title = lib.mkOption {

     

       79
       +
             type = lib.types.bool;

     

       80
        
             default = false;

     

       81
        
             description = "Use the first h1 as page title";

     

       82
        
           };

     

       83
        
       

     

       84
       +
           no-edit = lib.mkOption {

     

       85
       +
             type = lib.types.bool;

     

       86
        
             default = false;

     

       87
        
             description = "Disable editing pages";

     

       88
        
           };

     

       89
        
       

     

       90
       +
           local-time = lib.mkOption {

     

       91
       +
             type = lib.types.bool;

     

       92
        
             default = false;

     

       93
        
             description = "Use the browser's local timezone instead of the server's for displaying dates.";

     

       94
        
           };

     

       95
        
       

     

       96
       +
           branch = lib.mkOption {

     

       97
       +
             type = lib.types.str;

     

       98
        
             default = "master";

     

       99
        
             example = "develop";

     

       100
        
             description = "Git branch to serve";

     

       101
        
           };

     

       102
        
       

     

       103
       +
           stateDir = lib.mkOption {

     

       104
       +
             type = lib.types.path;

     

       105
        
             default = "/var/lib/gollum";

     

       106
        
             description = "Specifies the path of the repository directory. If it does not exist, Gollum will create it on startup.";

     

       107
        
           };

     

       108
        
       

     

       109
       +
           package = lib.mkPackageOption pkgs "gollum" { };

     

       110
        
       

     

       111
       +
           user = lib.mkOption {

     

       112
       +
             type = lib.types.str;

     

       113
        
             default = "gollum";

     

       114
        
             description = "Specifies the owner of the wiki directory";

     

       115
        
           };

     

       116
        
       

     

       117
       +
           group = lib.mkOption {

     

       118
       +
             type = lib.types.str;

     

       119
        
             default = "gollum";

     

       120
        
             description = "Specifies the owner group of the wiki directory";

     

       121
        
           };

     

       122
        
         };

     

       123
        
       

     

       124
       +
         config = lib.mkIf cfg.enable {

     

       125
        
       

     

       126
       +
           users.users.gollum = lib.mkIf (cfg.user == "gollum") {

     

       127
        
             group = cfg.group;

     

       128
        
             description = "Gollum user";

     

       129
        
             createHome = false;

     
···

       155
        
                   --host ${cfg.address} \

     

       156
        
                   --config ${pkgs.writeText "gollum-config.rb" cfg.extraConfig} \

     

       157
        
                   --ref ${cfg.branch} \

     

       158
       +
                   ${lib.optionalString cfg.math "--math"} \

     

       159
       +
                   ${lib.optionalString cfg.emoji "--emoji"} \

     

       160
       +
                   ${lib.optionalString cfg.h1-title "--h1-title"} \

     

       161
       +
                   ${lib.optionalString cfg.no-edit "--no-edit"} \

     

       162
       +
                   ${lib.optionalString cfg.local-time "--local-time"} \

     

       163
       +
                   ${lib.optionalString (cfg.allowUploads != null) "--allow-uploads ${cfg.allowUploads}"} \

     

       164
       +
                   ${lib.optionalString (cfg.user-icons != null) "--user-icons ${cfg.user-icons}"} \

     

       165
        
                   ${cfg.stateDir}

     

       166
        
               '';

     

       167
        
             };