Displaying Ubuntu 22.04 Applications Remotely (X11 Forwarding)

In the previous chapter, we looked at how to display the entire Ubuntu desktop on a remote computer. While this works well if you need to display the entire desktop remotely, it could be considered overkill if you only want to display a single application. Therefore, this chapter will look at displaying individual applications on a remote system.

Requirements for Remotely Displaying Ubuntu Applications

There are some prerequisites to running an application on one Ubuntu system and displaying it on another. First, the system on which the application is to be displayed must be running an X server. If the system is a Linux or UNIX-based system with a desktop environment running, then this is no problem. However, if the system is running Windows or macOS, you must install an X server on it before you can display applications from a remote system. Several commercial and free Windows-based X servers are available for this purpose, and a web search should provide you with a list of options.

Second, the system on which the application is being run (as opposed to the system on which the application is to be displayed) must be configured to allow SSH access. Details on configuring SSH on an Ubuntu system can be found in the chapter Configuring SSH Key-based Authentication on Ubuntu 22.04. This system must also run the X Window System from X.org instead of Wayland. To enable the X.org system from within the desktop, log out of the Gnome desktop, select your user account from the login screen, and then click the settings button in the bottom right-hand corner of the screen:

Figure 19-1

Select the GNOME on Xorg option from the menu before logging in as usual. To revert to Wayland, repeat these steps, selecting the Ubuntu option from the login screen settings menu.

Another option is to edit the /etc/gdm3/custom.conf file, uncomment the WaylandEnable line as follows and restart the system:

 

You are reading a sample chapter from Ubuntu 22.04 Essentials. Buy the full book now in eBook ($24.99) format. Includes 36 chapters. Learn more.

Preview  Buy eBook 

 

# Uncomment the line below to force the login screen to use Xorg
WaylandEnable=falseCode language: plaintext (plaintext)

Once you have logged back into the desktop, open a Terminal window and run the following command to confirm that the X.org system has been enabled:

$ echo $XDG_SESSION_TYPECode language: plaintext (plaintext)

The above command will output either x11 or wayland, depending on the current configuration.

Finally, SSH must be configured to allow X11 forwarding. This is achieved by adding the following directive to the SSH configuration on the system from which forwarding is to occur. By default on Ubuntu, the /etc/sshd_config file contains a directive to include all of the configuration files contained in the /etc/ssh/sshd_config.d directory:

