Official NixOS Wiki

GNOME: Difference between revisions

← Older editNewer edit →
VisualWikitext
Normalcea (talk | contribs)
36 edits
→To run old applications: Move to troubleshooting section and modernize.
Jasi (talk | contribs)
32 edits
→GNOME extensions: Improve word choice.
(25 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[{{PAGENAME}}]] (/(ɡ)noʊm/) is a [[:Category:Desktop environment|desktop environment]] for both [[Wayland]] and [[Xorg]] that seeks to be "an independent computing platform for everyone."<ref>Official GNOME Project one-liner https://www.gnome.org/ </ref>
[[{{PAGENAME}}]] (/(ɡ)noʊm/) is a [[:Category:Desktop environment|desktop environment]] that seeks to be "an independent computing platform for everyone."<ref>Official GNOME Project one-liner https://www.gnome.org/ </ref>


This article is an extension of the documentation in the [https://nixos.org/manual/nixos/stable/#chap-gnome NixOS manual].
This article is an extension of the documentation in the [https://nixos.org/manual/nixos/stable/#chap-gnome NixOS manual].
Line 5: Line 5:
== Installation ==
== Installation ==


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


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
Line 20: Line 21:
</nowiki>}}
</nowiki>}}


Despite the options in NixOS versions before 25.11 being under the <code>xserver</code> namespace, GNOME runs offers [[Wayland]] by default. 25.11 and later versions remove support for the [[Xorg]] session entirely (though Xwayland is still included and supported for compatibility).
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 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.
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={
{{file|3={
Line 42: Line 43:
For example, the setting which controls the accent color of GNOME shell is located in the ''schema'' labeled <code>/org/gnome/desktop/interface/</code> which contains the ''key'' <code>accent-color</code> which accepts a GVariant ''value'' of type <code>enum</code> (one of <code>'blue'</code>, <code>'teal'</code>, <code>'green'</code>, etc)
For example, the setting which controls the accent color of GNOME shell is located in the ''schema'' labeled <code>/org/gnome/desktop/interface/</code> which contains the ''key'' <code>accent-color</code> which accepts a GVariant ''value'' of type <code>enum</code> (one of <code>'blue'</code>, <code>'teal'</code>, <code>'green'</code>, etc)


NixOS and Home Manager both provide an interface for declarative configuration of dconf settings exposed in <code>programs.dconf</code> and <code>dconf</code> modules respectively. This option accepts an attribute set whose names are schemas whose paired value is another attribute set whose names are keys and paired values as GVariant values.
NixOS and Home Manager both provide an interface for declarative configuration of dconf settings exposed in <code>programs.dconf</code> and <code>dconf</code> modules respectively.


Going back to the previous example, to set the accent color of GNOME in a declarative manner in NixOS as well as mapping the keyboard's "caps lock" key to "ctrl" you would write:
Going back to the previous example, to set the accent color of GNOME in a declarative manner in NixOS as well as mapping the keyboard's "caps lock" key to "ctrl" you would write:
Line 60: Line 61:
     }
     }
   ];
   ];
}|name=/etc/nixos/configuration.nix|lang=Nix}}
}|name=/etc/nixos/configuration.nix|lang=nix}}


