commit a3c8d04684c8349a469b8f004a6eb6e2de7db101 · pyrox.dev/nixpkgs

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

···

       63
       63
        
       

     

       64
       64
        
       - [Kimai](https://www.kimai.org/), a web-based multi-user time-tracking application. Available as [services.kimai](options.html#opt-services.kimai).

     

       65
       65
        
       

     

       66
       66
       +
       - [Homer](https://homer-demo.netlify.app/), a very simple static homepage for your server. Available as [services.homer](options.html#opt-services.homer).

     

       67
       67
       +
       

     

       66
       68
        
       - [Omnom](https://github.com/asciimoo/omnom), a webpage bookmarking and snapshotting service. Available as [services.omnom](options.html#opt-services.omnom.enable).

     

       67
       69
        
       

     

       68
       70
        
       - [Yggdrasil-Jumper](https://github.com/one-d-wide/yggdrasil-jumper) is an independent project that aims to transparently reduce latency of a connection over Yggdrasil network, utilizing NAT traversal to automatically bypass intermediary nodes.

nixos/modules/module-list.nix

···

       1497
       1497
        
         ./services/web-apps/hedgedoc.nix

     

       1498
       1498
        
         ./services/web-apps/hledger-web.nix

     

       1499
       1499
        
         ./services/web-apps/homebox.nix

     

       1500
       1500
       +
         ./services/web-apps/homer.nix

     

       1500
       1501
        
         ./services/web-apps/honk.nix

     

       1501
       1502
        
         ./services/web-apps/icingaweb2/icingaweb2.nix

     

       1502
       1503
        
         ./services/web-apps/icingaweb2/module-monitoring.nix

+184

nixos/modules/services/web-apps/homer.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.homer;

     

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

     

       10
       10
       +
         configFile = settingsFormat.generate "homer-config.yml" cfg.settings;

     

       11
       11
       +
       in

     

       12
       12
       +
       {

     

       13
       13
       +
         options.services.homer = {

     

       14
       14
       +
           enable = lib.mkEnableOption ''

     

       15
       15
       +
             A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.

     

       16
       16
       +
           '';

     

       17
       17
       +
       

     

       18
       18
       +
           virtualHost = {

     

       19
       19
       +
             nginx.enable = lib.mkEnableOption "a virtualhost to serve homer through nginx";

     

       20
       20
       +
             caddy.enable = lib.mkEnableOption "a virtualhost to serve homer through caddy";

     

       21
       21
       +
       

     

       22
       22
       +
             domain = lib.mkOption {

     

       23
       23
       +
               description = ''

     

       24
       24
       +
                 Domain to use for the virtual host.

     

       25
       25
       +
       

     

       26
       26
       +
                 This can be used to change nginx options like

     

       27
       27
       +
                 ```nix

     

       28
       28
       +
                 services.nginx.virtualHosts."$\{config.services.homer.virtualHost.domain}".listen = [ ... ]

     

       29
       29
       +
                 ```

     

       30
       30
       +
                 or

     

       31
       31
       +
                 ```nix

     

       32
       32
       +
                 services.nginx.virtualHosts."example.com".listen = [ ... ]

     

       33
       33
       +
                 ```

     

       34
       34
       +
               '';

     

       35
       35
       +
               type = lib.types.str;

     

       36
       36
       +
             };

     

       37
       37
       +
           };

     

       38
       38
       +
       

     

       39
       39
       +
           package = lib.mkPackageOption pkgs "homer" { };

     

       40
       40
       +
       

     

       41
       41
       +
           settings = lib.mkOption {

     

       42
       42
       +
             default = { };

     

       43
       43
       +
             description = ''

     

       44
       44
       +
               Settings serialized into `config.yml` before build.

     

       45
       45
       +
               If left empty, the default configuration shipped with the package will be used instead.

     

       46
       46
       +
               For more information, see the [official documentation](https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md).

     

       47
       47
       +
       

     

       48
       48
       +
               Note that the full configuration will be written to the nix store as world readable, which may include secrets such as [api-keys](https://github.com/bastienwirtz/homer/blob/main/docs/customservices.md).

     

       49
       49
       +
       

     

       50
       50
       +
               To add files such as icons or backgrounds, you can reference them in line such as

     

       51
       51
       +
               ```nix

     

       52
       52
       +
               icon = "$\{./icon.png}";

     

       53
       53
       +
               ```

     

       54
       54
       +
               This will add the file to the nix store upon build, referencing it by file path as expected by Homer.

     

       55
       55
       +
             '';

     

       56
       56
       +
             example = ''

     

       57
       57
       +
               {

     

       58
       58
       +
                 title = "App dashboard";

     

       59
       59
       +
                 subtitle = "Homer";

     

       60
       60
       +
                 logo = "assets/logo.png";

     

       61
       61
       +
                 header = true;

     

       62
       62
       +
                 footer = ${"''"}

     

       63
       63
       +
                   <p>Created with <span class="has-text-danger">❤️</span> with

     

       64
       64
       +
                   <a href="https://bulma.io/">bulma</a>,

     

       65
       65
       +
                   <a href="https://vuejs.org/">vuejs</a> &

     

       66
       66
       +
                   <a href="https://fontawesome.com/">font awesome</a> //

     

       67
       67
       +
                   Fork me on <a href="https://github.com/bastienwirtz/homer">

     

       68
       68
       +
                   <i class="fab fa-github-alt"></i></a></p>

     

       69
       69
       +
                 ${"''"};

     

       70
       70
       +
                 columns = "3";

     

       71
       71
       +
                 connectivityCheck = true;

     

       72
       72
       +
       

     

       73
       73
       +
                 proxy = {

     

       74
       74
       +
                   useCredentials = false;

     

       75
       75
       +
                   headers = {

     

       76
       76
       +
                     Test = "Example";

     

       77
       77
       +
                     Test1 = "Example1";

     

       78
       78
       +
                   };

     

       79
       79
       +
                 };

     

       80
       80
       +
       

     

       81
       81
       +
                 defaults = {

     

       82
       82
       +
                   layout = "columns";

     

       83
       83
       +
                   colorTheme = "auto";

     

       84
       84
       +
                 };

     

       85
       85
       +
       

     

       86
       86
       +
                 theme = "default";

     

       87
       87
       +
       

     

       88
       88
       +
                 message = {

     

       89
       89
       +
                   style = "is-warning";

     

       90
       90
       +
                   title = "Optional message!";

     

       91
       91
       +
                   icon = "fa fa-exclamation-triangle";

     

       92
       92
       +
                   content = "Lorem ipsum dolor sit amet, consectetur adipiscing elit.";

     

       93
       93
       +
                 };

     

       94
       94
       +
       

     

       95
       95
       +
                 links = [

     

       96
       96
       +
                   {

     

       97
       97
       +
                     name = "Link 1";

     

       98
       98
       +
                     icon = "fab fa-github";

     

       99
       99
       +
                     url = "https://github.com/bastienwirtz/homer";

     

       100
       100
       +
                     target = "_blank";

     

       101
       101
       +
                   }

     

       102
       102
       +
                   {

     

       103
       103
       +
                     name = "link 2";

     

       104
       104
       +
                     icon = "fas fa-book";

     

       105
       105
       +
                     url = "https://github.com/bastienwirtz/homer";

     

       106
       106
       +
                   }

     

       107
       107
       +
                 ];

     

       108
       108
       +
       

     

       109
       109
       +
                 services = [

     

       110
       110
       +
                   {

     

       111
       111
       +
                     name = "Application";

     

       112
       112
       +
                     icon = "fas fa-code-branch";

     

       113
       113
       +
                     items = [

     

       114
       114
       +
                       {

     

       115
       115
       +
                         name = "Awesome app";

     

       116
       116
       +
                         logo = "assets/tools/sample.png";

     

       117
       117
       +
                         subtitle = "Bookmark example";

     

       118
       118
       +
                         tag = "app";

     

       119
       119
       +
                         keywords = "self hosted reddit";

     

       120
       120
       +
                         url = "https://www.reddit.com/r/selfhosted/";

     

       121
       121
       +
                         target = "_blank";

     

       122
       122
       +
                       }

     

       123
       123
       +
                       {

     

       124
       124
       +
                         name = "Another one";

     

       125
       125
       +
                         logo = "assets/tools/sample2.png";

     

       126
       126
       +
                         subtitle = "Another application";

     

       127
       127
       +
                         tag = "app";

     

       128
       128
       +
                         tagstyle = "is-success";

     

       129
       129
       +
                         url = "#";

     

       130
       130
       +
                       }

     

       131
       131
       +
                     ];

     

       132
       132
       +
                   }

     

       133
       133
       +
                   {

     

       134
       134
       +
                     name = "Other group";

     

       135
       135
       +
                     icon = "fas fa-heartbeat";

     

       136
       136
       +
                     items = [

     

       137
       137
       +
                       {

     

       138
       138
       +
                         name = "Pi-hole";

     

       139
       139
       +
                         logo = "assets/tools/sample.png";

     

       140
       140
       +
                         tag = "other";

     

       141
       141
       +
                         url = "http://192.168.0.151/admin";

     

       142
       142
       +
                         type = "PiHole";

     

       143
       143
       +
                         target = "_blank";

     

       144
       144
       +
                       }

     

       145
       145
       +
                     ];

     

       146
       146
       +
                   }

     

       147
       147
       +
                 ];

     

       148
       148
       +
               }

     

       149
       149
       +
       

     

       150
       150
       +
             '';

     

       151
       151
       +
             inherit (pkgs.formats.yaml { }) type;

     

       152
       152
       +
           };

     

       153
       153
       +
         };

     

       154
       154
       +
       

     

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

     

       156
       156
       +
           services.nginx = lib.mkIf cfg.virtualHost.nginx.enable {

     

       157
       157
       +
             enable = true;

     

       158
       158
       +
             virtualHosts."${cfg.virtualHost.domain}" = {

     

       159
       159
       +
               locations."/" = {

     

       160
       160
       +
                 root = cfg.package;

     

       161
       161
       +
                 tryFiles = "$uri /index.html";

     

       162
       162
       +
               };

     

       163
       163
       +
               locations."= /assets/config.yml" = {

     

       164
       164
       +
                 alias = configFile;

     

       165
       165
       +
               };

     

       166
       166
       +
             };

     

       167
       167
       +
           };

     

       168
       168
       +
           services.caddy = lib.mkIf cfg.virtualHost.caddy.enable {

     

       169
       169
       +
             enable = true;

     

       170
       170
       +
             virtualHosts."${cfg.virtualHost.domain}".extraConfig = ''

     

       171
       171
       +
               root * ${cfg.package}

     

       172
       172
       +
               file_server

     

       173
       173
       +
               handle_path /assets/config.yml {

     

       174
       174
       +
                 root * ${configFile}

     

       175
       175
       +
                 file_server

     

       176
       176
       +
               }

     

       177
       177
       +
             '';

     

       178
       178
       +
           };

     

       179
       179
       +
         };

     

       180
       180
       +
       

     

       181
       181
       +
         meta.maintainers = [

     

       182
       182
       +
           lib.maintainers.stunkymonkey

     

       183
       183
       +
         ];

     

       184
       184
       +
       }

nixos/tests/all-tests.nix

···

       436
       436
        
         hedgedoc = handleTest ./hedgedoc.nix {};

     

       437
       437
        
         herbstluftwm = handleTest ./herbstluftwm.nix {};

     

       438
       438
        
         homebox = handleTest ./homebox.nix {};

     

       439
       439
       +
         homer = handleTest ./homer {};

     

       439
       440
        
         homepage-dashboard = handleTest ./homepage-dashboard.nix {};

     

       440
       441
        
         honk = runTest ./honk.nix;

     

       441
       442
        
         installed-tests = pkgs.recurseIntoAttrs (handleTest ./installed-tests {});

+30

nixos/tests/homer/caddy.nix

···

       1
       1
       +
       import ../make-test-python.nix (

     

       2
       2
       +
         { lib, ... }:

     

       3
       3
       +
       

     

       4
       4
       +
         {

     

       5
       5
       +
           name = "homer-caddy";

     

       6
       6
       +
           meta.maintainers = with lib.maintainers; [ stunkymonkey ];

     

       7
       7
       +
       

     

       8
       8
       +
           nodes.machine =

     

       9
       9
       +
             { pkgs, ... }:

     

       10
       10
       +
             {

     

       11
       11
       +
               services.homer = {

     

       12
       12
       +
                 enable = true;

     

       13
       13
       +
                 virtualHost = {

     

       14
       14
       +
                   caddy.enable = true;

     

       15
       15
       +
                   domain = "localhost:80";

     

       16
       16
       +
                 };

     

       17
       17
       +
                 settings = {

     

       18
       18
       +
                   title = "testing";

     

       19
       19
       +
                 };

     

       20
       20
       +
               };

     

       21
       21
       +
             };

     

       22
       22
       +
       

     

       23
       23
       +
           testScript = ''

     

       24
       24
       +
             machine.wait_for_unit("caddy.service")

     

       25
       25
       +
             machine.wait_for_open_port(80)

     

       26
       26
       +
             machine.succeed("curl --fail --show-error --silent http://localhost:80/ | grep '<title>Homer</title>'")

     

       27
       27
       +
             machine.succeed("curl --fail --show-error --silent http://localhost:80/assets/config.yml | grep 'title: testing'")

     

       28
       28
       +
           '';

     

       29
       29
       +
         }

     

       30
       30
       +
       )

nixos/tests/homer/default.nix

···

       1
       1
       +
       { system, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       {

     

       4
       4
       +
         caddy = import ./caddy.nix { inherit system pkgs; };

     

       5
       5
       +
         nginx = import ./nginx.nix { inherit system pkgs; };

     

       6
       6
       +
       }

+30

nixos/tests/homer/nginx.nix

···

       1
       1
       +
       import ../make-test-python.nix (

     

       2
       2
       +
         { lib, ... }:

     

       3
       3
       +
       

     

       4
       4
       +
         {

     

       5
       5
       +
           name = "homer-nginx";

     

       6
       6
       +
           meta.maintainers = with lib.maintainers; [ stunkymonkey ];

     

       7
       7
       +
       

     

       8
       8
       +
           nodes.machine =

     

       9
       9
       +
             { pkgs, ... }:

     

       10
       10
       +
             {

     

       11
       11
       +
               services.homer = {

     

       12
       12
       +
                 enable = true;

     

       13
       13
       +
                 virtualHost = {

     

       14
       14
       +
                   nginx.enable = true;

     

       15
       15
       +
                   domain = "localhost";

     

       16
       16
       +
                 };

     

       17
       17
       +
                 settings = {

     

       18
       18
       +
                   title = "testing";

     

       19
       19
       +
                 };

     

       20
       20
       +
               };

     

       21
       21
       +
             };

     

       22
       22
       +
       

     

       23
       23
       +
           testScript = ''

     

       24
       24
       +
             machine.wait_for_unit("nginx.service")

     

       25
       25
       +
             machine.wait_for_open_port(80)

     

       26
       26
       +
             machine.succeed("curl --fail --show-error --silent http://localhost:80/ | grep '<title>Homer</title>'")

     

       27
       27
       +
             machine.succeed("curl --fail --show-error --silent http://localhost:80/assets/config.yml | grep 'title: testing'")

     

       28
       28
       +
           '';

     

       29
       29
       +
         }

     

       30
       30
       +
       )

+7 -1

pkgs/by-name/ho/homer/package.nix

···

       6
       6
        
         nodejs,

     

       7
       7
        
         dart-sass,

     

       8
       8
        
         nix-update-script,

     

       9
       9
       +
         nixosTests,

     

       9
       10
        
       }:

     

       10
       11
        
       stdenvNoCC.mkDerivation rec {

     

       11
       12
        
         pname = "homer";

     
···

       54
       55
        
           runHook postInstall

     

       55
       56
        
         '';

     

       56
       57
        
       

     

       57
       57
       -
         passthru.updateScript = nix-update-script { };

     

       58
       58
       +
         passthru = {

     

       59
       59
       +
           updateScript = nix-update-script { };

     

       60
       60
       +
           tests = {

     

       61
       61
       +
             inherit (nixosTests.homer) caddy nginx;

     

       62
       62
       +
           };

     

       63
       63
       +
         };

     

       58
       64
        
       

     

       59
       65
        
         meta = with lib; {

     

       60
       66
        
           description = "A very simple static homepage for your server.";