GoAdmio

xrdp

Install a desktop (GUI) and xRDP so you can connect to the server with Windows Remote Desktop

On this page: Overview · Quick start · Syntax · Options · Output · Examples · Troubleshooting · Details · See also


Overview

/go/xrdp lets you use the server's graphical desktop remotely. It installs a desktop environment and xRDP, an open-source Remote Desktop Protocol (RDP) server, then opens port 3389 in the firewall. Afterward you can connect from any Windows computer with the built-in Remote Desktop Connection app.

It works on AlmaLinux, Rocky Linux, CentOS, Red Hat, Fedora, Debian, and Ubuntu. The command runs sudo internally, so run it as root or as a user with sudo rights, and the server needs internet access.

[!WARNING] The command opens port 3389 to everyone, and its on-screen instructions tell you to log in as root. RDP is a common target for password guessing. Restrict the port to your own IP address in the firewall, close it with deny when you don't need it, and consider logging in as a regular user instead of root.

A desktop environment is a large install (hundreds of megabytes, and more than 1 GB on the RHEL family), and desktop sessions use extra memory and CPU. It is best suited to a server where you need a GUI.


Quick start

# Install the desktop and xRDP
/go/xrdp

Syntax

/go/xrdp

The command takes no arguments. Anything you add is written to the command log but otherwise ignored.

Every run is recorded in /var/log/go/xrdp.log, with the time and the arguments you passed.


Options

None.


Output

You see the package manager's output, then, on a supported system, these connection instructions:

Now, it’s time to take RDP sessions from any Windows machine using Remote Desktop Protocol.
Run Remote Desktop on Windows
Username: root
Password: ******** (ROOT Password)
Outcome What you get
Supported operating system Package manager output, then the instructions above.
Unsupported operating system Unknown operating system. Exit status 1. Nothing is installed.

The command does not stop when a step fails, and it prints the instructions even if an install step failed. Check the output for errors, then test the connection.

Log

Each run appends one line to /var/log/go/xrdp.log:

[Nov 21 12:00:00]# xrdp

Examples

# Install the desktop and xRDP
/go/xrdp
# Check that the xRDP service is running
systemctl status xrdp
# Check that port 3389 is listening
ss -tln | grep 3389

To connect, open Remote Desktop Connection on Windows, enter the server's IP address (the port is 3389 by default), and sign in with a server username and password.


Troubleshooting

Symptom Likely cause Fix
Unknown operating system. The operating system isn't one of the supported systems. Install xRDP manually.
Unable to locate package firefox-esr on Ubuntu firefox-esr is a Debian package and isn't in Ubuntu's own repositories. Ignore it, or install a browser another way. The other steps still run.
The EPEL or xRDP install fails on AlmaLinux, Rocky, or Red Hat 8 or later The command adds the EPEL repository package for Enterprise Linux 7, whatever the server's version. Install the EPEL package that matches your system, then install xrdp and tigervnc-server.
Windows can't connect Port 3389 isn't open in the server firewall, or in a firewall outside the server (such as your hosting provider's). Check the firewall with firewall-cmd --list-ports or ufw status, and open the port with allow.
The port still isn't open on the RHEL family The firewall reload step uses -reload with a single dash and may not run, so the new rule isn't active. Run firewall-cmd --reload.
The login is rejected Wrong username or password. Use an account that exists on the server and its correct password.
The install takes very long or fills the disk The desktop packages are large. Check free disk space first, and run the command inside screen.

Details

What it installs

RHEL family Debian and Ubuntu
Package manager yum apt
Desktop The "Server with GUI" group Xfce (xfce4, xfce4-goodies, xorg, dbus-x11, x11-xserver-utils)
Remote desktop xrdp, tigervnc-server (after adding EPEL for Enterprise Linux 7) xrdp
Browser — firefox-esr
Certificate access — Adds the xrdp user to the ssl-cert group
Service Enables and restarts xrdp Enables and restarts xrdp
Firewall Opens 3389/tcp in the public zone with firewall-cmd, then reloads Runs ufw allow 3389

The command doesn't create a new user. You sign in with an existing server account, and the instructions it prints use root.

flowchart TD
    A["xrdp"] --> B["Log the run"]
    B --> C{"Operating system"}
    C -- "RHEL family" --> D["Install the Server with GUI group, EPEL 7, tigervnc-server, xrdp"]
    C -- "Debian / Ubuntu" --> E["Install Xfce, xrdp, firefox-esr, add xrdp to ssl-cert"]
    C -- "Other" --> X["Unknown operating system, exit 1"]
    D --> F["Enable and restart xrdp, open port 3389 with firewall-cmd"]
    E --> G["Enable and restart xrdp, open port 3389 with ufw"]
    F --> H["Print the connection instructions"]
    G --> H

See also

Command Description
allow Open a TCP port in the server firewall
deny Close a TCP port by removing its allow rule from the server's firewall
firewall Install and configure the server firewall (firewalld or UFW) with GoAdmio's default open ports, and start, stop, or reset it
package Upgrade system packages, then install any missing GoAdmio base packages and tools