The script hereafter is outdated and has been replaced by a newer version.  Please Check the Download page for latest version.

Hello World, 

Since Ubuntu 23.10 has been released recently, it’s time for us to publish an update of our famous xrdp-installer script.  There are some noticeable changes that have been introduced in Ubuntu 23.10 that slightly affect the xRDP installation process… 

Today, we are releasing the version 1.4.8 of the xrdp-installer script.  This is more a maintenance release that will mainly include Ubuntu 23.10 support.  However, some other changes have been integrated into this version. 

So, let’s see what has changed in this release… ! 

Overview

By now, you should know that the xrdp-installer script aim to ease installation and post-configuration actions of xRDP on top of Ubuntu Operating system.  xRDP is a piece of software that enable remote desktop services on Linux.   This means that windows users can use their Remote desktop client (mstsc) and perform a remote connection to Ubuntu Computer.   

Initially, the script was supporting only Ubuntu with Gnome Desktop interface. However,  recent version of script tries to detect the Desktop interface in use and try to perform the post-configuration actions as required.  Recent version of the script also can run against Debian Operating system as well.  Please note that supporting other Flavors is based on a Best effort approach.

What’s new in this release (Version 1.4.8) ?

Adding Support for Ubuntu 23.10

As requested by our readers, we have updated the script in order to support the latest version of Ubuntu (i.e. 23.10).  The script should be able to correctly detect Ubuntu 23.10 as a supported OS and the script will execute accordingly 

Removing Support for Ubuntu 18.04   

Since Ubuntu 18.04 has reach standard end of support, this Ubuntu version has been removed from the supported list and the script will normally not execute against Ubuntu 18.04.  Some people might say that Ubuntu 18.04 is still under support through the Extended Support solution.  This is correct.  So, if you are still using Ubuntu 18.04, we would recommend you to use previous version of the script (i.e 1.4.7) which still include support of such operating system. 

Removing Support for Ubuntu 22.10

Since Ubuntu 22.10 has reached end of life, we have decided to remove support for this Ubuntu Version.  Ubuntu 22.10 was a short term release and we are expecting that all users have upgraded their Ubuntu distribution to a more recent one or to a long Term support edition.

Fixing Versioning when performing custom installation 

This release of the script should fix a “minor” issue.  Previous versions of the script, when using the custom install option, would generate xrdp and xorgxrdp packages and during the compilation process, package version was provided. We have noticed that when performing some update of our Ubuntu installation, the package version was not correct and that update process was complaining about that.  xrdp-installer-1.4.8 should fix this issue.  After performing the custom installation, the xrdp package version installed should match the stable branch of the xRDP repository. 

Adding Sound redirection with Pipewire Sound Server 

This is one of the most requested feature we have received. 

Previous version of the script would enable sound redirection only if Pulseaudio Sound server was  detected.  This is because xRDP package was specifically expecting Pulseaudio server in order to compile sound redirection modules.  However, since Ubuntu 22.10 and later editions are shipping with Pipewire as default sound server, it was about time that xRDP would provide support also for Pipewire sound server. 

If you remember, we have provided already, in the past, some info about Pipewire support in xRDP in the post xRDP – Testing Initial Pipewire Sound Rediretion Support in Ubuntu 22.10 (Early Stage)   Using Hiero code and approach, it was possible to provide Pipewire support.    This was really early stage process and some tests and validations activities were needed.  

Recently, xRDP Team has provided a new repository where the necessary source code to compile Pipewire sound modules for xrdp can be found.  If you look at xRDP – Sound Redirection Support for Pipewire Module, you will find all the necessary information about the new repo and how to perform the compilation when using Pipewire Sound Server.  

To take into account all these changes, the xrdp-installer script version 1.4.8 has been updated accordingly.  The version 1.4.8 will try to detect which Sound server is in used.  Based on this, the script will compile the correct sound module (Pulseaudio or Pipewire) and sound redirection should be available for you 

Some bug fixing (specifically for Debian Distribution)

