···

       
1
       
1
       
 
       
# Customising Packages {#sec-customising-packages}

     

       
2
       
2
       
 
       


     

       
3
       
3
       
 
       
Some packages in Nixpkgs have options to enable or disable optional

     

       
4
       
4
       
-
       
functionality or change other aspects of the package. For instance, the

     

       
5
       
5
       
-
       
Firefox wrapper package (which provides Firefox with a set of plugins

     

       
6
       
6
       
-
       
such as the Adobe Flash player) has an option to enable the Google Talk

     

       
7
       
7
       
-
       
plugin. It can be set in `configuration.nix` as follows:

     

       
8
       
8
       
-
       
`nixpkgs.config.firefox.enableGoogleTalkPlugin = true;`

     

       
4
       
4
       
+
       
functionality or change other aspects of the package.

     

       
9
       
5
       
 
       


     

       
10
       
6
       
 
       
::: {.warning}

     

       
11
       
7
       
 
       
Unfortunately, Nixpkgs currently lacks a way to query available

     
···

       
13
       
9
       
 
       
:::

     

       
14
       
10
       
 
       


     

       
15
       
11
       
 
       
::: {.note}

     

       
16
       
16
       
-
       
Alternatively, many packages come with extensions one might add.

     

       
12
       
12
       
+
       
For example, many packages come with extensions one might add.

     

       
17
       
13
       
 
       
Examples include:

     

       
18
       
14
       
 
       
- [`passExtensions.pass-otp`](https://search.nixos.org/packages/query=passExtensions.pass-otp)

     

       
19
       
15
       
 
       
- [`python310Packages.requests`](https://search.nixos.org/packages/query=python310Packages.requests)

     

···

       
257
       
257
       
 
       


     

       
258
       
258
       
 
       
- The `services.mtr-exporter.target` has been removed in favor of `services.mtr-exporter.jobs` which allows specifying multiple targets.

     

       
259
       
259
       
 
       


     

       
260
       
260
       
+
       
- Setting `nixpkgs.config` options while providing an external `pkgs` instance will now raise an error instead of silently ignoring the options. NixOS modules no longer set `nixpkgs.config` to accomodate this. This specifically affects `services.locate`, `services.xserver.displayManager.lightdm.greeters.tiny` and `programs.firefox` NixOS modules. No manual intervention should be required in most cases, however, configurations relying on those modules affecting packages outside the system environment should switch to explicit overlays.

     

       
261
       
261
       
+
       


     

       
260
       
262
       
 
       
## Other Notable Changes {#sec-release-23.11-notable-changes}

     

       
261
       
263
       
 
       


     

       
262
       
264
       
 
       
- The Cinnamon module now enables XDG desktop integration by default. If you are experiencing collisions related to xdg-desktop-portal-gtk you can safely remove `xdg.portal.extraPortals = [ pkgs.xdg-desktop-portal-gtk ];` from your NixOS configuration.

     

···

       
20
       
20
       
 
       
{

     

       
21
       
21
       
 
       


     

       
22
       
22
       
 
       
  config = mkIf enabled {

     

       
23
       
23
       
-
       


     

       
24
       
24
       
-
       
    nixpkgs.config.xorg.abiCompat = "1.20";

     

       
25
       
25
       
-
       


     

       
26
       
23
       
 
       
    services.xserver.drivers = singleton

     

       
27
       
24
       
 
       
      { name = "amdgpu"; modules = [ package ]; display = true; };

     

       
28
       
25
       
 
       


     

···

       
230
       
230
       
 
       
        plocate = (mkIf isPLocate (mkMerge [ common plocate ]));

     

       
231
       
231
       
 
       
      };

     

       
232
       
232
       
 
       


     

       
233
       
233
       
-
       
    nixpkgs.config = { locate.dbfile = cfg.output; };

     

       
234
       
234
       
-
       


     

       
235
       
235
       
-
       
    environment.systemPackages = [ cfg.locate ];

     

       
233
       
233
       
+
       
    environment.systemPackages = [ (cfg.locate.override { dbfile = cfg.output; }) ];

     

       
236
       
234
       
 
       


     

       
237
       
235
       
 
       
    environment.variables = mkIf (!isMorPLocate) { LOCATE_PATH = cfg.output; };

     

       
238
       
236
       
 
       


     

···

       
379
       
379
       
 
       
          the legacy definitions.

     

       
380
       
380
       
 
       
        '';

     

       
381
       
381
       
 
       
      }

     

       
382
       
382
       
+
       
      {

     

       
383
       
383
       
+
       
        assertion = opt.pkgs.isDefined -> cfg.config == {};

     

       
384
       
384
       
+
       
        message = ''

     

       
385
       
385
       
+
       
          Your system configures nixpkgs with an externally created instance.

     

       
386
       
386
       
+
       
          `nixpkgs.config` options should be passed when creating the instance instead.

     

       
387
       
387
       
+
       


     

       
388
       
388
       
+
       
          Current value:

     

       
389
       
389
       
+
       
          ${lib.generators.toPretty { multiline = true; } opt.config}

     

       
390
       
390
       
+
       
        '';

     

       
391
       
391
       
+
       
      }

     

       
382
       
392
       
 
       
    ];

     

       
383
       
393
       
 
       
  };

     

       
