README

Current Version: 0.9.1

xrdp - an open source RDP server

Overview

xrdp provides a graphical login to remote machines using RDP (Microsoft Remote Desktop Protocol). xrdp accepts connections from variety of RDP clients: FreeRDP, rdesktop, NeutrinoRDP and Microsoft Remote Desktop Client (for Windows, macOS, iOS and Android).

As Windows-to-Windows Remote Desktop can, xrdp supports not only graphics remoting but also

• two-way clipboard transfer (text, bitmap, file)
• audio redirection
• drive redirection (mount local client drives on remote machine)

RDP transport is encrypted using TLS by default.

Features

Graphics Remoting

• reconnect existing session
• resize session
• RDP/VNC proxy (connect to another RDP/VNC server via xrdp)

(we should mention xorgxrdp here. like "xorgxrdp" is needed to get full functionality.)

(vnc backend cannot resize, cannot reconnect existing session from different geometry)

Other Resources Remoting

• two-way clipboard transfer (text, bitmap, file)
• audio redirection
• drive redirection (mount local client drives on remote machine)

Quick Start

Some distributions have the latest release of xrdp in their repository. For example, Debian is the one.

(in some distro, xorgxrdp will be installed automatically by dependency)

Ubuntu / Debian

apt-get install xrdp

CentOS

yum install xrdp

(no xorgxrdp package yet)

Fedora

dnf install xrdp

• Building from sources

Environment

xrdp primarily targets to GNU/Linux. Tested on x86, x86_64, SPARC and PowerPC. Some submodules such as rfxcodec are optimized for x86, x86_64.

FreeBSD is not a primary target of xrdp. It is almost working on FreeBSD except for drive redirection feature.

Other operating systems such as macOS is not supported so far but we welcome your contributions.

Compiling

Pre-requisites

To compile xrdp from the packaged sources, you need basic build tools - a compiler (gcc or clang) and the make program. Additionally, you would need openssl-devel, pam-devel, libX11-devel, libXfixes-devel, libXrandr-devel. More additional software would be needed depending on your configuration.

To compile xrdp from a checked out git repository, you would additionally need autoconf, automake, libtool and pkgconfig.

Get the source & build it

If compiling from the packaged source, unpack the tarball and change to the resulting directory.

If compiling from a checked out repository, run ./bootstrap first to create configure and other required files.

Then run following commands to compile and install xrdp:

./configure
make
sudo make install

Directory Structure

xrdp
├── common
├── docs
├── fontdump
├── genkeymap
├── instfiles
├── keygen ------ xrdp RSA key pair generator
├── libpainter
├── librfxcodec
├── libxrdp ----- a static library implements the core RDP protocol
├── m4
├── mc
├── neutrinordp -- an rdp client module for proxying RDP connections using NeutrinoRDP
├── pkgconfig
├── rdp  ---------- an rdp client module for connecting to another rdp server
├── sesman ------- a session manager for xrdp
├── tcutils
├── tests
├── vnc ---------- a simple vnc client module for xrdp
├── vrplayer ----- a QT player redirects encoded video/audio to clients over xrdpvr channel
├── xorg --------- X11rdp, an Xorg backend for xrdp
├── xrdp --------- main server code
├── xrdpapi
├── xrdpvr
└── xup ---------- a module used to connect to an rdp specific X11 server