Some users have reported that the custom installation was not working on Debian OS. The error was caused by the checkinstall package that is used to compile xrdp and xorgxrdp software solution.   This error was first mentioned by Hiero when xrdp-installer-1.4.6 was released.   We have performed multiple installation and some times it works some times it fails.  After some investigations, it seems that there is indeed a known issue with Checkinstall package available with Debian distributions.  

In order to fix the issue, we simply needed to pass an additional parameter to the checkinstall command line (i.e. – – trans) which will proceed with the installation process. 

New switch available (Testing only !) 

We have added an additional switch  to the script.   The new switch will download the xrdp and xorgxrdp packages from the dev branch.  This switch should be used only for people will to test the latest unstable version of xRDP package.  We have added this switch because time to time we are installing the latest version of the software and try to spot new features or new problems.  This option will probably not be used by a lot of people… but some other people might want to also test the unstable version of xRDP package software… 

How to Use the Script

The xrdp-installer-1.4.8 script will work in a similar way as the previous versions. The following section will explain how to download, extract, set executable mode and perform the installation using the script.  The script provides some switches that can be used to customize the installation process.  

So, let’s see how this would be working…. 

Disclaimer

To download the script, you have multiple options.   You can from a Terminal issue the following command 

wget https://www.c-nergy.be/downloads/xRDP/xrdp-installer-1.4.8.zip

You can also simply use your browser and click on the link to download the script :  

•   xrdp-installer-1.4.8.zip 

Step 2 – unzip the file 

After downloading the zip package containing the file, you will need to unzip it first. To unzip the package, you can use the Terminal console and issue the following command 

unzip xrdp-installer-1.4.8.zip 

You can also use the GUI and the Nautilus file manager to select the downloaded package, right-click on it and select the option Extract Here

Step 2 – Set Execute Right on the script

Download the xrdp-installer-1.4.8.sh script to your system, extract content and mark it as executable . To do this, perform the following action in a terminal console

chmod +x  ~/Downloads/xrdp-installer-1.4.8.sh

Note : Adjust the path where the xrdp-Installer-1.4.8.sh script to reflect your environment

Step 2 – Run as normal user 

The script needs to be run as a normal user.  The script will start running and will prompt you for password when sudo actions are initiated.  If you run the script as root or using sudo command, the Download folder does not exist for the root user and the script fails to run as expected.   To overcome this situation, the script also check which user is executing the script. If the script is run under sudo or root accounts, a warning message will be displayed and the script will not execute

Step 3 – Switches and parameters 

The xrdp-installer-1.4.8.sh script can be executed as is (with no parameters or switches). This will perform a standard (and basic) installation of xRDP.  No sound or custom xrdp login script will be made available.  However, remote desktop, drive redirection and clipboard redirection would be available with this installation mode.  

The xrdp-installer-1.4.8.sh script accept also some additional parameters that will help customize the xrdp installation and enable additional features.  The script provides the following parameters 

--help or -h          => will display a basic help menu
--sound or -s         => will enable sound redirection 
--loginscreen or -l   => will customize the xRDP login screen 
--remove or -r        => will remove the xrdp package 
--custom or -c        => will perform a custom installation (i.e. compiled from sources)
--dev or -d           => will perform a custom installation using dev branch (unstable version)

Step 4 – Perform xRDP installation using the script 

The following sections will provide some examples and scenario on how you can use the script….. 

Standard Installation – No Parameter

As mentioned above, you can decide to use the default xrdp package available in the Ubuntu repository and perform a basic installation which will provide you remote desktop capability and will also customize the remote sesssion.  The script will ensure that the same look n’ feel will be maintained when the user logs on locally or remotely. 

To perform a standard installation, you execute the script with no parameters.  Open a Terminal console, browse to the location where the script has been downloaded and issue the following command 

 ./xrdp-installer-1.4.8.sh

When the xrdp installation package will start, you be requested to enter your password. Provide the password and proceed with the installation. Wait for completion of the script.  The machine will not reboot automatically when done so you can review the actions performed by the script….

Standard Installation with Parameters

