Configure single-application mode

Matthias Clasen mclasen@redhat.com 2014 Jana Svarova jana.svarova@gmail.com 2014 Petr Kovar pknbe@volny.cz 2019 Marek Suchánek msuchane@redhat.com 2023 Set up a kiosk-like, single-application system. Configure single-application mode

Single-application mode is a modified GNOME Shell which configures the Shell as an interactive kiosk. The administrator locks down some behavior to make the standard desktop more restrictive for users, letting them focus on selected features.

Set up single-application mode for a wide range of functions in a number of fields (from communication to entertainment or education), and use it as a self-serve machine, event manager, registration point, and so on.

Your distribution might provide the GNOME Kiosk session, which is usually available in the gnome-kiosk package. You can use it to configure single-application mode more easily. Otherwise, use the following procedure.

Set up single-application mode

Lock down settings to prevent printing, terminal access, and so on.

Configure automatic login in the /etc/gdm/custom.conf file for the user.

See for more information.

Create the following files with the listed content:

<file>/usr/share/applications/org.gnome.Kiosk.Script.desktop</file>


[Desktop Entry]
Name=Kiosk
Type=Application
Exec=gnome-kiosk

<file>/usr/share/applications/org.gnome.Kiosk.WindowManager.desktop</file>


[Desktop Entry]
Type=Application
Name=Mutter
Comment=Window manager
Exec=/usr/bin/mutter
Categories=GNOME;GTK;Core;
OnlyShowIn=GNOME;
NoDisplay=true
X-GNOME-Autostart-Phase=DisplayServer
X-GNOME-Provides=windowmanager;
X-GNOME-Autostart-Notify=true
X-GNOME-AutoRestart=false
X-GNOME-HiddenUnderSystemd=true

<file>/usr/share/gnome-session/sessions/gnome-kiosk.session</file>


[GNOME Session]
Name=Kiosk
RequiredComponents=org.gnome.Kiosk.WindowManager;org.gnome.Kiosk.Script;

<file>/usr/share/X11/xorg.conf.d/20-gnome-kiosk.conf</file>


Section "ServerFlags"
    Option "DontVTSwitch" "on"
EndSection

<file>/usr/share/xsessions/org.gnome.Kiosk.desktop</file>


[Desktop Entry]
Name=Kiosk
Comment=Kiosk mode
Exec=/usr/bin/gnome-session --session=gnome-kiosk
DesktopNames=GNOME-Kiosk;GNOME;

As the user that will open the single-application session, create the /home/user/.local/bin/gnome-kiosk file:


[user]$ mkdir -p ~/.local/bin

[user]$ touch ~/.local/bin/gnome-kiosk

Edit the /home/user/.local/bin/gnome-kiosk file and enter the executable name of the application that you want to launch in single-application mode.

For example, to launch the Firefox browser in single-application mode, enter the following content:


#!/bin/sh

while true; do
    firefox --kiosk https://example.org
done

The while true loop ensures that the application restarts if it terminates for any reason.

Make the file executable:


[user]$ chmod +x ~/.local/bin/gnome-kiosk

If you created the file or its containing directories as a different user than the single-application user, such as root, ensure that the file has the correct permissions:


# chown -R user:group ~user/.local

At the GNOME login screen, select the Kiosk session from the gear button menu and log in as the single-application user.