commit f1daa46d4547cd5c8c36ab6679bfe7932aa738a7 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2411.section.md

···

       113
       113
        
       

     

       114
       114
        
       - [Localsend](https://localsend.org/), an open source cross-platform alternative to AirDrop. Available as [programs.localsend](#opt-programs.localsend.enable).

     

       115
       115
        
       

     

       116
       116
       +
       - [Gatus](https://github.com/TwiN/gatus), an automated developer-oriented status page. Available as [services.gatus](#opt-services.gatus.enable).

     

       117
       117
       +
       

     

       116
       118
        
       - [cryptpad](https://cryptpad.org/), a privacy-oriented collaborative platform (docs/drive/etc), has been added back. Available as [services.cryptpad](#opt-services.cryptpad.enable).

     

       117
       119
        
       

     

       118
       120
        
       - [realm](https://github.com/zhboner/realm), a simple, high performance relay server written in rust. Available as [services.realm.enable](#opt-services.realm.enable).

nixos/modules/module-list.nix

···

       882
       882
        
         ./services/monitoring/datadog-agent.nix

     

       883
       883
        
         ./services/monitoring/do-agent.nix

     

       884
       884
        
         ./services/monitoring/fusion-inventory.nix

     

       885
       885
       +
         ./services/monitoring/gatus.nix

     

       885
       886
        
         ./services/monitoring/goss.nix

     

       886
       887
        
         ./services/monitoring/grafana-agent.nix

     

       887
       888
        
         ./services/monitoring/grafana-image-renderer.nix

+132

nixos/modules/services/monitoring/gatus.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         pkgs,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         config,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.gatus;

     

       9
       9
       +
       

     

       10
       10
       +
         settingsFormat = pkgs.formats.yaml { };

     

       11
       11
       +
       

     

       12
       12
       +
         inherit (lib)

     

       13
       13
       +
           getExe

     

       14
       14
       +
           literalExpression

     

       15
       15
       +
           maintainers

     

       16
       16
       +
           mkEnableOption

     

       17
       17
       +
           mkIf

     

       18
       18
       +
           mkOption

     

       19
       19
       +
           mkPackageOption

     

       20
       20
       +
           ;

     

       21
       21
       +
       

     

       22
       22
       +
         inherit (lib.types)

     

       23
       23
       +
           bool

     

       24
       24
       +
           int

     

       25
       25
       +
           nullOr

     

       26
       26
       +
           path

     

       27
       27
       +
           submodule

     

       28
       28
       +
           ;

     

       29
       29
       +
       in

     

       30
       30
       +
       {

     

       31
       31
       +
         options.services.gatus = {

     

       32
       32
       +
           enable = mkEnableOption "Gatus";

     

       33
       33
       +
       

     

       34
       34
       +
           package = mkPackageOption pkgs "gatus" { };

     

       35
       35
       +
       

     

       36
       36
       +
           configFile = mkOption {

     

       37
       37
       +
             type = path;

     

       38
       38
       +
             default = settingsFormat.generate "gatus.yaml" cfg.settings;

     

       39
       39
       +
             defaultText = literalExpression ''

     

       40
       40
       +
               let settingsFormat = pkgs.formats.yaml { }; in settingsFormat.generate "gatus.yaml" cfg.settings;

     

       41
       41
       +
             '';

     

       42
       42
       +
             description = ''

     

       43
       43
       +
               Path to the Gatus configuration file.

     

       44
       44
       +
               Overrides any configuration made using the `settings` option.

     

       45
       45
       +
             '';

     

       46
       46
       +
           };

     

       47
       47
       +
       

     

       48
       48
       +
           environmentFile = mkOption {

     

       49
       49
       +
             type = nullOr path;

     

       50
       50
       +
             default = null;

     

       51
       51
       +
             description = ''

     

       52
       52
       +
               File to load as environment file.

     

       53
       53
       +
               Environmental variables from this file can be interpolated in the configuration file using `''${VARIABLE}`.

     

       54
       54
       +
               This is useful to avoid putting secrets into the nix store.

     

       55
       55
       +
             '';

     

       56
       56
       +
           };

     

       57
       57
       +
       

     

       58
       58
       +
           settings = mkOption {

     

       59
       59
       +
             type = submodule {

     

       60
       60
       +
               freeformType = settingsFormat.type;

     

       61
       61
       +
               options = {

     

       62
       62
       +
                 web.port = mkOption {

     

       63
       63
       +
                   type = int;

     

       64
       64
       +
                   default = 8080;

     

       65
       65
       +
                   description = ''

     

       66
       66
       +
                     The TCP port to serve the Gatus service at.

     

       67
       67
       +
                   '';

     

       68
       68
       +
                 };

     

       69
       69
       +
               };

     

       70
       70
       +
             };

     

       71
       71
       +
       

     

       72
       72
       +
             default = { };

     

       73
       73
       +
       

     

       74
       74
       +
             example = literalExpression ''

     

       75
       75
       +
               {

     

       76
       76
       +
                 web.port = 8080;

     

       77
       77
       +
                 endpoints = [{

     

       78
       78
       +
                   name = "website";

     

       79
       79
       +
                   url = "https://twin.sh/health";

     

       80
       80
       +
                   interval = "5m";

     

       81
       81
       +
                   conditions = [

     

       82
       82
       +
                     "[STATUS] == 200"

     

       83
       83
       +
                     "[BODY].status == UP"

     

       84
       84
       +
                     "[RESPONSE_TIME] < 300"

     

       85
       85
       +
                   ];

     

       86
       86
       +
                 }];

     

       87
       87
       +
               }

     

       88
       88
       +
             '';

     

       89
       89
       +
       

     

       90
       90
       +
             description = ''

     

       91
       91
       +
               Configuration for Gatus.

     

       92
       92
       +
               Supported options can be found at the [docs](https://gatus.io/docs).

     

       93
       93
       +
             '';

     

       94
       94
       +
           };

     

       95
       95
       +
       

     

       96
       96
       +
           openFirewall = mkOption {

     

       97
       97
       +
             type = bool;

     

       98
       98
       +
             default = false;

     

       99
       99
       +
             description = ''

     

       100
       100
       +
               Whether to open the firewall for the Gatus web interface.

     

       101
       101
       +
             '';

     

       102
       102
       +
           };

     

       103
       103
       +
         };

     

       104
       104
       +
       

     

       105
       105
       +
         config = mkIf cfg.enable {

     

       106
       106
       +
           systemd.services.gatus = {

     

       107
       107
       +
             description = "Automated developer-oriented status page";

     

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

     

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

     

       110
       110
       +
       

     

       111
       111
       +
             serviceConfig = {

     

       112
       112
       +
               DynamicUser = true;

     

       113
       113
       +
               User = "gatus";

     

       114
       114
       +
               Group = "gatus";

     

       115
       115
       +
               Type = "simple";

     

       116
       116
       +
               Restart = "on-failure";

     

       117
       117
       +
               ExecStart = getExe cfg.package;

     

       118
       118
       +
               StateDirectory = "gatus";

     

       119
       119
       +
               SyslogIdentifier = "gatus";

     

       120
       120
       +
               EnvironmentFile = lib.optional (cfg.environmentFile != null) cfg.environmentFile;

     

       121
       121
       +
             };

     

       122
       122
       +
       

     

       123
       123
       +
             environment = {

     

       124
       124
       +
               GATUS_CONFIG_PATH = cfg.configFile;

     

       125
       125
       +
             };

     

       126
       126
       +
           };

     

       127
       127
       +
       

     

       128
       128
       +
           networking.firewall.allowedTCPPorts = lib.optionals cfg.openFirewall [ cfg.settings.web.port ];

     

       129
       129
       +
         };

     

       130
       130
       +
       

     

       131
       131
       +
         meta.maintainers = with maintainers; [ pizzapim ];

     

       132
       132
       +
       }

nixos/tests/all-tests.nix

···

       365
       365
        
         mimir = handleTest ./mimir.nix {};

     

       366
       366
        
         gancio = handleTest ./gancio.nix {};

     

       367
       367
        
         garage = handleTest ./garage {};

     

       368
       368
       +
         gatus = runTest ./gatus.nix;

     

       368
       369
        
         gemstash = handleTest ./gemstash.nix {};

     

       369
       370
        
         geoserver = runTest ./geoserver.nix;

     

       370
       371
        
         gerrit = handleTest ./gerrit.nix {};

+34

nixos/tests/gatus.nix

···

       1
       1
       +
       { pkgs, ... }:

     

       2
       2
       +
       {

     

       3
       3
       +
         name = "gatus";

     

       4
       4
       +
         meta.maintainers = with pkgs.lib.maintainers; [ pizzapim ];

     

       5
       5
       +
       

     

       6
       6
       +
         nodes.machine =

     

       7
       7
       +
           { ... }:

     

       8
       8
       +
           {

     

       9
       9
       +
             services.gatus = {

     

       10
       10
       +
               enable = true;

     

       11
       11
       +
       

     

       12
       12
       +
               settings = {

     

       13
       13
       +
                 web.port = 8080;

     

       14
       14
       +
                 metrics = true;

     

       15
       15
       +
       

     

       16
       16
       +
                 endpoints = [

     

       17
       17
       +
                   {

     

       18
       18
       +
                     name = "metrics";

     

       19
       19
       +
                     url = "http://localhost:8080/metrics";

     

       20
       20
       +
                     interval = "1s";

     

       21
       21
       +
                     conditions = [

     

       22
       22
       +
                       "[STATUS] == 200"

     

       23
       23
       +
                     ];

     

       24
       24
       +
                   }

     

       25
       25
       +
                 ];

     

       26
       26
       +
               };

     

       27
       27
       +
             };

     

       28
       28
       +
           };

     

       29
       29
       +
       

     

       30
       30
       +
         testScript = ''

     

       31
       31
       +
           machine.wait_for_unit("gatus.service")

     

       32
       32
       +
           machine.succeed("curl -s http://localhost:8080/metrics | grep go_info")

     

       33
       33
       +
         '';

     

       34
       34
       +
       }