And the equivalent snippet in Home Manager:
And the equivalent snippet in Home Manager:
Line 74: Line 75:
     };
     };
   };
   };
}|name=~/.config/home-manager/home.nix|lang=nix}}
}|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 /
{{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 function defined in <code>lib.gvariant</code>, they're documented [https://nixos.org/manual/nixpkgs/stable/#sec-functions-library-gvariant here].}}
</syntaxhighlight>


==== Extensions ====
==== Extensions ====
Line 88: Line 89:
     settings = {
     settings = {
       "org/gnome/shell" = {
       "org/gnome/shell" = {
         disable-user-extensions = false; # enables user extensions
         # disable-user-extensions = true; # Optionally disable user extensions entirely
         enabled-extensions = [
         enabled-extensions = [
           # Put UUIDs of extensions that you want to enable here.
           # Put UUIDs of extensions that you want to enable here.
Line 112: Line 113:


== Tips and tricks ==
== 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 ===
=== Discover dconf settings ===
Line 146: Line 194:
</syntaxhighlight>Which tells you that the ''key'' <code>picture-options</code> located in ''schema'' <code>/org/gnome/desktop/background/</code> accepts a ''value'' of type enumeration (a single string value from a set of accepted values).  
</syntaxhighlight>Which tells you that the ''key'' <code>picture-options</code> located in ''schema'' <code>/org/gnome/desktop/background/</code> accepts a ''value'' of type enumeration (a single string value from a set of accepted values).  


=== To run GNOME programs outside of GNOME ===
=== Enable system tray icons ===
 
GNOME does not currently support system tray icons. However, Ubuntu has created an [https://extensions.gnome.org/extension/615/appindicator-support/ extension] that implements this in the top bar. You can install this extension with the following in NixOS:
GNOME platform-based applications are largely [https://nixos.org/nixpkgs/manual/#sec-language-gnome self-contained], but they still depend, for one reason or another, on some global configuration. The {{ic|gnome.nix}} module sets all the necessary options for you but if you are running customized set-up, you might need to replicate that yourself.
{{File|3={
 
   environment.systemPackages = [ pkgs.gnomeExtensions.appindicator ];
For instance, if you see the following error:
 
<syntaxhighlight lang="text">
dconf-WARNING **: failed to commit changes to dconf: GDBus.Error:org.freedesktop.DBus.Error.ServiceUnknown: The name ca.desrt.dconf was not provided by any .service files
</syntaxhighlight>
 
you should enable dconf module:
 
<syntaxhighlight lang="nix">
{
  programs.dconf.enable = true;
}
</syntaxhighlight>If you're using the default theme, GTK-3 applications may not respect the dark theme if they can't find the Adwaita. To fix it, make sure you have the <code>gnome-themes-extra</code> package installed:<syntaxhighlight lang="nix">
{
  environment.systemPackages = [ pkgs.gnome-themes-extra ];
}
</syntaxhighlight>
 
=== Systray Icons ===
 
To get systray icons, install the related GNOME shell extension
 
<syntaxhighlight lang="nix">
{
   environment.systemPackages = [ pkgs.gnomeExtensions.appindicator ];
}
</syntaxhighlight>
 
And ensure gnome-settings-daemon udev rules are enabled:
 
<syntaxhighlight lang="nix">
{
   services.udev.packages = [ pkgs.gnome-settings-daemon ];
   services.udev.packages = [ pkgs.gnome-settings-daemon ];
}
}|name=/etc/nixos/configuration.nix|lang=nix}}
</syntaxhighlight>


=== Profiling (with sysprof) ===
=== Profiling (with sysprof) ===
Line 213: Line 228:
</nowiki>}}
</nowiki>}}


== Troubleshoots ==
=== Excluding GNOME Applications ===
 
To exclude certain applications that are installed by default with GNOME, set the {{nixos:option|environment.gnome.excludePackages}} module option:
 
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
  environment.gnome.excludePackages = with pkgs; [
    totem
  ];
</nowiki>}}
 
== 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 ===
=== Running GConf-based applications ===
Line 223: Line 253:
</syntaxhighlight>
</syntaxhighlight>


you will need to add {{ic|gnome2.GConf}} to the list of dbus packages in your NixOS configuration:
you will need to add <code>pkgs.gnome2.GConf</code> to the list of dbus packages in your NixOS configuration like so:


{{File|3={
{{File|3={
Line 233: Line 263:
=== Automatic login ===
=== Automatic login ===


If you have enabled [https://help.gnome.org/admin/system-admin-guide/stable/login-automatic.html.en auto login] (with <!-- [[GDM]] -->[[{{PAGENAME}}]]) with something like
As a potential workaround<ref>https://github.com/NixOS/nixpkgs/issues/103746#issuecomment-945091229</ref> for automatic login, include this in your NixOS configuration:
: <syntaxHighlight lang="console">
 
$ grep autoLogin /etc/nixos/configuration.nix
{{File|3={
</syntaxHighlight>
  services.xserver.displayManager.autoLogin.enable = true;
<syntaxHighlight lang="nix">
  services.xserver.displayManager.autoLogin.user = "account";
services.xserver.displayManager.autoLogin.enable = true;
 
services.xserver.displayManager.autoLogin.user = "account";
</syntaxHighlight>
than add the following (as a workaround for a current (2023)<ref>https://github.com/NixOS/nixpkgs/issues/103746#issuecomment-945091229</ref> problem)
: <syntaxHighlight lang="console"># nano /etc/nixos/configuration.nix</syntaxHighlight>
<syntaxHighlight lang="nix">
{
   systemd.services."getty@tty1".enable = false;
   systemd.services."getty@tty1".enable = false;
   systemd.services."autovt@tty1".enable = false;
   systemd.services."autovt@tty1".enable = false;
}
}|name=/etc/nixos/configuration.nix|lang=nix}}
</syntaxHighlight>


=== GDM does not show user ===
The GDM (GNOME Display Manager) will not display a user if their default shell is not listed in <code>/etc/shells</code>. If your shell, such as zsh, is not included in <code>/etc/shells</code>, you need to add it to the configuration.{{File|3={
  environment.shells = with pkgs; [ zsh ];
}|name=/etc/nixos/configuration.nix|lang=nix}}
:
== See also ==
== See also ==
* [[GNOME/Calendar]]
* [[GNOME/Calendar]]
Retrieved from "https://wiki.nixos.org/wiki/GNOME"