The script can be used to perform a standard installation and still passes some parameters to get the most of the xRDP packages and their features.  For all the Ubuntu versions, we could use the following combination of parameters 

./xrdp-installer-1.4.8.sh -s      (this would enable the sound redirection) 
./xrdp-installer-1.4.8.sh -l      (this would customize the xrdp login screen -see here)

Obviously, you can combine the switches (any order) to have more features enabled  

./xrdp-installer-1.4.8.sh -s -l      (this would enable the sound redirection and customize the xrdp login screen)

Important Notes

The script can be run multiple times on the same machine.  If you have run initially the script with no parameters but you decide afterward to enable additional features, the script can be re-executed and the additional features will be enabled.  

Custom Installation – Default Installation 

Custom installation script is really flexible. Custom installation means that the script will compile the xrdp package from the source binaries. The custom installation script always uses the latest xrdp package version available 

To perform a custom installation, you will need at minimum to pass one parameter.  The following command line shows you how to perform a custom installation  

./xrdp-installer-1.4.8.sh -c     (this would perform a custom installation but will not enabled adv features like sound redirection or custom login screen)

Custom Installation – Additional Options  

If a user wants to enable additional features, you will pass some additional parameters as shown in the following examples 

./xrdp-installer-1.4.8.sh -c -s     (this would perform a custom install and enable sound redirection)
./xrdp-installer-1.4.8.sh -c -l     (this would perform a custom install and customize xrdp login screen)
./xrdp-installer-1.4.8.sh -c -l -s  (this would perform a custom install, enable sound and customize login screen)

Important Notes

The script can be run multiple times on the same machine.  If you have run initially the script with no parameters but you decide afterward to enable additional features, the script can be re-executed and the additional features will be enabled.  

Remove Installation option

This version of the script also ship with the option to remove xRDP package.  The removal option should be only used  if you have uses this version of this script to perform the installation.  To remove the xrdp package, you would simply execute the following command  

./xrdp-installer-1.4.8.sh -r     (to remove the xrdp packages)

Step 5 – Test your configuration 

After the script has run and after the reboot/shutdown and start process, it’s time to test and see if you can indeed perform a smooth remote connection to your Ubuntu machine.  Start your favorite rdp client and simply enter your credentials and start testing your installation.  If everything is ok, you will see a similar Desktop interface where Gnome Desktop is used and the Dock is visible. 

Limitations

Switch between standard and Custom install

This version of the script can be run multiple times on the same machine.  However, because of this new behavior, you cannot perform a standard installation and then decide to perform the custom installation.  Once you have selected your installation mode, you will have to stick to it.  This is kind of checked by the script.  

So, if you have performed a standard installation but afterwards you might want to use the custom installation option, the script will ignore the request.  If you want to move from standard install mode to custom mode (or vice versa), the correct process is 

• remove xrdp (using the xrdp-installer-1.4.8.sh -r option) 
• perform a new installation using your selected installation mode (standard or custom install mode) 

Known issues, Fixed Issues and limitations 

Known Issues 

Black Screen or disconnected immediately after connecting

As mentioned and explained multiple times,  this situation will happen (or can happen) when the same user account is used concurrently locally and remotely.  In other words,  the problem is related to the fact that the same user account is already logged in locally and a remote connection is attempted at the same time.  With xRDP software solution, a specific user account can be logged on either locally or remotely but not both….  

In the past, we have provided some workarounds that could be used to allow multiple connections for the same user.  However, in Ubuntu 22.04, we have encountered some additional issues and again we strongly recommend not using these workarounds…..

Some workarounds (provided as is) to try to fix the issues are available. We do not recommend to use them ! Use at your own risk !!!

Final Notes

This is it for this post !   

The script version has not been tested extensively but it should work in most cases.  The script should be seen as a maintenance release in order to maintain usability.  Please if you have time or want to help us in creating the best xRDP installer script, download the script, test it and provide constructive feedback.  If you find a bug or an issue with the script, let us know as well so we can try to fix it.   

We are waiting to see what’s coming with Ubuntu 24.04 and see if a new script release will be needed or not…

Till next time 

See ya