Include /etc/ssh/sshd_config.d/*.confCode language: plaintext (plaintext)

A file named 50-cloud-init.conf will have been created on a newly installed system in the /etc/ ssh/sshd_config.d folder. Edit this file and ensure that the X11Forwarding property is enabled as follows:

X11Forwarding yesCode language: plaintext (plaintext)

After making the change, save the file and restart the SSH service:

 

You are reading a sample chapter from Ubuntu 22.04 Essentials. Buy the full book now in eBook ($24.99) format. Includes 36 chapters. Learn more.

Preview  Buy eBook 

 

# systemctl restart sshdCode language: plaintext (plaintext)

Once the above requirements are met, it should be possible to display an X-based desktop application remotely.

Displaying an Ubuntu Application Remotely

The first step in remotely displaying an application is to move to the system where the application is to be displayed. At this system, establish an SSH connection to the remote system so that you have a command prompt. This can be achieved using the ssh command. When using the ssh command, we need to use the -X flag to tell it that we plan to tunnel X11 traffic through the connection:

$ ssh -X user@hostname

In the above example, user is the user name to use to log into the remote system, and hostname is the hostname or IP address of the remote system. Enter your password at the login prompt and, once logged in, run the following command to see the DISPLAY setting:

$ echo $DISPLAYCode language: PHP (php)

The command should output something similar to the following:

localhost:10.0Code language: plaintext (plaintext)

To display an application, run it from the command prompt. For example:

 

You are reading a sample chapter from Ubuntu 22.04 Essentials. Buy the full book now in eBook ($24.99) format. Includes 36 chapters. Learn more.

Preview  Buy eBook 

 

$ gedit

When executed, the above command should run the gedit tool on the remote system but display the user interface on the local system.

Trusted X11 Forwarding

If the /etc/ssh/sshd_config.d/50-cloud-init.conf file on the remote system contains the following line, then it is possible to use trusted X11 forwarding:

ForwardX11Trusted yesCode language: plaintext (plaintext)

Trusted X11 forwarding is slightly faster than untrusted forwarding but is less secure since it does not engage the X11 security controls. The -Y flag is needed when using trusted X11 forwarding:

$ ssh -Y user@hostnameCode language: plaintext (plaintext)

Compressed X11 Forwarding

When using slower connections, the X11 data can be compressed using the ssh -C flag to improve performance:

$ ssh -X -C user@hostnameCode language: plaintext (plaintext)

Displaying Remote Ubuntu Apps on Windows

To display Ubuntu-based apps on Windows, an SSH client and an X server must be installed on the Windows system. Installing and using the PuTTY client on Windows was covered earlier in the book in the Configuring SSH Key-based Authentication on Ubuntu 22.04 chapter. Refer to this chapter if you have not already installed PuTTY on your Windows system.

 

You are reading a sample chapter from Ubuntu 22.04 Essentials. Buy the full book now in eBook ($24.99) format. Includes 36 chapters. Learn more.

Preview  Buy eBook 

 

In terms of the X server, several options are available, though a popular choice appears to be VcXsrv which is available for free from the following URL:

https://sourceforge.net/projects/vcxsrv/

Once the VcXsrv X server has been installed, an application named XLaunch will appear on the desktop and in the start menu. Start XLaunch and select a display option (the most flexible being the Multiple windows option which allows each client app to appear in its own window):

Figure 19-2

Click the Next button to proceed through the remaining screens, accepting the default configuration settings. On the final screen, click the Finish button to start the X server. If the Windows Defender dialog appears, click the button to allow access to your chosen networks.

Once running, XLaunch will appear in the taskbar and can be exited by right-clicking on the icon and selecting the Exit… menu option:

 

You are reading a sample chapter from Ubuntu 22.04 Essentials. Buy the full book now in eBook ($24.99) format. Includes 36 chapters. Learn more.

Preview  Buy eBook 

 

Figure 19-3

With the X server installed and running, launch PuTTY and either enter the connection information for the remote host or load a previously saved session profile. Before establishing the connection, however, X11 forwarding needs to be enabled. Therefore, within the PuTTY main window, scroll down the options in the left-hand panel, unfold the SSH section, and select the X11 option, as shown in Figure 19-4:

Displaying Ubuntu 22.04 Applications Remotely (X11 Forwarding)

Figure 19-4

Turn on the Enable X11 forwarding checkbox highlighted in Figure 19-5, return to the sessions screen, and open the connection (saving the session beforehand if you plan to use it again):

Figure 19-5

Log into the Ubuntu system within the PuTTY session window and run a desktop app. After a short delay, the app will appear on the Windows desktop in its own window. Any dialogs the app opens will also appear in separate windows, just as they would on the Ubuntu GNOME desktop. Figure 19-6, for example, shows the Ubuntu nm-connection-editor tool displayed on a Windows 11 system:

Figure 19-6

Summary

For situations where remote access to individual Ubuntu desktop applications is required as opposed to the entire GNOME desktop, X11 forwarding provides a lightweight solution to remotely displaying graphical applications. The system on which the applications are to appear must be running an X Window System-based desktop environment (such as GNOME) or have an X server installed and running. Once X11 forwarding has been enabled on the remote server and a secure SSH connection established from the local system using the X11 forwarding option, most applications can be displayed remotely on the local X server.

 

You are reading a sample chapter from Ubuntu 22.04 Essentials. Buy the full book now in eBook ($24.99) format. Includes 36 chapters. Learn more.

Preview  Buy eBook 

 


Categories