384
       
394
       
 
       


     

···

       
27
       
27
       
 
       
      "opt/brave/native-messaging-hosts/${appId}".source = source "hosts/chromium";

     

       
28
       
28
       
 
       
      "opt/brave/policies/managed/${appId}".source = source "policies/chromium";

     

       
29
       
29
       
 
       
    };

     

       
30
       
30
       
-
       
    nixpkgs.config.firefox.enableBrowserpass = true;

     

       
30
       
30
       
+
       
    programs.firefox.wrapperConfig.enableBrowserpass = true;

     

       
31
       
31
       
 
       
  };

     

       
32
       
32
       
 
       
}

     

···

       
36
       
36
       
 
       
      ];

     

       
37
       
37
       
 
       
    };

     

       
38
       
38
       
 
       


     

       
39
       
39
       
+
       
    wrapperConfig = mkOption {

     

       
40
       
40
       
+
       
      type = types.attrs;

     

       
41
       
41
       
+
       
      default = {};

     

       
42
       
42
       
+
       
      description = mdDoc "Arguments to pass to Firefox wrapper";

     

       
43
       
43
       
+
       
    };

     

       
44
       
44
       
+
       


     

       
39
       
45
       
 
       
    policies = mkOption {

     

       
40
       
46
       
 
       
      type = policyFormat.type;

     

       
41
       
47
       
 
       
      default = { };

     
···

       
227
       
233
       
 
       
        ] ++ optionals nmh.passff [

     

       
228
       
234
       
 
       
          passff-host

     

       
229
       
235
       
 
       
        ];

     

       
236
       
236
       
+
       
        cfg = let

     

       
237
       
237
       
+
       
          # copy-pasted from the wrapper; TODO: figure out fix

     

       
238
       
238
       
+
       
          applicationName = cfg.package.binaryName or (lib.getName cfg.package);

     

       
239
       
239
       
+
       


     

       
240
       
240
       
+
       
          nixpkgsConfig = config.nixpkgs.config.${applicationName} or {};

     

       
241
       
241
       
+
       
          optionConfig = cfg.wrapperConfig;

     

       
242
       
242
       
+
       
          nmhConfig = {

     

       
243
       
243
       
+
       
            enableBrowserpass = nmh.browserpass;

     

       
244
       
244
       
+
       
            enableBukubrow = nmh.bukubrow;

     

       
245
       
245
       
+
       
            enableTridactylNative = nmh.tridactyl;

     

       
246
       
246
       
+
       
            enableUgetIntegrator = nmh.ugetIntegrator;

     

       
247
       
247
       
+
       
            enableFXCastBridge = nmh.fxCast;

     

       
248
       
248
       
+
       
          };

     

       
249
       
249
       
