GNOME: Difference between revisions

(20 intermediate revisions by 3 users not shown)

Line 8:

To use the GNOME desktop environment on NixOS, the following configuration options must be set:

{{file|~~/etc/nixos/configuration~~.~~nix|nix|<nowiki>~~

{{file|3={ config, pkgs, ... }:

{

# Pre 25.11

services.xserver.enable = true;

Line 18:

Line 20:

services.displayManager.gdm.enable = true;

services.desktopManager.gnome.enable = true;

}

~~</nowiki>}}~~

Despite the options in NixOS versions before 25.11 being under the <code>xserver</code> ~~namespace~~, GNOME uses [[Wayland]] by default. NixOS 25.11 and later removes support for the [[Xorg]] session entirely (though Xwayland is still included and supported for compatibility).

# To disable installing GNOME's suite of applications

# and only be left with GNOME shell.

services.gnome.core-apps.enable = false;

services.gnome.core-developer-tools.enable = false;

services.gnome.games.enable = false;

environment.gnome.excludePackages = with pkgs; [ gnome-tour gnome-user-docs ];

}|name=/etc/nixos/configuration.nix|lang=nix}}

Despite the options in NixOS versions before 25.11 being under the <code>xserver</code> module, GNOME uses [[Wayland]] by default. NixOS 25.11 and later removes support for the [[Xorg]] session entirely (though Xwayland is still included and supported for compatibility).

=== GNOME extensions ===

