commit 3eeff54780a1a8c73c82ca51987962b62bd4219e · pyrox.dev/nixpkgs

+1 -2

nixos/doc/manual/configuration/profiles/headless.section.md

···

       2
       2
        
       

     

       3
       3
        
       Common configuration for headless machines (e.g., Amazon EC2 instances).

     

       4
       4
        
       

     

       5
       5
       -
       Disables [sound](#opt-sound.enable),

     

       6
       6
       -
       [vesa](#opt-boot.vesa), serial consoles,

     

       5
       5
       +
       Disables [vesa](#opt-boot.vesa), serial consoles,

     

       7
       6
        
       [emergency mode](#opt-systemd.enableEmergencyMode),

     

       8
       7
        
       [grub splash images](#opt-boot.loader.grub.splashImage)

     

       9
       8
        
       and configures the kernel to reboot automatically on panic.

+1 -2

nixos/doc/manual/configuration/profiles/minimal.section.md

···

       5
       5
        
       [noXlibs](#opt-environment.noXlibs), sets

     

       6
       6
        
       [](#opt-i18n.supportedLocales) to

     

       7
       7
        
       only support the user-selected locale,

     

       8
       8
       -
       [disables packages' documentation](#opt-documentation.enable),

     

       9
       9
       -
       and [disables sound](#opt-sound.enable).

     

       8
       8
       +
       and [disables packages' documentation](#opt-documentation.enable).

+45

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

···

       197
       197
        
       

     

       198
       198
        
       - `services.roundcube.maxAttachmentSize` will multiply the value set with `1.37` to offset overhead introduced by the base64 encoding applied to attachments.

     

       199
       199
        
       

     

       200
       200
       +
       - The `sound` options have been removed or renamed, as they had a lot of unintended side effects. See [below](#sec-release-24.11-migration-sound) for details.

     

       201
       201
       +
       

     

       200
       202
        
       - The `services.mxisd` module has been removed as both [mxisd](https://github.com/kamax-matrix/mxisd) and [ma1sd](https://github.com/ma1uta/ma1sd) are not maintained any longer.

     

       201
       203
        
         Consequently the package `pkgs.ma1sd` has also been removed.

     

       202
       204
        
       

     
···

       233
       235
        
         should be changed to using *runner authentication tokens* by configuring

     

       234
       236
        
         {option}`services.gitlab-runner.services.<name>.authenticationTokenConfigFile` instead of the former

     

       235
       237
        
         {option}`services.gitlab-runner.services.<name>.registrationConfigFile` option.

     

       238
       238
       +
       

     

       239
       239
       +
       ## Detailed migration information {#sec-release-24.11-migration}

     

       240
       240
       +
       

     

       241
       241
       +
       ### `sound` options removal {#sec-release-24.11-migration-sound}

     

       242
       242
       +
       

     

       243
       243
       +
       The `sound` options have been largely removed, as they are unnecessary for most modern setups, and cause issues when enabled.

     

       244
       244
       +
       

     

       245
       245
       +
       If you set `sound.enable` in your configuration:

     

       246
       246
       +
         - If you are using Pulseaudio or PipeWire, simply remove that option

     

       247
       247
       +
         - If you are not using an external sound server, and want volumes to be persisted across shutdowns, set `hardware.alsa.enablePersistence = true` instead

     

       248
       248
       +
       

     

       249
       249
       +
       If you set `sound.enableOSSEmulation` in your configuration:

     

       250
       250
       +
         - Make sure it is still necessary, as very few applications actually use OSS

     

       251
       251
       +
         - If necessary, set `boot.kernelModules = [ "snd_pcm_oss" ]`

     

       252
       252
       +
       

     

       253
       253
       +
       If you set `sound.extraConfig` in your configuration:

     

       254
       254
       +
         - If you are using another sound server, like Pulseaudio, JACK or PipeWire, migrate your configuration to that

     

       255
       255
       +
         - If you are not using an external sound server, set `environment.etc."asound.conf".text = yourExtraConfig` instead

     

       256
       256
       +
       

     

       257
       257
       +
       If you set `sound.mediaKeys` in your configuration:

     

       258
       258
       +
         - Preferably switch to handling media keys in your desktop environment/compositor

     

       259
       259
       +
         - If you want to maintain the exact behavior of the option, use the following snippet

     

       260
       260
       +
       

     

       261
       261
       +
       ```nix

     

       262
       262
       +
       services.actkbd = let

     

       263
       263
       +
         volumeStep = "1%";

     

       264
       264
       +
       in {

     

       265
       265
       +
         enable = true;

     

       266
       266
       +
         bindings = [

     

       267
       267
       +
           # "Mute" media key

     

       268
       268
       +
           { keys = [ 113 ]; events = [ "key" ];       command = "${alsa-utils}/bin/amixer -q set Master toggle"; }

     

       269
       269
       +
       

     

       270
       270
       +
           # "Lower Volume" media key

     

       271
       271
       +
           { keys = [ 114 ]; events = [ "key" "rep" ]; command = "${alsa-utils}/bin/amixer -q set Master ${volumeStep}- unmute"; }

     

       272
       272
       +
       

     

       273
       273
       +
           # "Raise Volume" media key

     

       274
       274
       +
           { keys = [ 115 ]; events = [ "key" "rep" ]; command = "${alsa-utils}/bin/amixer -q set Master ${volumeStep}+ unmute"; }

     

       275
       275
       +
       

     

       276
       276
       +
           # "Mic Mute" media key

     

       277
       277
       +
           { keys = [ 190 ]; events = [ "key" ];       command = "${alsa-utils}/bin/amixer -q set Capture toggle"; }

     

       278
       278
       +
         ];

     

       279
       279
       +
       };

     

       280
       280
       +
       ```

+3 -7

nixos/modules/config/pulseaudio.nix

···

       6
       6
        
       let

     

       7
       7
        
       

     

       8
       8
        
         cfg = config.hardware.pulseaudio;

     

       9
       9
       -
         alsaCfg = config.sound;

     

       10
       9
        
       

     

       11
       10
        
         hasZeroconf = let z = cfg.zeroconf; in z.publish.enable || z.discovery.enable;

     

       12
       11
        
       

     
···

       58
       57
        
         # Write an /etc/asound.conf that causes all ALSA applications to

     

       59
       58
        
         # be re-routed to the PulseAudio server through ALSA's Pulse

     

       60
       59
        
         # plugin.

     

       61
       61
       -
         alsaConf = writeText "asound.conf" (''

     

       60
       60
       +
         alsaConf = ''

     

       62
       61
        
           pcm_type.pulse {

     

       63
       62
        
             libs.native = ${pkgs.alsa-plugins}/lib/alsa-lib/libasound_module_pcm_pulse.so ;

     

       64
       63
        
             ${lib.optionalString enable32BitAlsaPlugins

     
···

       76
       75
        
           ctl.!default {

     

       77
       76
        
             type pulse

     

       78
       77
        
           }

     

       79
       79
       -
           ${alsaCfg.extraConfig}

     

       80
       80
       -
         '');

     

       78
       78
       +
         '';

     

       81
       79
        
       

     

       82
       80
        
       in {

     

       83
       81
        
       

     
···

       221
       219
        
       

     

       222
       220
        
             environment.systemPackages = [ overriddenPackage ];

     

       223
       221
        
       

     

       224
       224
       -
             sound.enable = true;

     

       225
       225
       -
       

     

       226
       222
        
             environment.etc = {

     

       227
       227
       -
               "asound.conf".source = alsaConf;

     

       223
       223
       +
               "alsa/conf.d/99-pulseaudio.conf".text = alsaConf;

     

       228
       224
        
       

     

       229
       225
        
               "pulse/daemon.conf".source = writeText "daemon.conf"

     

       230
       226
        
                 (lib.generators.toKeyValue {} cfg.daemon.config);

+22 -116

nixos/modules/services/audio/alsa.nix

···

       3
       3
        
       

     

       4
       4
        
       with lib;

     

       5
       5
        
       

     

       6
       6
       -
       let

     

       7
       7
       -
       

     

       8
       8
       -
         inherit (pkgs) alsa-utils;

     

       9
       9
       -
       

     

       10
       10
       -
         pulseaudioEnabled = config.hardware.pulseaudio.enable;

     

       11
       11
       -
       

     

       12
       12
       -
       in

     

       13
       13
       -
       

     

       14
       6
        
       {

     

       15
       7
        
         imports = [

     

       16
       16
       -
           (mkRenamedOptionModule [ "sound" "enableMediaKeys" ] [ "sound" "mediaKeys" "enable" ])

     

       8
       8
       +
           (mkRemovedOptionModule [ "sound" ] "The option was heavily overloaded and can be removed from most configurations.")

     

       17
       9
        
         ];

     

       18
       10
        
       

     

       19
       19
       -
         ###### interface

     

       20
       20
       -
       

     

       21
       21
       -
         options = {

     

       22
       22
       -
       

     

       23
       23
       -
           sound = {

     

       24
       24
       -
       

     

       25
       25
       -
             enable = mkOption {

     

       26
       26
       -
               type = types.bool;

     

       27
       27
       -
               default = false;

     

       28
       28
       -
               description = ''

     

       29
       29
       -
                 Whether to enable ALSA sound.

     

       30
       30
       -
               '';

     

       31
       31
       -
             };

     

       32
       32
       -
       

     

       33
       33
       -
             enableOSSEmulation = mkOption {

     

       34
       34
       -
               type = types.bool;

     

       35
       35
       -
               default = false;

     

       36
       36
       -
               description = ''

     

       37
       37
       -
                 Whether to enable ALSA OSS emulation (with certain cards sound mixing may not work!).

     

       38
       38
       -
               '';

     

       39
       39
       -
             };

     

       40
       40
       -
       

     

       41
       41
       -
             extraConfig = mkOption {

     

       42
       42
       -
               type = types.lines;

     

       43
       43
       -
               default = "";

     

       44
       44
       -
               example = ''

     

       45
       45
       -
                 defaults.pcm.!card 3

     

       46
       46
       -
               '';

     

       47
       47
       -
               description = ''

     

       48
       48
       -
                 Set addition configuration for system-wide alsa.

     

       49
       49
       -
               '';

     

       50
       50
       -
             };

     

       51
       51
       -
       

     

       52
       52
       -
             mediaKeys = {

     

       53
       53
       -
       

     

       54
       54
       -
               enable = mkOption {

     

       55
       55
       -
                 type = types.bool;

     

       56
       56
       -
                 default = false;

     

       57
       57
       -
                 description = ''

     

       58
       58
       -
                   Whether to enable volume and capture control with keyboard media keys.

     

       59
       59
       -
       

     

       60
       60
       -
                   You want to leave this disabled if you run a desktop environment

     

       61
       61
       -
                   like KDE, Gnome, Xfce, etc, as those handle such things themselves.

     

       62
       62
       -
                   You might want to enable this if you run a minimalistic desktop

     

       63
       63
       -
                   environment or work from bare linux ttys/framebuffers.

     

       64
       64
       -
       

     

       65
       65
       -
                   Enabling this will turn on {option}`services.actkbd`.

     

       66
       66
       -
                 '';

     

       67
       67
       -
               };

     

       68
       68
       -
       

     

       69
       69
       -
               volumeStep = mkOption {

     

       70
       70
       -
                 type = types.str;

     

       71
       71
       -
                 default = "1";

     

       72
       72
       -
                 example = "1%";

     

       73
       73
       -
                 description = ''

     

       74
       74
       -
                   The value by which to increment/decrement volume on media keys.

     

       75
       75
       -
       

     

       76
       76
       -
                   See amixer(1) for allowed values.

     

       77
       77
       -
                 '';

     

       78
       78
       -
               };

     

       79
       79
       -
       

     

       80
       80
       -
             };

     

       81
       81
       -
       

     

       82
       82
       -
           };

     

       83
       83
       -
       

     

       11
       11
       +
         options.hardware.alsa.enablePersistence = mkOption {

     

       12
       12
       +
           type = types.bool;

     

       13
       13
       +
           default = false;

     

       14
       14
       +
           description = ''

     

       15
       15
       +
             Whether to enable ALSA sound card state saving on shutdown.

     

       16
       16
       +
             This is generally not necessary if you're using an external sound server.

     

       17
       17
       +
           '';

     

       84
       18
        
         };

     

       85
       19
        
       

     

       86
       86
       -
       

     

       87
       87
       -
         ###### implementation

     

       88
       88
       -
       

     

       89
       89
       -
         config = mkIf config.sound.enable {

     

       90
       90
       -
       

     

       91
       91
       -
           environment.systemPackages = [ alsa-utils ];

     

       92
       92
       -
       

     

       93
       93
       -
           environment.etc = mkIf (!pulseaudioEnabled && config.sound.extraConfig != "")

     

       94
       94
       -
             { "asound.conf".text = config.sound.extraConfig; };

     

       95
       95
       -
       

     

       20
       20
       +
         config = mkIf config.hardware.alsa.enablePersistence {

     

       96
       21
        
           # ALSA provides a udev rule for restoring volume settings.

     

       97
       22
        
           services.udev.packages = [ alsa-utils ];

     

       98
       23
        
       

     

       99
       99
       -
           boot.kernelModules = optional config.sound.enableOSSEmulation "snd_pcm_oss";

     

       100
       100
       -
       

     

       101
       101
       -
           systemd.services.alsa-store =

     

       102
       102
       -
             { description = "Store Sound Card State";

     

       103
       103
       -
               wantedBy = [ "multi-user.target" ];

     

       104
       104
       -
               unitConfig.RequiresMountsFor = "/var/lib/alsa";

     

       105
       105
       -
               unitConfig.ConditionVirtualization = "!systemd-nspawn";

     

       106
       106
       -
               serviceConfig = {

     

       107
       107
       -
                 Type = "oneshot";

     

       108
       108
       -
                 RemainAfterExit = true;

     

       109
       109
       -
                 ExecStartPre = "${pkgs.coreutils}/bin/mkdir -p /var/lib/alsa";

     

       110
       110
       -
                 ExecStart = "${alsa-utils}/sbin/alsactl restore --ignore";

     

       111
       111
       -
                 ExecStop = "${alsa-utils}/sbin/alsactl store --ignore";

     

       112
       112
       -
               };

     

       24
       24
       +
           systemd.services.alsa-store = {

     

       25
       25
       +
             description = "Store Sound Card State";

     

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

     

       27
       27
       +
             unitConfig = {

     

       28
       28
       +
               RequiresMountsFor = "/var/lib/alsa";

     

       29
       29
       +
               ConditionVirtualization = "!systemd-nspawn";

     

       30
       30
       +
             };

     

       31
       31
       +
             serviceConfig = {

     

       32
       32
       +
               Type = "oneshot";

     

       33
       33
       +
               RemainAfterExit = true;

     

       34
       34
       +
               ExecStartPre = "${pkgs.coreutils}/bin/mkdir -p /var/lib/alsa";

     

       35
       35
       +
               ExecStart = "${alsa-utils}/sbin/alsactl restore --ignore";

     

       36
       36
       +
               ExecStop = "${alsa-utils}/sbin/alsactl store --ignore";

     

       113
       37
        
             };

     

       114
       114
       -
       

     

       115
       115
       -
           services.actkbd = mkIf config.sound.mediaKeys.enable {

     

       116
       116
       -
             enable = true;

     

       117
       117
       -
             bindings = [

     

       118
       118
       -
               # "Mute" media key

     

       119
       119
       -
               { keys = [ 113 ]; events = [ "key" ];       command = "${alsa-utils}/bin/amixer -q set Master toggle"; }

     

       120
       120
       -
       

     

       121
       121
       -
               # "Lower Volume" media key

     

       122
       122
       -
               { keys = [ 114 ]; events = [ "key" "rep" ]; command = "${alsa-utils}/bin/amixer -q set Master ${config.sound.mediaKeys.volumeStep}- unmute"; }

     

       123
       123
       -
       

     

       124
       124
       -
               # "Raise Volume" media key

     

       125
       125
       -
               { keys = [ 115 ]; events = [ "key" "rep" ]; command = "${alsa-utils}/bin/amixer -q set Master ${config.sound.mediaKeys.volumeStep}+ unmute"; }

     

       126
       126
       -
       

     

       127
       127
       -
               # "Mic Mute" media key

     

       128
       128
       -
               { keys = [ 190 ]; events = [ "key" ];       command = "${alsa-utils}/bin/amixer -q set Capture toggle"; }

     

       129
       129
       -
             ];

     

       130
       38
        
           };

     

       131
       131
       -
       

     

       132
       39
        
         };

     

       133
       133
       -
       

     

       134
       40
        
       }

+2 -2

nixos/modules/services/audio/jack.nix

···

       122
       122
        
         config = mkMerge [

     

       123
       123
        
       

     

       124
       124
        
           (mkIf pcmPlugin {

     

       125
       125
       -
             sound.extraConfig = ''

     

       125
       125
       +
             environment.etc."alsa/conf.d/98-jack.conf".text = ''

     

       126
       126
        
               pcm_type.jack {

     

       127
       127
        
                 libs.native = ${pkgs.alsa-plugins}/lib/alsa-lib/libasound_module_pcm_jack.so ;

     

       128
       128
        
                 ${lib.optionalString enable32BitAlsaPlugins

     
···

       139
       139
        
           (mkIf loopback {

     

       140
       140
        
             boot.kernelModules = [ "snd-aloop" ];

     

       141
       141
        
             boot.kernelParams = [ "snd-aloop.index=${toString cfg.loopback.index}" ];

     

       142
       142
       -
             sound.extraConfig = cfg.loopback.config;

     

       142
       142
       +
             environment.etc."alsa/conf.d/99-jack-loopback.conf".text = cfg.loopback.config;

     

       143
       143
        
           })

     

       144
       144
        
       

     

       145
       145
        
           (mkIf cfg.jackd.enable {

-1

nixos/modules/virtualisation/vagrant-virtualbox-image.nix

···

       15
       15
        
           usb = "off";

     

       16
       16
        
           usbehci = "off";

     

       17
       17
        
         };

     

       18
       18
       -
         sound.enable = false;

     

       19
       18
        
         documentation.man.enable = false;

     

       20
       19
        
         documentation.nixos.enable = false;

     

       21
       20

-1

nixos/tests/domination.nix

···

       10
       10
        
           ];

     

       11
       11
        
       

     

       12
       12
        
           services.xserver.enable = true;

     

       13
       13
       -
           sound.enable = true;

     

       14
       13
        
           environment.systemPackages = [ pkgs.domination ];

     

       15
       14
        
         };

     

       16
       15

+1 -2

nixos/tests/firefox.nix

···

       21
       21
        
             # Create a virtual sound device, with mixing

     

       22
       22
        
             # and all, for recording audio.

     

       23
       23
        
             boot.kernelModules = [ "snd-aloop" ];

     

       24
       24
       -
             sound.enable = true;

     

       25
       25
       -
             sound.extraConfig = ''

     

       24
       24
       +
             environment.etc."asound.conf".text = ''

     

       26
       25
        
               pcm.!default {

     

       27
       26
        
                 type plug

     

       28
       27
        
                 slave.pcm pcm.dmixer

-2

nixos/tests/ft2-clone.nix

···

       8
       8
        
           imports = [

     

       9
       9
        
             ./common/x11.nix

     

       10
       10
        
           ];

     

       11
       11
       -
       

     

       12
       12
       -
           sound.enable = true;

     

       13
       11
        
           environment.systemPackages = [ pkgs.ft2-clone ];

     

       14
       12
        
         };

     

       15
       13

-1

nixos/tests/login.nix

···

       9
       9
        
         nodes.machine =

     

       10
       10
        
           { pkgs, lib, ... }:

     

       11
       11
        
           { boot.kernelPackages = lib.mkIf latestKernel pkgs.linuxPackages_latest;

     

       12
       12
       -
             sound.enable = true; # needed for the factl test, /dev/snd/* exists without them but udev doesn't care then

     

       13
       12
        
           };

     

       14
       13
        
       

     

       15
       14
        
         testScript = ''

-1

nixos/tests/mpd.nix

···

       37
       37
        
       

     

       38
       38
        
           mkServer = { mpd, musicService, }:

     

       39
       39
        
             { boot.kernelModules = [ "snd-dummy" ];

     

       40
       40
       -
               sound.enable = true;

     

       41
       40
        
               services.mpd = mpd;

     

       42
       41
        
               systemd.services.musicService = musicService;

     

       43
       42
        
             };

-1

nixos/tests/pt2-clone.nix

···

       10
       10
        
           ];

     

       11
       11
        
       

     

       12
       12
        
           services.xserver.enable = true;

     

       13
       13
       -
           sound.enable = true;

     

       14
       13
        
           environment.systemPackages = [ pkgs.pt2-clone ];

     

       15
       14
        
         };

     

       16
       15

-1

nixos/tests/sfxr-qt.nix

···

       10
       10
        
           ];

     

       11
       11
        
       

     

       12
       12
        
           services.xserver.enable = true;

     

       13
       13
       -
           sound.enable = true;

     

       14
       13
        
           environment.systemPackages = [ pkgs.sfxr-qt ];

     

       15
       14
        
         };

     

       16
       15

-1

nixos/tests/shattered-pixel-dungeon.nix

···

       10
       10
        
           ];

     

       11
       11
        
       

     

       12
       12
        
           services.xserver.enable = true;

     

       13
       13
       -
           sound.enable = true;

     

       14
       13
        
           environment.systemPackages = [ pkgs.shattered-pixel-dungeon ];

     

       15
       14
        
         };

     

       16
       15

+1 -2

nixos/tests/slimserver.nix

···

       8
       8
        
             enable = true;

     

       9
       9
        
             extraArguments = "-s 127.0.0.1 -d slimproto=info";

     

       10
       10
        
           };

     

       11
       11
       -
           sound.enable = true;

     

       12
       12
       -
           boot.initrd.kernelModules = ["snd-dummy"];

     

       11
       11
       +
           boot.kernelModules = ["snd-dummy"];

     

       13
       12
        
         };

     

       14
       13
        
       

     

       15
       14
        
         testScript =

-1

nixos/tests/systemd-analyze.nix

···

       9
       9
        
         nodes.machine =

     

       10
       10
        
           { pkgs, lib, ... }:

     

       11
       11
        
           { boot.kernelPackages = lib.mkIf latestKernel pkgs.linuxPackages_latest;

     

       12
       12
       -
             sound.enable = true; # needed for the factl test, /dev/snd/* exists without them but udev doesn't care then

     

       13
       12
        
           };

     

       14
       13
        
       

     

       15
       14
        
         testScript = ''

+1 -1

pkgs/tools/nix/nixos-option/src/nixos-option.cc

···

       319
       319
        
       }

     

       320
       320
        
       

     

       321
       321
        
       // Calls f on all the config values inside one option.

     

       322
       322
       -
       // Simple options have one config value inside, like sound.enable = true.

     

       322
       322
       +
       // Simple options have one config value inside, like services.foo.enable = true.

     

       323
       323
        
       // Compound options have multiple config values.  For example, the option

     

       324
       324
        
       // "users.users" has about 1000 config values inside it:

     

       325
       325
        
       //   users.users.avahi.createHome = false;