+
       
        in nixpkgsConfig // optionConfig // nmhConfig;

     

       
230
       
250
       
 
       
      })

     

       
231
       
251
       
 
       
    ];

     

       
232
       
232
       
-
       


     

       
233
       
233
       
-
       
    nixpkgs.config.firefox = {

     

       
234
       
234
       
-
       
      enableBrowserpass = nmh.browserpass;

     

       
235
       
235
       
-
       
      enableBukubrow = nmh.bukubrow;

     

       
236
       
236
       
-
       
      enableTridactylNative = nmh.tridactyl;

     

       
237
       
237
       
-
       
      enableUgetIntegrator = nmh.ugetIntegrator;

     

       
238
       
238
       
-
       
      enableFXCastBridge = nmh.fxCast;

     

       
239
       
239
       
-
       
    };

     

       
240
       
252
       
 
       


     

       
241
       
253
       
 
       
    environment.etc =

     

       
242
       
254
       
 
       
      let

     

···

       
42
       
42
       
 
       


     

       
43
       
43
       
 
       
    services.dbus.packages = [ pkgs.gnome-browser-connector ];

     

       
44
       
44
       
 
       


     

       
45
       
45
       
-
       
    nixpkgs.config.firefox.enableGnomeExtensions = true;

     

       
45
       
45
       
+
       
    programs.firefox.wrapperConfig.enableGnomeExtensions = true;

     

       
46
       
46
       
 
       
  };

     

       
47
       
47
       
 
       
}

     

···

       
282
       
282
       
 
       


     

       
283
       
283
       
 
       
      # Override GSettings schemas

     

       
284
       
284
       
 
       
      environment.sessionVariables.NIX_GSETTINGS_OVERRIDES_DIR = "${nixos-gsettings-desktop-schemas}/share/gsettings-schemas/nixos-gsettings-overrides/glib-2.0/schemas";

     

       
285
       
285
       
-
       


     

       
286
       
286
       
-
       
       # If gnome is installed, build vim for gtk3 too.

     

       
287
       
287
       
-
       
      nixpkgs.config.vim.gui = "gtk3";

     

       
288
       
285
       
 
       
    })

     

       
289
       
286
       
 
       


     

       
290
       
287
       
 
       
    (mkIf flashbackEnabled {

     

···

       
379
       
379
       
 
       
      # Update the start menu for each user that is currently logged in

     

       
380
       
380
       
 
       
      system.userActivationScripts.plasmaSetup = activationScript;

     

       
381
       
381
       
 
       


     

       
382
       
382
       
-
       
      nixpkgs.config.firefox.enablePlasmaBrowserIntegration = true;

     

       
382
       
382
       
+
       
      programs.firefox.wrapperConfig.enablePlasmaBrowserIntegration = true;

     

       
383
       
383
       
 
       
    })

     

       
384
       
384
       
 
       


     

       
385
       