GNOME offers support for changing/overhauling the user interface (GNOME Shell) through the use of ''[https://extensions.gnome.org/about/ Extensions].'' Extensions are bundles of third-party [https://gjs.guide/extensions/ GJS] modules that are loaded while GNOME is running to augment the user experience. A repository of GNOME extensions can be found on GNOME's official [https://extensions.gnome.org/ webpage] and can be installed imperatively if needed by unpacking the extension in <code>~/.local/share/gnome-shell/extensions</code> directory. Extensions can only be activated if it supports the GNOME release that it's installed alongside with.

~~However~~, ~~Nix~~ automatically packages all available GNOME extensions under the <code>pkgs.gnomeExtensions</code> attribute. Extensions which require additional dependencies are then manually packaged if needed. Installed extensions can be enabled graphically through the built-in "Extensions" application or through the <code>gnome-extensions</code> command line interface.

In addition, NixOS automatically packages all officially available GNOME extensions under the <code>pkgs.gnomeExtensions</code> attribute. Extensions which require additional dependencies are then manually packaged if needed. Installed extensions can be enabled graphically through the built-in "Extensions" application or through the <code>gnome-extensions</code> command line interface.

{{file|3={

Line 75:

Line 84:

};

}|name=~/.config/home-manager/home.nix|lang=nix}}Thus the settings attribute accepts an attribute set whose keys are schemas with each schema's value being a nested attribute set of the schema's keys with their appropriate GVariant value.{{Note|Schemas in Nix are written without leading and trailing slashes. In addition, since dconf have more data types than the Nix language (for example, tuples), in some cases you'll need to convert Nix value to a GVariant value. You can achieve that by using the functions defined under <code>lib.gvariant</code>, they're documented [https://nixos.org/manual/nixpkgs/stable/#sec-functions-library-gvariant here].}}

}|name=~/.config/home-manager/home.nix|lang=nix}}Thus the settings attribute accepts an attribute set whose keys are schemas with each schema's value being a nested attribute set of the schema's keys with their appropriate GVariant value.{{Note|Schemas in Nix are written without leading and trailing slashes. In addition, since dconf have more data types than the Nix language (for example, tuples), in some cases you'll need to convert Nix value to a GVariant value. You can achieve that by using the functions defined under <code>lib.gvariant</code>, they're documented [https://nixos.org/manual/nixpkgs/stable/#sec-functions-library-gvariant here].}}If you wish to revert all dconf settings back to their default state (reset GNOME essentially) then use the following command which resets all schemas directories available on your system, note that this will affect all programs that use dconf, including GNOME apps and extensions.<syntaxhighlight lang="bash">

$ dconf reset -f /

</syntaxhighlight>

==== Extensions ====

Line 111:

Line 122:

== Tips and tricks ==

=== GNOME power user apps ===

Both GNOME Tweaks (accessible as <code>gnome-tweaks</code>) and [https://gitlab.gnome.org/TheEvilSkeleton/Refine Refine] (accessible as <code>refine</code>) allow you to change certain GNOME settings that are hidden by default (such as interface font, window decoration buttons like maximize/minimize, icon themes and GTK themes, etc).

The GNOME shell extension [https://extensions.gnome.org/extension/3843/just-perfection/ Just Perfection] also allows for customizing nearly all parts of the GNOME shell interface.

=== GNOME Qt integration ===

Using the following example configuration, Qt applications will have a look similar to the adwaita style used by GNOME using a dark theme.

{{File|3={

qt = {

enable = true;

platformTheme = "gnome";

style = "adwaita-dark";

};

}|name=/etc/nixos/configuration.nix|lang=nix}}

For other themes, you may need the packages <code>libsForQt5.qt5ct</code> and <code>libsForQt5.qtstyleplugin-kvantum</code> and a symlink from <code>~/.config/Kvantum/</code> to your theme package. Here is an example using Arc-Dark and [[Home Manager]]. In the Home Manager configuration:

{{File|3={

qt = {

enable = true;

platformTheme = "qtct";

style = "kvantum";

};

xdg.configFile = {

"Kvantum/ArcDark".source = "${pkgs.arc-kde-theme}/share/Kvantum/ArcDark";

"Kvantum/kvantum.kvconfig".text = "[General]\ntheme=ArcDark";

};

}|name=~/.config/home-manager/home.nix|lang=nix}}

For more details, see [https://discourse.nixos.org/t/guide-to-installing-qt-theme/35523/2 this] forum post.{{Note|Qt integration with the adwaita style isn't perfect and your mileage may vary.}}

=== Experimental settings ===

GNOME has a number of experimental settings for features not fully completed and thus hidden from the user. As of GNOME 48, these are the experimental features you may want to use:

{{File|3={

programs.dconf.profiles.user.databases = [

{

settings = {

"org/gnome/mutter" = {

experimental-features = [

"scale-monitor-framebuffer" # Enables fractional scaling (125% 150% 175%)

"variable-refresh-rate" # Enables Variable Refresh Rate (VRR) on compatible displays

"xwayland-native-scaling" # Scales Xwayland applications to look crisp on HiDPI screens

];

};

}

];

}|name=/etc/nixos/configuration.nix|lang=nix}}

=== Discover dconf settings ===

If you wish to discover the corresponding dconf entry for a given setting in a program, you can run `dconf watch /` inside of a terminal and change the setting graphically. For example, when changing toggling the Quick-Settings option "Dark Style" from "on" to "off" and back to "on," this will be the output:<syntaxhighlight lang="shell-session">

If you wish to discover the corresponding dconf entry for a given setting in a program, you can run <code>dconf watch /</code> inside of a terminal and change the setting graphically. For example, when changing toggling the Quick-Settings option "Dark Style" from "on" to "off" and back to "on," this will be the output:<syntaxhighlight lang="shell-session">

$ dconf watch /

/org/gnome/desktop/interface/color-scheme

Line 181:

Line 239:

=== Excluding GNOME Applications ===

To exclude certain applications that are installed by default with GNOME, set the {{nixos:option|environment.gnome.excludePackages}} module option:

To exclude certain applications that are installed by default with GNOME, set the {{nixos:option|environment.gnome.excludePackages}} module option (Optional Packages: [https://github.com/NixOS/nixpkgs/blob/nixos-unstable/nixos/modules/services/desktop-managers/gnome.nix#L449-L471 gnome.nix]):

{{file|/etc/nixos/configuration.nix|nix|<nowiki>

Line 190:

Line 248:

== Troubleshooting ==

=== Missing cursor/cursor is a white box ===

This occurs when installing GNOME from an existing NixOS installation that used a different desktop environment that modified dconf (most likely switching from KDE to GNOME). To easily fix this: reset all dconf settings.<syntaxhighlight lang="bash">

$ dconf reset -f /

</syntaxhighlight>

=== Running GConf-based applications ===

Line 224:

Line 287:

}|name=/etc/nixos/configuration.nix|lang=nix}}

:

== ~~See also~~ ==

== References ==

* [[GNOME/Calendar]]

[[Category:Desktop environment]]

[[Category:Applications]]

[[Category:NixOS Manual]]

[[Category:GNOME]]

@@ Line 8: / Line 8: @@
 To use the GNOME desktop environment on NixOS, the following configuration options must be set:
-{{file|/etc/nixos/configuration.nix|nix|<nowiki>
+{{file|3={ config, pkgs, ... }:
 {
    # Pre 25.11
    services.xserver.enable = true;
@@ Line 18: / Line 20: @@
    services.displayManager.gdm.enable = true;
    services.desktopManager.gnome.enable = true;
-}
-</nowiki>}}
-Despite the options in NixOS versions before 25.11 being under the <code>xserver</code> namespace, GNOME uses [[Wayland]] by default. NixOS 25.11 and later removes support for the [[Xorg]] session entirely (though Xwayland is still included and supported for compatibility).
+  # To disable installing GNOME's suite of applications
+  # and only be left with GNOME shell.
+  services.gnome.core-apps.enable = false;
+  services.gnome.core-developer-tools.enable = false;
+  services.gnome.games.enable = false;
+  environment.gnome.excludePackages = with pkgs; [ gnome-tour gnome-user-docs ];
+}|name=/etc/nixos/configuration.nix|lang=nix}}
+Despite the options in NixOS versions before 25.11 being under the <code>xserver</code> module, GNOME uses [[Wayland]] by default. NixOS 25.11 and later removes support for the [[Xorg]] session entirely (though Xwayland is still included and supported for compatibility).
 === GNOME extensions ===
 GNOME offers support for changing/overhauling the user interface (GNOME Shell) through the use of ''[https://extensions.gnome.org/about/ Extensions].'' Extensions are bundles of third-party [https://gjs.guide/extensions/ GJS] modules that are loaded while GNOME is running to augment the user experience. A repository of GNOME extensions can be found on GNOME's official [https://extensions.gnome.org/ webpage] and can be installed imperatively if needed by unpacking the extension in <code>~/.local/share/gnome-shell/extensions</code> directory. Extensions can only be activated if it supports the GNOME release that it's installed alongside with.
-However, Nix automatically packages all available GNOME extensions under the <code>pkgs.gnomeExtensions</code> attribute. Extensions which require additional dependencies are then manually packaged if needed. Installed extensions can be enabled graphically through the built-in "Extensions" application or through the <code>gnome-extensions</code> command line interface.
+In addition, NixOS automatically packages all officially available GNOME extensions under the <code>pkgs.gnomeExtensions</code> attribute. Extensions which require additional dependencies are then manually packaged if needed. Installed extensions can be enabled graphically through the built-in "Extensions" application or through the <code>gnome-extensions</code> command line interface.
 {{file|3={
@@ Line 75: / Line 84: @@
      };
    };
-}|name=~/.config/home-manager/home.nix|lang=nix}}Thus the settings attribute accepts an attribute set whose keys are schemas with each schema's value being a nested attribute set of the schema's keys with their appropriate GVariant value.{{Note|Schemas in Nix are written without leading and trailing slashes. In addition, since dconf have more data types than the Nix language (for example, tuples), in some cases you'll need to convert Nix value to a GVariant value. You can achieve that by using the functions defined under <code>lib.gvariant</code>, they're documented [https://nixos.org/manual/nixpkgs/stable/#sec-functions-library-gvariant here].}}
+}|name=~/.config/home-manager/home.nix|lang=nix}}Thus the settings attribute accepts an attribute set whose keys are schemas with each schema's value being a nested attribute set of the schema's keys with their appropriate GVariant value.{{Note|Schemas in Nix are written without leading and trailing slashes. In addition, since dconf have more data types than the Nix language (for example, tuples), in some cases you'll need to convert Nix value to a GVariant value. You can achieve that by using the functions defined under <code>lib.gvariant</code>, they're documented [https://nixos.org/manual/nixpkgs/stable/#sec-functions-library-gvariant here].}}If you wish to revert all dconf settings back to their default state (reset GNOME essentially) then use the following command which  resets all schemas directories available on your system, note that this will affect all programs that use dconf, including GNOME apps and extensions.<syntaxhighlight lang="bash">
+$ dconf reset -f /
+</syntaxhighlight>
 ==== Extensions ====
@@ Line 111: / Line 122: @@
 == Tips and tricks ==
+=== GNOME power user apps ===
+Both GNOME Tweaks (accessible as <code>gnome-tweaks</code>) and [https://gitlab.gnome.org/TheEvilSkeleton/Refine Refine]  (accessible as <code>refine</code>) allow you to change certain GNOME settings that are hidden by default (such as interface font, window decoration buttons like maximize/minimize, icon themes and GTK themes, etc).
+The GNOME shell extension [https://extensions.gnome.org/extension/3843/just-perfection/ Just Perfection] also allows for customizing nearly all parts of the GNOME shell interface.
+=== GNOME Qt integration ===
+Using the following example configuration, Qt applications will have a look similar to the adwaita style used by GNOME using a dark theme.
+{{File|3={
+  qt = {
+    enable = true;
+    platformTheme = "gnome";
+    style = "adwaita-dark";
+  };
+}|name=/etc/nixos/configuration.nix|lang=nix}}
+For other themes, you may need the packages <code>libsForQt5.qt5ct</code> and <code>libsForQt5.qtstyleplugin-kvantum</code> and a symlink from <code>~/.config/Kvantum/</code> to your theme package. Here is an example using Arc-Dark and [[Home Manager]]. In the Home Manager configuration:
+{{File|3={
+  qt = {
+    enable = true;
+    platformTheme = "qtct";
+    style = "kvantum";
+  };
+  xdg.configFile = {
+    "Kvantum/ArcDark".source = "${pkgs.arc-kde-theme}/share/Kvantum/ArcDark";
+    "Kvantum/kvantum.kvconfig".text = "[General]\ntheme=ArcDark";
+  };
+}|name=~/.config/home-manager/home.nix|lang=nix}}
+For more details, see [https://discourse.nixos.org/t/guide-to-installing-qt-theme/35523/2 this] forum post.{{Note|Qt integration with the adwaita style isn't perfect and your mileage may vary.}}
+=== Experimental settings ===
+GNOME has a number of experimental settings for features not fully completed and thus hidden from the user. As of GNOME 48, these are the experimental features you may want to use:
+{{File|3={
+  programs.dconf.profiles.user.databases = [
+    {
+      settings = {
+        "org/gnome/mutter" = {
+          experimental-features = [
+            "scale-monitor-framebuffer" # Enables fractional scaling (125% 150% 175%)
+            "variable-refresh-rate" # Enables Variable Refresh Rate (VRR) on compatible displays
+            "xwayland-native-scaling" # Scales Xwayland applications to look crisp on HiDPI screens
+          ];
+        };
+      };
+    }
+  ];
+}|name=/etc/nixos/configuration.nix|lang=nix}}
 === Discover dconf settings ===
-If you wish to discover the corresponding dconf entry for a given setting in a program, you can run `dconf watch /` inside of a terminal and change the setting graphically. For example, when changing toggling the Quick-Settings option "Dark Style" from "on" to "off" and back to "on," this will be the output:<syntaxhighlight lang="shell-session">
+If you wish to discover the corresponding dconf entry for a given setting in a program, you can run <code>dconf watch /</code> inside of a terminal and change the setting graphically. For example, when changing toggling the Quick-Settings option "Dark Style" from "on" to "off" and back to "on," this will be the output:<syntaxhighlight lang="shell-session">
 $ dconf watch /
 /org/gnome/desktop/interface/color-scheme
@@ Line 181: / Line 239: @@
 === Excluding GNOME Applications ===
-To exclude certain applications that are installed by default with GNOME, set the {{nixos:option|environment.gnome.excludePackages}} module option:
+To exclude certain applications that are installed by default with GNOME, set the {{nixos:option|environment.gnome.excludePackages}} module option (Optional Packages: [https://github.com/NixOS/nixpkgs/blob/nixos-unstable/nixos/modules/services/desktop-managers/gnome.nix#L449-L471 gnome.nix]):
 {{file|/etc/nixos/configuration.nix|nix|<nowiki>
@@ Line 190: / Line 248: @@
 == Troubleshooting ==
+=== Missing cursor/cursor is a white box ===
+This occurs when installing GNOME from an existing NixOS installation that used a different desktop environment that modified dconf (most likely switching from KDE to GNOME). To easily fix this: reset all dconf settings.<syntaxhighlight lang="bash">
+$ dconf reset -f /
+</syntaxhighlight>
 === Running GConf-based applications ===
@@ Line 224: / Line 287: @@
 }|name=/etc/nixos/configuration.nix|lang=nix}}
 :
-== See also ==
+== References ==
-* [[GNOME/Calendar]]
 [[Category:Desktop environment]]
 [[Category:Applications]]
 [[Category:NixOS Manual]]
 [[Category:GNOME]]