GNOME/Guide

GNOME is a popular desktop environment capable launching Xorg and Wayland sessions. This guide Article description::attempts to describe all aspects of GNOME, including installation, configuration, and usage.

Since version 3.30, GNOME on Gentoo is able to once again run on OpenRC. See GNOME without systemd for more detail.

The project
The GNOME project is a free software organization dedicated to the development of GNOME, a Unix/Linux desktop suite and development platform. The GNOME Foundation coordinates the development and other aspects of the GNOME Project.

The software
GNOME is a desktop environment and a development platform. This piece of free software is the desktop of choice for several industry leaders including Canonical (Ubuntu) and Red Hat (Red Hat Linux, Fedora, Centos).

The community
Like with any large free software project, GNOME has an extensive user and development base. GNOME Planet is a popular blog aggregator for GNOME hackers and contributors whereas developer.gnome.org is for the GNOME developers. GNOME Library contains a huge list of GNOME resources for end users.

Prerequisites
Historically speaking, the Xorg display server was the standard display base for all desktop environments on Linux. With GNOME 3 and beyond, a shift to the Wayland, a newer display server protocol, has begun. Systems other than NVIDIA will have no problem running GNOME sessions over Wayland.

That said, as a general fall back, it is a good idea to first read and follow the instructions in the Xorg guide to setup a X environment.

According to GNOME upstream, GNOME 40 is written with the systemd init system in mind. Because of this, it is a good idea for systemd users to read and comply with all necessary kernel settings from the systemd article.

Profile
Before installing the GNOME suite, editing the system's USE variables is a good idea. The Gentoo GNOME project developers provide GNOME profiles in order to aid system-wide tuning for the GNOME software stack. Select the latest stable GNOME profile before emerging GNOME.

OpenRC
OpenRC users using logind can select the GNOME OpenRC profile:

systemd
systemd users will want to select the following profile:

Make sure that,  , and   are in the USE variable located in. It is recommended to enable support for D-Bus system-wide. systemd includes this system message bus.

Emerge
Once finished, begin the GNOME installation by emerging GNOME the desktop suite:

This will take a while, so start reading some other parts of our wiki. Done? Great, now update environment variables:

Next the remaining services and user groups will be cleaned.

Verify the  group exists. If it does, it is advisable to make each prospective GNOME user member of this group, but step this is optional (the group is not common anymore).

Substitute  in the next command with each GNOME user's user name:

First impressions
It is time to take a look at what was just built. Either configure the session manager to run GNOME when the command is invoked (see using startx in the Xorg guide for more information), or enable the GDM service, for a more convenient way to start GNOME.

OpenRC
For OpenRC systems, elogind is a dependency of GDM and must be started for GDM to run properly:

Next add display-manager-init to the default runlevel and start the service:

In set DISPLAYMANAGER to "gdm"

To start on boot, add display-manager to the default runlevel:

To start GDM either reboot or start it with rc immediately:

systemd
To start GDM upon boot:

To start GDM immediately, run:

Another suggestion is to activate Network Manager, in case no other network managing service is activated.

Using startx
Exit the root shell and log in as a regular user. The next step is to configure the session manager to run GNOME when the the command is invoked (see using startx in the Xorg guide for more information).

Starting with gnome-base/gnome-session-2.26.2, users will need to prepend the XDG_MENU_PREFIX variable to get the GNOME menus when using the method to start the desktop. If is not being used it will be handled automatically; no additional configuration is needed.

Now start the graphical environment by issuing :

If all goes well GNOME should happily provide a greeting. Congratulations on setting up GNOME!

Mixed localization
It could be general to have  as the global default locale, with a different one for the desktop. This can be achieved by add settings:

Then choose the region for locale in gnome-setting-center, or via command:

Log out, make sure the old session is killed and re-login, these settings will be applied to the new session.

To override session's locale for terminal in gnome, add:

Tweaking GNOME
For extra configuration options in GNOME 40 install the package. The tweak tool allows customization at a deeper level than the standard Settings frame.

Advanced tweaking
Advanced tweaking for GNOME can be performed from the command line via the or  commands or graphically via. All modifiable settings are accessible using these tools. For more information, see upstream's documentation.

Widgets in GNOME 40
By default on Gentoo GNOME 40 does not support widgets. For users who wish to obtain widget functionality a separate package is available:

After the shell extensions are installed, can be used to control defaults on a global level:

Enable click-to-install Shell Extensions through the web browser
For web browsers such as Google Chrome, Chromium, and Vivaldi be sure to get the required browser add-on through the Chrome store: https://chrome.google.com/webstore/detail/gphhapmejobijbbhgpjhcjognlahblep

Firefox users can get it here: https://addons.mozilla.org/firefox/addon/gnome-shell-integration/

Opera users will have to snag it here: https://addons.opera.com/extensions/details/gnome-shell-integration/

After the add-on has been installed for the browser of choice, a backend must also be emerged:

It should now be possible to install, manage, and uninstall shell extensions at https://extensions.gnome.org/

If things are not working as expected check the upstream installation instructions for news.

Non-root user authentication for dialogs
Certain GNOME dialogs such as Printers, adding wireless networks, and Users require administrator authentication. This is handled through and operates independently from. By default in Gentoo, the root account is the only administrator, and so even if a user account can run root commands through, authentication in these GNOME dialogs will fail.

If you would like all users of the group to be administrators, create a copy of  starting with a number lower than 50, and edit the line  to the following:

The Polkit wiki page provides more details on rules configuration.

GNOME Hotspot
In order for gnome-hotspot to work, your wireless card must support AP (access point) infrastructure mode. The following package USE flags are also needed:

In addition, the following kernel options are necessary:

Unmerge
A possible way to completely remove a GNOME installation is by explicitly uninstalling the package, then cleaning the dependencies of that package.

In order to do this sanely make sure the main ebuild repository has been synced:

Next, run a world update so that the system is fully up-to-date:

Unmerge the GNOME base package. Substitute the base package with if the 'light' version of the package was installed instead:

Finally, depclean the system:

GNOME should now be removed.

Login failure with message "Oh no something has gone wrong"
One source of this error can be the permissions for the video device. When logging in fails and a message appears that says "Oh no, something has gone wrong", then try to become a member of the group. Add the user to the video group with like so:

GNOME on Wayland session is not launching with NVIDIA
Attempting to launch GNOME on Wayland sessions is a known issue. Unfortunately the NVIDIA binary blob drivers are not presently compatible with Wayland. Systems that simply have the NVIDIA binary blob driver installed, but are not using it can see this workaround.

GNOME built-in screen recorder is not working
GNOME's screen recorder uses vp8 codec which is developed by Google. The recorder needs this codec to record the desktop. It can be enabled it via the the  USE flag in either the  or  files.

GNOME and Pinentry not working with GPG
For example when using Evolution to sign emails with PGP, the private key needs to be decrypted. If this key has a password, a Pinentry dialogue trys to open. To enable the Gtk version, these configuration files need to be edited.

External resources

 * https://github.com/dantrell/gentoo-project-gnome-without-systemd - GNOME without systemd.
 * https://help.gnome.org/admin/ - Upstream GNOME administrator guide.
 * https://help.gnome.org/users/ - Upstream GNOME user guide.