385
       
 
       
    (mkIf (cfg.kwinrc != {}) {

     

···

       
61
       
61
       
 
       


     

       
62
       
62
       
 
       
    services.xserver.displayManager.lightdm.greeters.gtk.enable = false;

     

       
63
       
63
       
 
       


     

       
64
       
64
       
-
       
    nixpkgs.config.lightdm-tiny-greeter.conf =

     

       
64
       
64
       
+
       
    services.xserver.displayManager.lightdm.greeter =

     

       
65
       
65
       
 
       
    let

     

       
66
       
66
       
 
       
      configHeader = ''

     

       
67
       
67
       
 
       
        #include <gtk/gtk.h>

     
···

       
69
       
69
       
 
       
        static const char *pass_text = "${cfg.label.pass}";

     

       
70
       
70
       
 
       
        static const char *session = "${dmcfg.defaultSession}";

     

       
71
       
71
       
 
       
      '';

     

       
72
       
72
       
+
       
      config = optionalString (cfg.extraConfig != "") (configHeader + cfg.extraConfig);

     

       
73
       
73
       
+
       
      package = pkgs.lightdm-tiny-greeter.override { conf = config; };

     

       
72
       
74
       
 
       
    in

     

       
73
       
73
       
-
       
      optionalString (cfg.extraConfig != "")

     

       
74
       
74
       
-
       
        (configHeader + cfg.extraConfig);

     

       
75
       
75
       
-
       


     

       
76
       
76
       
-
       
    services.xserver.displayManager.lightdm.greeter =

     

       
77
       
75
       
 
       
      mkDefault {

     

       
78
       
78
       
-
       
        package = pkgs.lightdm-tiny-greeter.xgreeters;

     

       
76
       
76
       
+
       
        package = package.xgreeters;

     

       
79
       
77
       
 
       
        name = "lightdm-tiny-greeter";

     

       
80
       
78
       
 
       
      };

     

       
81
       
79
       
 
       


     

···

       
1
       
1
       
 
       
{ lib, stdenv, linkFarm, lightdm-tiny-greeter, fetchFromGitHub

     

       
2
       
2
       
-
       
, pkg-config, lightdm, gtk3, glib, wrapGAppsHook, conf ? "" }:

     

       
2
       
2
       
+
       
, pkg-config, lightdm, gtk3, glib, wrapGAppsHook, config, conf ? config.lightdm-tiny-greeter.conf or "" }:

     

       
3
       
3
       
 
       


     

       
4
       
4
       
 
       
stdenv.mkDerivation rec {

     

       
5
       
5
       
 
       
  pname = "lightdm-tiny-greeter";

     

···

       
1
       
1
       
-
       
{ abiCompat ? null,

     

       
2
       
2
       
-
       
  callPackage,

     

       
1
       
1
       
+
       
{ callPackage,

     

       
3
       
2
       
 
       
  lib, stdenv, makeWrapper, fetchurl, fetchpatch, fetchFromGitLab, buildPackages,

     

       
4
       
3
       
 
       
  automake, autoconf, libiconv, libtool, intltool, gettext, python3, perl,

     

       
5
       
4
       
 
       
  freetype, tradcpp, fontconfig, meson, ninja, ed, fontforge,

     
···

       
738
       
737
       
 
       
  });

     

       
739
       
738
       
 
       


     

       
740
       
739
       
 
       
  xorgserver = with xorg; super.xorgserver.overrideAttrs (attrs_passed:

     

       
741
       
741
       
-
       
    # exchange attrs if abiCompat is set

     

       
742
       
740
       
 
       
    let

     

       
743
       
743
       
-
       
      version = lib.getVersion attrs_passed;

     

       
744
       
744
       
-
       
      attrs =

     

       
745
       
745
       
-
       
        if (abiCompat == null || lib.hasPrefix abiCompat version) then

     

       
746
       
746
       
-
       
          attrs_passed // {

     

       
747
       
747
       
-
       
            buildInputs = attrs_passed.buildInputs ++

     

       
748
       
748
       
-
       
              lib.optional (libdrm != null) libdrm.dev;

     

       
749
       
749
       
-
       
            postPatch = ''

     

       
750
       
750
       
-
       
              for i in dri3/*.c

     

       
751
       
751
       
-
       
              do

     

       
752
       
752
       
-
       
                sed -i -e "s|#include <drm_fourcc.h>|#include <libdrm/drm_fourcc.h>|" $i

     

       
753
       
753
       
-
       
              done

     

       
754
       
754
       
-
       
            '';

     

       
755
       
755
       
-
       
            meta = attrs_passed.meta // { mainProgram = "X"; };

     

       
756
       
756
       
-
       
          }

     

       
757
       
757
       
-
       
        else throw "unsupported xorg abiCompat ${abiCompat} for ${attrs_passed.name}";

     

       
758
       
758
       
-
       


     

       
741
       
741
       
+
       
      attrs = attrs_passed // {

     

       
742
       
742
       
+
       
        buildInputs = attrs_passed.buildInputs ++

     

       
743
       
743
       
+
       
          lib.optional (libdrm != null) libdrm.dev;

     

       
744
       
744
       
+
       
        postPatch = ''

     

       
745
       
745
       
+
       
          for i in dri3/*.c

     

       
746
       
746
       
+
       
          do

     

       
747
       
747
       
+
       
            sed -i -e "s|#include <drm_fourcc.h>|#include <libdrm/drm_fourcc.h>|" $i

     

       
748
       
748
       
+
       
          done

     

       
749
       
749
       
+
       
        '';

     

       
750
       
750
       
+
       
        meta = attrs_passed.meta // { mainProgram = "X"; };

     

       
751
       
751
       
+
       
      };

     

       
759
       
752
       
 
       
    in attrs //

     

       
760
       
753
       
 
       
    (let

     

       
761
       
754
       
 
       
      version = lib.getVersion attrs;

     

···

       
1
       
1
       
-
       
{ lib, stdenv, fetchurl, config }:

     

       
1
       
1
       
+
       
{ lib, stdenv, fetchurl, config, dbfile ? config.locate.dbfile or "/var/cache/locatedb" }:

     

       
2
       
2
       
 
       


     

       
3
       
3
       
-
       
let

     

       
4
       
4
       
-
       
  dbfile = lib.attrByPath [ "locate" "dbfile" ] "/var/cache/locatedb" config;

     

       
5
       
5
       
-
       
in stdenv.mkDerivation rec {

     

       
3
       
3
       
+
       
stdenv.mkDerivation rec {

     

       
6
       
4
       
 
       
  pname = "mlocate";

     

       
7
       
5
       
 
       
  version = "0.26";

     

       
8
       
6
       
 
       


     

···

       
8
       
8
       
 
       
, systemd

     

       
9
       
9
       
 
       
, liburing

     

       
10
       
10
       
 
       
, zstd

     

       
11
       
11
       
+
       
, dbfile ? config.locate.dbfile or "/var/cache/locatedb"

     

       
11
       
12
       
 
       
}:

     

       
12
       
12
       
-
       
let

     

       
13
       
13
       
-
       
  dbfile = lib.attrByPath [ "locate" "dbfile" ] "/var/cache/locatedb" config;

     

       
14
       
14
       
-
       
in

     

       
15
       
13
       
 
       
stdenv.mkDerivation rec {

     

       
16
       
14
       
 
       
  pname = "plocate";

     

       
17
       
15
       
 
       
  version = "1.1.19";

     

···

       
27666
       
27666
       
 
       
      inherit (buildPackages.darwin) bootstrap_cmds;

     

       
27667
       
27667
       
 
       
      udev = if stdenv.isLinux then udev else null;

     

       
27668
       
27668
       
 
       
      libdrm = if stdenv.isLinux then libdrm else null;

     

       
27669
       
27669
       
-
       
      abiCompat = config.xorg.abiCompat or null; # `config` because we have no `xorg.override`

     

       
27670
       
27669
       
 
       
    };

     

       
27671
       
27670
       
 
       


     

       
27672
       
27671
       
 
       
    generatedPackages = lib.callPackageWith __splicedPackages ../servers/x11/xorg/default.nix { };

     
···

       
35614
       
35613
       
 
       


     

       
35615
       
35614
       
 
       
  lightdm-mobile-greeter = callPackage ../applications/display-managers/lightdm-mobile-greeter { };

     

       
35616
       
35615
       
 
       


     

       
35617
       
35617
       
-
       
  lightdm-tiny-greeter = callPackage ../applications/display-managers/lightdm-tiny-greeter {

     

       
35618
       
35618
       
-
       
    conf = config.lightdm-tiny-greeter.conf or "";

     

       
35619
       
35619
       
-
       
  };

     

       
35616
       
35616
       
+
       
  lightdm-tiny-greeter = callPackage ../applications/display-managers/lightdm-tiny-greeter { };

     

       
35620
       
35617
       
 
       


     

       
35621
       
35618
       
 
       
  ly = callPackage ../applications/display-managers/ly { };

     

       
35622
       
35619