commit ce6e5f037a83642e6864a8738b1c174aa691046d · pyrox.dev/nixpkgs

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

···

       62
       62
        
       

     

       63
       63
        
       - [vwifi](https://github.com/Raizo62/vwifi), a Wi-Fi simulator daemon leveraging the `mac80211_hwsim` and `vhost_vsock` kernel modules for efficient simulation of multi-node Wi-Fi networks. Available as {option}`services.vwifi`.

     

       64
       64
        
       

     

       65
       65
       +
       - [Oncall](https://oncall.tools), a web-based calendar tool designed for scheduling and managing on-call shifts. Available as [services.oncall](options.html#opt-services.oncall).

     

       66
       66
       +
       

     

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

     

       66
       68
        
       

     

       67
       69
        
       - [Ghidra](https://ghidra-sre.org/), a software reverse engineering (SRE) suite of tools. Available as [programs.ghidra](options.html#opt-programs.ghidra).

nixos/modules/module-list.nix

···

       1608
       1608
        
         ./services/web-apps/nostr-rs-relay.nix

     

       1609
       1609
        
         ./services/web-apps/ocis.nix

     

       1610
       1610
        
         ./services/web-apps/olivetin.nix

     

       1611
       1611
       +
         ./services/web-apps/oncall.nix

     

       1611
       1612
        
         ./services/web-apps/onlyoffice.nix

     

       1612
       1613
        
         ./services/web-apps/open-web-calendar.nix

     

       1613
       1614
        
         ./services/web-apps/openvscode-server.nix

+203

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

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
       

     

       9
       9
       +
         cfg = config.services.oncall;

     

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

     

       11
       11
       +
         configFile = settingsFormat.generate "oncall_extra_settings.yaml" cfg.settings;

     

       12
       12
       +
       

     

       13
       13
       +
       in

     

       14
       14
       +
       {

     

       15
       15
       +
         options.services.oncall = {

     

       16
       16
       +
       

     

       17
       17
       +
           enable = lib.mkEnableOption "Oncall web app";

     

       18
       18
       +
       

     

       19
       19
       +
           package = lib.mkPackageOption pkgs "oncall" { };

     

       20
       20
       +
       

     

       21
       21
       +
           database.createLocally = lib.mkEnableOption "Create the database and database user locally." // {

     

       22
       22
       +
             default = true;

     

       23
       23
       +
           };

     

       24
       24
       +
       

     

       25
       25
       +
           settings = lib.mkOption {

     

       26
       26
       +
             type = lib.types.submodule {

     

       27
       27
       +
               freeformType = settingsFormat.type;

     

       28
       28
       +
               options = {

     

       29
       29
       +
                 oncall_host = lib.mkOption {

     

       30
       30
       +
                   type = lib.types.str;

     

       31
       31
       +
                   default = "localhost";

     

       32
       32
       +
                   description = "FQDN for the Oncall instance.";

     

       33
       33
       +
                 };

     

       34
       34
       +
                 db.conn = {

     

       35
       35
       +
                   kwargs = {

     

       36
       36
       +
                     user = lib.mkOption {

     

       37
       37
       +
                       type = lib.types.str;

     

       38
       38
       +
                       default = "oncall";

     

       39
       39
       +
                       description = "Database user.";

     

       40
       40
       +
                     };

     

       41
       41
       +
                     host = lib.mkOption {

     

       42
       42
       +
                       type = lib.types.str;

     

       43
       43
       +
                       default = "localhost";

     

       44
       44
       +
                       description = "Database host.";

     

       45
       45
       +
                     };

     

       46
       46
       +
                     database = lib.mkOption {

     

       47
       47
       +
                       type = lib.types.str;

     

       48
       48
       +
                       default = "oncall";

     

       49
       49
       +
                       description = "Database name.";

     

       50
       50
       +
                     };

     

       51
       51
       +
                   };

     

       52
       52
       +
                   str = lib.mkOption {

     

       53
       53
       +
                     type = lib.types.str;

     

       54
       54
       +
                     default = "%(scheme)s://%(user)s@%(host)s:%(port)s/%(database)s?charset=%(charset)s&unix_socket=/run/mysqld/mysqld.sock";

     

       55
       55
       +
                     description = ''

     

       56
       56
       +
                       Database connection scheme. The default specifies the

     

       57
       57
       +
                       connection through a local socket.

     

       58
       58
       +
                     '';

     

       59
       59
       +
                   };

     

       60
       60
       +
                   require_auth = lib.mkOption {

     

       61
       61
       +
                     type = lib.types.bool;

     

       62
       62
       +
                     default = true;

     

       63
       63
       +
                     description = ''

     

       64
       64
       +
                       Whether authentication is required to access the web app.

     

       65
       65
       +
                     '';

     

       66
       66
       +
                   };

     

       67
       67
       +
                 };

     

       68
       68
       +
               };

     

       69
       69
       +
             };

     

       70
       70
       +
             default = { };

     

       71
       71
       +
             description = ''

     

       72
       72
       +
               Extra configuration options to append or override.

     

       73
       73
       +
               For available and default option values see

     

       74
       74
       +
               [upstream configuration file](https://github.com/linkedin/oncall/blob/master/configs/config.yaml)

     

       75
       75
       +
               and the administration part in the

     

       76
       76
       +
               [offical documentation](https://oncall.tools/docs/admin_guide.html).

     

       77
       77
       +
             '';

     

       78
       78
       +
           };

     

       79
       79
       +
       

     

       80
       80
       +
           secretFile = lib.mkOption {

     

       81
       81
       +
             type = lib.types.pathWith {

     

       82
       82
       +
               inStore = false;

     

       83
       83
       +
               absolute = true;

     

       84
       84
       +
             };

     

       85
       85
       +
             example = "/run/keys/oncall-dbpassword";

     

       86
       86
       +
             description = ''

     

       87
       87
       +
               A YAML file containing secrets such as database or user passwords.

     

       88
       88
       +
               Some variables that can be considered secrets are:

     

       89
       89
       +
       

     

       90
       90
       +
               - db.conn.kwargs.password:

     

       91
       91
       +
                 Password used to authenticate to the database.

     

       92
       92
       +
       

     

       93
       93
       +
               - session.encrypt_key:

     

       94
       94
       +
                 Key for encrypting/signing session cookies.

     

       95
       95
       +
                 Change to random long values in production.

     

       96
       96
       +
       

     

       97
       97
       +
               - session.sign_key:

     

       98
       98
       +
                 Key for encrypting/signing session cookies.

     

       99
       99
       +
                 Change to random long values in production.

     

       100
       100
       +
             '';

     

       101
       101
       +
           };

     

       102
       102
       +
       

     

       103
       103
       +
         };

     

       104
       104
       +
       

     

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

     

       106
       106
       +
       

     

       107
       107
       +
           # Disable debug, only needed for development

     

       108
       108
       +
           services.oncall.settings = lib.mkMerge [

     

       109
       109
       +
             ({

     

       110
       110
       +
               debug = lib.mkDefault false;

     

       111
       111
       +
               auth.debug = lib.mkDefault false;

     

       112
       112
       +
             })

     

       113
       113
       +
           ];

     

       114
       114
       +
       

     

       115
       115
       +
           services.uwsgi = {

     

       116
       116
       +
             enable = true;

     

       117
       117
       +
             plugins = [ "python3" ];

     

       118
       118
       +
             user = "oncall";

     

       119
       119
       +
             instance = {

     

       120
       120
       +
               type = "emperor";

     

       121
       121
       +
               vassals = {

     

       122
       122
       +
                 oncall = {

     

       123
       123
       +
                   type = "normal";

     

       124
       124
       +
                   env = [

     

       125
       125
       +
                     "PYTHONPATH=${pkgs.oncall.pythonPath}"

     

       126
       126
       +
                     (

     

       127
       127
       +
                       "ONCALL_EXTRA_CONFIG="

     

       128
       128
       +
                       + (lib.concatStringsSep "," (

     

       129
       129
       +
                         [ configFile ] ++ lib.optional (cfg.secretFile != null) cfg.secretFile

     

       130
       130
       +
                       ))

     

       131
       131
       +
                     )

     

       132
       132
       +
                     "STATIC_ROOT=/var/lib/oncall"

     

       133
       133
       +
                   ];

     

       134
       134
       +
                   module = "oncall.app:get_wsgi_app()";

     

       135
       135
       +
                   socket = "${config.services.uwsgi.runDir}/oncall.sock";

     

       136
       136
       +
                   socketGroup = "nginx";

     

       137
       137
       +
                   immediate-gid = "nginx";

     

       138
       138
       +
                   chmod-socket = "770";

     

       139
       139
       +
                   pyargv = "${pkgs.oncall}/share/configs/config.yaml";

     

       140
       140
       +
                   buffer-size = 32768;

     

       141
       141
       +
                 };

     

       142
       142
       +
               };

     

       143
       143
       +
             };

     

       144
       144
       +
           };

     

       145
       145
       +
       

     

       146
       146
       +
           services.nginx = {

     

       147
       147
       +
             enable = lib.mkDefault true;

     

       148
       148
       +
             virtualHosts."${cfg.settings.oncall_host}".locations = {

     

       149
       149
       +
               "/".extraConfig = "uwsgi_pass unix://${config.services.uwsgi.runDir}/oncall.sock;";

     

       150
       150
       +
             };

     

       151
       151
       +
           };

     

       152
       152
       +
       

     

       153
       153
       +
           services.mysql = lib.mkIf cfg.database.createLocally {

     

       154
       154
       +
             enable = true;

     

       155
       155
       +
             package = lib.mkDefault pkgs.mariadb;

     

       156
       156
       +
             ensureDatabases = [ cfg.settings.db.conn.kwargs.database ];

     

       157
       157
       +
             ensureUsers = [

     

       158
       158
       +
               {

     

       159
       159
       +
                 name = cfg.settings.db.conn.kwargs.user;

     

       160
       160
       +
                 ensurePermissions = {

     

       161
       161
       +
                   "${cfg.settings.db.conn.kwargs.database}.*" = "ALL PRIVILEGES";

     

       162
       162
       +
                 };

     

       163
       163
       +
               }

     

       164
       164
       +
             ];

     

       165
       165
       +
           };

     

       166
       166
       +
       

     

       167
       167
       +
           users.users.oncall = {

     

       168
       168
       +
             group = "nginx";

     

       169
       169
       +
             isSystemUser = true;

     

       170
       170
       +
           };

     

       171
       171
       +
       

     

       172
       172
       +
           systemd = {

     

       173
       173
       +
             services = {

     

       174
       174
       +
               uwsgi.serviceConfig.StateDirectory = "oncall";

     

       175
       175
       +
               oncall-setup-database = lib.mkIf cfg.database.createLocally {

     

       176
       176
       +
                 description = "Set up Oncall database";

     

       177
       177
       +
                 serviceConfig = {

     

       178
       178
       +
                   Type = "oneshot";

     

       179
       179
       +
                   RemainAfterExit = true;

     

       180
       180
       +
                 };

     

       181
       181
       +
                 requiredBy = [ "uwsgi.service" ];

     

       182
       182
       +
                 after = [ "mysql.service" ];

     

       183
       183
       +
                 script =

     

       184
       184
       +
                   let

     

       185
       185
       +
                     mysql = "${lib.getExe' config.services.mysql.package "mysql"}";

     

       186
       186
       +
                   in

     

       187
       187
       +
                   ''

     

       188
       188
       +
                     if [ ! -f /var/lib/oncall/.dbexists ]; then

     

       189
       189
       +
                       # Load database schema provided with package

     

       190
       190
       +
                       ${mysql} ${cfg.settings.db.conn.kwargs.database} < ${cfg.package}/share/db/schema.v0.sql

     

       191
       191
       +
                       ${mysql} ${cfg.settings.db.conn.kwargs.database} < ${cfg.package}/share/db/schema-update.v0-1602184489.sql

     

       192
       192
       +
                       touch /var/lib/oncall/.dbexists

     

       193
       193
       +
                     fi

     

       194
       194
       +
                   '';

     

       195
       195
       +
               };

     

       196
       196
       +
             };

     

       197
       197
       +
           };

     

       198
       198
       +
       

     

       199
       199
       +
         };

     

       200
       200
       +
       

     

       201
       201
       +
         meta.maintainers = with lib.maintainers; [ onny ];

     

       202
       202
       +
       

     

       203
       203
       +
       }