commit 1b1faeb2dbbfd138bf42a0c64ed7dbbd336a5831 · pyrox.dev/nixpkgs

+2 -1

nixos/modules/services/x11/desktop-managers/gnome.nix

···

       64
       64
        
       {

     

       65
       65
        
       

     

       66
       66
        
         meta = {

     

       67
       67
       +
           doc = ./gnome.xml;

     

       67
       68
        
           maintainers = teams.gnome.members;

     

       68
       69
        
         };

     

       69
       70
        
       

     
···

       553
       554
        
               /* gnome-boxes */

     

       554
       555
        
             ] config.environment.gnome.excludePackages);

     

       555
       556
        
       

     

       556
       556
       -
             services.sysprof.enable = true;

     

       557
       557
       +
             services.sysprof.enable = notExcluded pkgs.sysprof;

     

       557
       558
        
           })

     

       558
       559
        
         ];

     

       559
       560

+276

nixos/modules/services/x11/desktop-managers/gnome.xml

···

       1
       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       +
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       +
                xml:id="chap-gnome">

     

       4
       4
       +
        <title>GNOME Desktop</title>

     

       5
       5
       +
        <para>

     

       6
       6
       +
         GNOME provides a simple, yet full-featured desktop environment with a focus on productivity. Its Mutter compositor supports both Wayland and X server, and the GNOME Shell user interface is fully customizable by extensions.

     

       7
       7
       +
        </para>

     

       8
       8
       +
       

     

       9
       9
       +
        <section xml:id="sec-gnome-enable">

     

       10
       10
       +
         <title>Enabling GNOME</title>

     

       11
       11
       +
       

     

       12
       12
       +
         <para>

     

       13
       13
       +
          All of the core apps, optional apps, games, and core developer tools from GNOME are available.

     

       14
       14
       +
         </para>

     

       15
       15
       +
       

     

       16
       16
       +
         <para>

     

       17
       17
       +
          To enable the GNOME desktop use:

     

       18
       18
       +
         </para>

     

       19
       19
       +
       

     

       20
       20
       +
       <programlisting>

     

       21
       21
       +
       <xref linkend="opt-services.xserver.desktopManager.gnome.enable"/> = true;

     

       22
       22
       +
       <xref linkend="opt-services.xserver.displayManager.gdm.enable"/> = true;

     

       23
       23
       +
       </programlisting>

     

       24
       24
       +
       

     

       25
       25
       +
         <note>

     

       26
       26
       +
          <para>

     

       27
       27
       +
           While it is not strictly necessary to use GDM as the display manager with GNOME, it is recommended, as some features such as screen lock <link xlink:href="#sec-gnome-faq-can-i-use-lightdm-with-gnome">might not work</link> without it.

     

       28
       28
       +
          </para>

     

       29
       29
       +
         </note>

     

       30
       30
       +
       

     

       31
       31
       +
         <para>

     

       32
       32
       +
          The default applications used in NixOS are very minimal, inspired by the defaults used in <link xlink:href="https://gitlab.gnome.org/GNOME/gnome-build-meta/blob/40.0/elements/core/meta-gnome-core-utilities.bst">gnome-build-meta</link>.

     

       33
       33
       +
         </para>

     

       34
       34
       +
       

     

       35
       35
       +
         <section xml:id="sec-gnome-without-the-apps">

     

       36
       36
       +
          <title>GNOME without the apps</title>

     

       37
       37
       +
       

     

       38
       38
       +
          <para>

     

       39
       39
       +
           If you’d like to only use the GNOME desktop and not the apps, you can disable them with:

     

       40
       40
       +
          </para>

     

       41
       41
       +
       

     

       42
       42
       +
       <programlisting>

     

       43
       43
       +
       <xref linkend="opt-services.gnome.core-utilities.enable"/> = false;

     

       44
       44
       +
       </programlisting>

     

       45
       45
       +
       

     

       46
       46
       +
          <para>

     

       47
       47
       +
           and none of them will be installed.

     

       48
       48
       +
          </para>

     

       49
       49
       +
       

     

       50
       50
       +
          <para>

     

       51
       51
       +
           If you’d only like to omit a subset of the core utilities, you can use <xref linkend="opt-environment.gnome.excludePackages"/>.

     

       52
       52
       +
           Note that this mechanism can only exclude core utilities, games and core developer tools.

     

       53
       53
       +
          </para>

     

       54
       54
       +
         </section>

     

       55
       55
       +
       

     

       56
       56
       +
         <section xml:id="sec-gnome-disabling-services">

     

       57
       57
       +
          <title>Disabling GNOME services</title>

     

       58
       58
       +
       

     

       59
       59
       +
          <para>

     

       60
       60
       +
           It is also possible to disable many of the <link xlink:href="https://github.com/NixOS/nixpkgs/blob/b8ec4fd2a4edc4e30d02ba7b1a2cc1358f3db1d5/nixos/modules/services/x11/desktop-managers/gnome.nix#L329-L348">core services</link>. For example, if you do not need indexing files, you can disable Tracker with:

     

       61
       61
       +
          </para>

     

       62
       62
       +
       

     

       63
       63
       +
       <programlisting>

     

       64
       64
       +
       <xref linkend="opt-services.gnome.tracker-miners.enable"/> = false;

     

       65
       65
       +
       <xref linkend="opt-services.gnome.tracker.enable"/> = false;

     

       66
       66
       +
       </programlisting>

     

       67
       67
       +
       

     

       68
       68
       +
          <para>

     

       69
       69
       +
           Note, however, that doing so is not supported and might break some applications. Notably, GNOME Music cannot work without Tracker.

     

       70
       70
       +
          </para>

     

       71
       71
       +
         </section>

     

       72
       72
       +
       

     

       73
       73
       +
         <section xml:id="sec-gnome-games">

     

       74
       74
       +
          <title>GNOME games</title>

     

       75
       75
       +
       

     

       76
       76
       +
          <para>

     

       77
       77
       +
           You can install all of the GNOME games with:

     

       78
       78
       +
          </para>

     

       79
       79
       +
       

     

       80
       80
       +
       <programlisting>

     

       81
       81
       +
       <xref linkend="opt-services.gnome.games.enable"/> = true;

     

       82
       82
       +
       </programlisting>

     

       83
       83
       +
         </section>

     

       84
       84
       +
       

     

       85
       85
       +
         <section xml:id="sec-gnome-core-developer-tools">

     

       86
       86
       +
          <title>GNOME core developer tools</title>

     

       87
       87
       +
       

     

       88
       88
       +
          <para>

     

       89
       89
       +
           You can install GNOME core developer tools with:

     

       90
       90
       +
          </para>

     

       91
       91
       +
       

     

       92
       92
       +
       <programlisting>

     

       93
       93
       +
       <xref linkend="opt-services.gnome.core-developer-tools.enable"/> = true;

     

       94
       94
       +
       </programlisting>

     

       95
       95
       +
         </section>

     

       96
       96
       +
        </section>

     

       97
       97
       +
       

     

       98
       98
       +
        <section xml:id="sec-gnome-enable-flashback">

     

       99
       99
       +
         <title>Enabling GNOME Flashback</title>

     

       100
       100
       +
       

     

       101
       101
       +
         <para>

     

       102
       102
       +
          GNOME Flashback provides a desktop environment based on the classic GNOME 2 architecture. You can enable the default GNOME Flashback session, which uses the Metacity window manager, with:

     

       103
       103
       +
         </para>

     

       104
       104
       +
       

     

       105
       105
       +
       <programlisting>

     

       106
       106
       +
       <xref linkend="opt-services.xserver.desktopManager.gnome.flashback.enableMetacity"/> = true;

     

       107
       107
       +
       </programlisting>

     

       108
       108
       +
       

     

       109
       109
       +
         <para>

     

       110
       110
       +
          It is also possible to create custom sessions that replace Metacity with a different window manager using <xref linkend="opt-services.xserver.desktopManager.gnome.flashback.customSessions"/>.

     

       111
       111
       +
         </para>

     

       112
       112
       +
       

     

       113
       113
       +
         <para>

     

       114
       114
       +
          The following example uses <literal>xmonad</literal> window manager:

     

       115
       115
       +
         </para>

     

       116
       116
       +
       

     

       117
       117
       +
       <programlisting>

     

       118
       118
       +
       <xref linkend="opt-services.xserver.desktopManager.gnome.flashback.customSessions"/> = [

     

       119
       119
       +
         {

     

       120
       120
       +
           wmName = "xmonad";

     

       121
       121
       +
           wmLabel = "XMonad";

     

       122
       122
       +
           wmCommand = "${pkgs.haskellPackages.xmonad}/bin/xmonad";

     

       123
       123
       +
         }

     

       124
       124
       +
       ];

     

       125
       125
       +
       </programlisting>

     

       126
       126
       +
       

     

       127
       127
       +
        </section>

     

       128
       128
       +
        <section xml:id="sec-gnome-gdm">

     

       129
       129
       +
         <title>GDM</title>

     

       130
       130
       +
       

     

       131
       131
       +
         <para>

     

       132
       132
       +
          If you want to use GNOME Wayland session on Nvidia hardware, you need to enable:

     

       133
       133
       +
         </para>

     

       134
       134
       +
       

     

       135
       135
       +
       <programlisting>

     

       136
       136
       +
       <xref linkend="opt-services.xserver.displayManager.gdm.nvidiaWayland"/> = true;

     

       137
       137
       +
       </programlisting>

     

       138
       138
       +
       

     

       139
       139
       +
         <para>

     

       140
       140
       +
          as the default configuration will forbid this.

     

       141
       141
       +
         </para>

     

       142
       142
       +
        </section>

     

       143
       143
       +
       

     

       144
       144
       +
        <section xml:id="sec-gnome-icons-and-gtk-themes">

     

       145
       145
       +
         <title>Icons and GTK Themes</title>

     

       146
       146
       +
       

     

       147
       147
       +
         <para>

     

       148
       148
       +
          Icon themes and GTK themes don’t require any special option to install in NixOS.

     

       149
       149
       +
         </para>

     

       150
       150
       +
       

     

       151
       151
       +
         <para>

     

       152
       152
       +
          You can add them to <xref linkend="opt-environment.systemPackages"/> and switch to them with GNOME Tweaks.

     

       153
       153
       +
          If you’d like to do this manually in dconf, change the values of the following keys:

     

       154
       154
       +
         </para>

     

       155
       155
       +
       

     

       156
       156
       +
       <programlisting>

     

       157
       157
       +
       /org/gnome/desktop/interface/gtk-theme

     

       158
       158
       +
       /org/gnome/desktop/interface/icon-theme

     

       159
       159
       +
       </programlisting>

     

       160
       160
       +
       

     

       161
       161
       +
         <para>

     

       162
       162
       +
          in <literal>dconf-editor</literal>

     

       163
       163
       +
         </para>

     

       164
       164
       +
        </section>

     

       165
       165
       +
       

     

       166
       166
       +
        <section xml:id="sec-gnome-shell-extensions">

     

       167
       167
       +
         <title>Shell Extensions</title>

     

       168
       168
       +
       

     

       169
       169
       +
         <para>

     

       170
       170
       +
          Most Shell extensions are packaged under the <literal>gnomeExtensions</literal> attribute.

     

       171
       171
       +
          Some packages that include Shell extensions, like <literal>gnome.gpaste</literal>, don’t have their extension decoupled under this attribute.

     

       172
       172
       +
         </para>

     

       173
       173
       +
       

     

       174
       174
       +
         <para>

     

       175
       175
       +
          You can install them like any other package:

     

       176
       176
       +
         </para>

     

       177
       177
       +
       

     

       178
       178
       +
       <programlisting>

     

       179
       179
       +
       <xref linkend="opt-environment.systemPackages"/> = [

     

       180
       180
       +
         gnomeExtensions.dash-to-dock

     

       181
       181
       +
         gnomeExtensions.gsconnect

     

       182
       182
       +
         gnomeExtensions.mpris-indicator-button

     

       183
       183
       +
       ];

     

       184
       184
       +
       </programlisting>

     

       185
       185
       +
       

     

       186
       186
       +
         <para>

     

       187
       187
       +
          Unfortunately, we lack a way for these to be managed in a completely declarative way.

     

       188
       188
       +
          So you have to enable them manually with an Extensions application.

     

       189
       189
       +
          It is possible to use a <link xlink:href="#sec-gnome-gsettings-overrides">GSettings override</link> for this on <literal>org.gnome.shell.enabled-extensions</literal>, but that will only influence the default value.

     

       190
       190
       +
         </para>

     

       191
       191
       +
        </section>

     

       192
       192
       +
       

     

       193
       193
       +
        <section xml:id="sec-gnome-gsettings-overrides">

     

       194
       194
       +
         <title>GSettings Overrides</title>

     

       195
       195
       +
       

     

       196
       196
       +
         <para>

     

       197
       197
       +
          Majority of software building on the GNOME platform use GLib’s <link xlink:href="https://developer.gnome.org/gio/unstable/GSettings.html">GSettings</link> system to manage runtime configuration. For our purposes, the system consists of XML schemas describing the individual configuration options, stored in the package, and a settings backend, where the values of the settings are stored. On NixOS, like on most Linux distributions, dconf database is used as the backend.

     

       198
       198
       +
         </para>

     

       199
       199
       +
       

     

       200
       200
       +
         <para>

     

       201
       201
       +
          <link xlink:href="https://developer.gnome.org/gio/unstable/GSettings.html#id-1.4.19.2.9.25">GSettings vendor overrides</link> can be used to adjust the default values for settings of the GNOME desktop and apps by replacing the default values specified in the XML schemas. Using overrides will allow you to pre-seed user settings before you even start the session.

     

       202
       202
       +
         </para>

     

       203
       203
       +
       

     

       204
       204
       +
         <warning>

     

       205
       205
       +
          <para>

     

       206
       206
       +
           Overrides really only change the default values for GSettings keys so if you or an application changes the setting value, the value set by the override will be ignored. Until <link xlink:href="https://github.com/NixOS/nixpkgs/issues/54150">NixOS’s dconf module implements changing values</link>, you will either need to keep that in mind and clear the setting from the backend using <literal>dconf reset</literal> command when that happens, or use the <link xlink:href="https://nix-community.github.io/home-manager/options.html#opt-dconf.settings">module from home-manager</link>.

     

       207
       207
       +
          </para>

     

       208
       208
       +
         </warning>

     

       209
       209
       +
       

     

       210
       210
       +
         <para>

     

       211
       211
       +
          You can override the default GSettings values using the <xref linkend="opt-services.xserver.desktopManager.gnome.extraGSettingsOverrides"/> option.

     

       212
       212
       +
         </para>

     

       213
       213
       +
       

     

       214
       214
       +
         <para>

     

       215
       215
       +
          Take note that whatever packages you want to override GSettings for, you need to add them to

     

       216
       216
       +
          <xref linkend="opt-services.xserver.desktopManager.gnome.extraGSettingsOverridePackages"/>.

     

       217
       217
       +
         </para>

     

       218
       218
       +
       

     

       219
       219
       +
         <para>

     

       220
       220
       +
          You can use <literal>dconf-editor</literal> tool to explore which GSettings you can set.

     

       221
       221
       +
         </para>

     

       222
       222
       +
       

     

       223
       223
       +
         <section xml:id="sec-gnome-gsettings-overrides-example">

     

       224
       224
       +
          <title>Example</title>

     

       225
       225
       +
       

     

       226
       226
       +
       <programlisting>

     

       227
       227
       +
       services.xserver.desktopManager.gnome = {

     

       228
       228
       +
         <link xlink:href="#opt-services.xserver.desktopManager.gnome.extraGSettingsOverrides">extraGSettingsOverrides</link> = ''

     

       229
       229
       +
           # Change default background

     

       230
       230
       +
           [org.gnome.desktop.background]

     

       231
       231
       +
           picture-uri='file://${pkgs.nixos-artwork.wallpapers.mosaic-blue.gnomeFilePath}'

     

       232
       232
       +
       

     

       233
       233
       +
           # Favorite apps in gnome-shell

     

       234
       234
       +
           [org.gnome.shell]

     

       235
       235
       +
           favorite-apps=['org.gnome.Photos.desktop', 'org.gnome.Nautilus.desktop']

     

       236
       236
       +
         '';

     

       237
       237
       +
       

     

       238
       238
       +
         <link xlink:href="#opt-services.xserver.desktopManager.gnome.extraGSettingsOverridePackages">extraGSettingsOverridePackages</link> = [

     

       239
       239
       +
           pkgs.gsettings-desktop-schemas # for org.gnome.desktop

     

       240
       240
       +
           pkgs.gnome.gnome-shell # for org.gnome.shell

     

       241
       241
       +
         ];

     

       242
       242
       +
       };

     

       243
       243
       +
       </programlisting>

     

       244
       244
       +
         </section>

     

       245
       245
       +
        </section>

     

       246
       246
       +
       

     

       247
       247
       +
        <section xml:id="sec-gnome-faq">

     

       248
       248
       +
         <title>Frequently Asked Questions</title>

     

       249
       249
       +
       

     

       250
       250
       +
         <section xml:id="sec-gnome-faq-can-i-use-lightdm-with-gnome">

     

       251
       251
       +
          <title>Can I use LightDM with GNOME?</title>

     

       252
       252
       +
       

     

       253
       253
       +
          <para>

     

       254
       254
       +
           Yes you can, and any other display-manager in NixOS.

     

       255
       255
       +
          </para>

     

       256
       256
       +
       

     

       257
       257
       +
          <para>

     

       258
       258
       +
           However, it doesn’t work correctly for the Wayland session of GNOME Shell yet, and

     

       259
       259
       +
           won’t be able to lock your screen.

     

       260
       260
       +
          </para>

     

       261
       261
       +
       

     

       262
       262
       +
          <para>

     

       263
       263
       +
           See <link xlink:href="https://github.com/NixOS/nixpkgs/issues/56342">this issue.</link>

     

       264
       264
       +
          </para>

     

       265
       265
       +
         </section>

     

       266
       266
       +
       

     

       267
       267
       +
         <section xml:id="sec-gnome-faq-nixos-rebuild-switch-kills-session">

     

       268
       268
       +
          <title>Why does <literal>nixos-rebuild switch</literal> sometimes kill my session?</title>

     

       269
       269
       +
       

     

       270
       270
       +
          <para>

     

       271
       271
       +
           This is a known <link xlink:href="https://github.com/NixOS/nixpkgs/issues/44344">issue</link> without any workarounds.

     

       272
       272
       +
           If you are doing a fairly large upgrade, it is probably safer to use <literal>nixos-rebuild boot</literal>.

     

       273
       273
       +
          </para>

     

       274
       274
       +
         </section>

     

       275
       275
       +
        </section>

     

       276
       276
       +
       </chapter>