Go to file
matt335672 f826e55eda Bump librfxcodec version to v0.1.6 2022-01-07 11:57:11 +00:00
.github/workflows Bump CI version of cppcheck to 2.6 2021-10-04 11:52:22 +01:00
common Create shared GUID module to simplify session guid handling 2021-11-25 13:29:55 +00:00
docs Add Nautilus 3 compatibility 2021-09-16 10:02:02 +01:00
fontdump Don't ignore files known to git 2016-02-12 23:52:46 -08:00
genkeymap Replace `which` here, too 2021-12-01 22:37:29 +09:00
instfiles Detect and setup Programmer Dvorak keyboard layout 2020-08-26 17:55:25 +02:00
keygen Moved a lot of string funcs to string_calls module 2020-12-22 11:57:24 +00:00
libpainter@b44f2fac46 Updates to libpainter and librfxcodec bootstrap scripts 2021-12-02 10:29:42 +00:00
librfxcodec@d8f126abc4 Bump librfxcodec version to v0.1.6 2022-01-07 11:57:11 +00:00
libxrdp Merge pull request #1932 from Nexarian/add_monitor_processing_unit_tests 2022-01-05 10:23:55 +00:00
m4 Update m4/ax_type_socklen_t.m4, it works with -Wall now 2017-02-02 21:33:05 -08:00
mc Remove unnecessary error from neutrinordp log 2021-10-12 14:37:28 +01:00
neutrinordp Neutrinordp: Add more user info on connect failure 2021-11-25 15:45:17 +00:00
pkgconfig Fix include path in xrdp-uninstalled.pc.in 2016-11-18 23:42:26 +00:00
scripts 32-bit CI build process : Remove some 64-bit packages 2021-09-03 12:12:29 +01:00
sesman Merge pull request #2011 from matt335672/unify_scpv0_code 2022-01-05 11:06:42 +00:00
tests Merge pull request #1932 from Nexarian/add_monitor_processing_unit_tests 2022-01-05 10:23:55 +00:00
tools Split development option into separate things 2021-05-28 10:57:12 +01:00
vnc Merge pull request #2011 from matt335672/unify_scpv0_code 2022-01-05 11:06:42 +00:00
vrplayer Fixing formatting with astyle 2021-05-08 16:58:11 +00:00
xrdp Merge pull request #2011 from matt335672/unify_scpv0_code 2022-01-05 11:06:42 +00:00
xrdpapi Move get_display_num_from_display to string_calls module 2021-04-13 12:16:00 +01:00
xrdpvr Fixing formatting with astyle 2021-05-08 16:58:11 +00:00
xup Log error on failure to attach to shared memory 2021-11-30 10:55:03 +00:00
.cirrus.yml Add imlib2 to CI 2021-09-01 10:09:30 +01:00
.gitignore ignore substituted systemd service files 2021-10-01 18:03:30 +09:00
.gitmodules Use special name "." for the branches in .gitmodules 2017-03-01 20:38:33 -08:00
COPYING o moved from GNU General Public License to Apache License, Version 2.0 2012-09-19 20:51:34 -07:00
Makefile.am Add dependency on libscp to xrdp 2021-11-25 14:17:39 +00:00
NEWS.md Update NEWS for v0.9.17 2021-08-31 11:21:55 +09:00
README.md Bump version to 0.9.1 2021-08-31 11:21:55 +09:00
SECURITY.md Improve documentation 2020-09-09 09:13:37 +02:00
astyle_config.as Add checking the code formatting with astyle during CI builds 2021-05-08 16:53:32 +00:00
bootstrap Replace `which` with `command -v` 2021-12-01 17:06:25 +09:00
coding_style.md Merge prog_std.txt into coding_style.md 2016-10-17 08:38:22 -07:00
configure.ac Initial cut at a unit test for xrdp_sec_process_mcs_data_monitors 2021-12-08 01:41:07 -05:00

README.md

Build Status Gitter Apache-License

Current Version: 0.9.17

xrdp - an open source RDP server

Overview

xrdp provides a graphical login to remote machines using Microsoft Remote Desktop Protocol (RDP). xrdp accepts connections from a variety of RDP clients:

  • FreeRDP
  • rdesktop
  • KRDC
  • NeutrinoRDP
  • Windows MSTSC (Microsoft Terminal Services Client, aka mstsc.exe)
  • Microsoft Remote Desktop (found on Microsoft Store, which is distinct from MSTSC)

Many of these work on some or all of Windows, Mac OS, iOS, and/or Android.

RDP transport is encrypted using TLS by default.

demo

Features

Remote Desktop Access

  • Connect to a Linux desktop using RDP from anywhere (requires xorgxrdp Xorg module)
  • Reconnect to an existing session
  • Session resizing (both on-connect and on-the-fly)
  • RDP/VNC proxy (connect to another RDP/VNC server via xrdp)

Access to Remote Resources

Supported Platforms

xrdp primarily targets GNU/Linux operating system. x86 (including x86-64) and ARM processors are most mature architecture to run xrdp on. See also Platform Support Tier.

Some components such as xorgxrdp and RemoteFX codec have special optimization for x86 using SIMD instructions. So running xrdp on x86 processors will get fully accelerated experience.

Quick Start

Most Linux distributions should distribute the latest release of xrdp in their repository. You would need xrdp and xorgxrdp packages for the best experience. It is recommended that xrdp depends on xorgxrdp, so it should be sufficient to install xrdp. If xorgxrdp is not provided, use Xvnc server.

xrdp listens on 3389/tcp. Make sure your firewall accepts connection to 3389/tcp from where you want to access.

Ubuntu / Debian

apt install xrdp

RedHat / CentOS / Fedora

On RedHat and CentOS, make sure to enable EPEL packages first.

yum install epel-release

Install xrdp package.

yum install xrdp

yum is being replaced with dnf, so you may need to use dnf instead of yum in the above commands.

Compiling

See also https://github.com/neutrinolabs/xrdp/wiki#building-from-sources

Prerequisites

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 and build it

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

If compiling from a checked out repository, please make sure you've got the submodules cloned too (use git clone --recursive https://github.com/neutrinolabs/xrdp)

Then run following commands to compile and install xrdp:

./bootstrap
./configure
make
sudo make install

If you want to use audio redirection, you need to build and install additional pulseaudio modules. The build instructions can be found at wiki.

Directory Structure

xrdp
├── common ······ common code
├── docs ········ documentation
├── fontdump ···· font dump for Windows
├── genkeymap ··· keymap generator
├── instfiles ··· installable data file
├── keygen ······ xrdp RSA key pair generator
├── libpainter ·· painter library
├── librfxcodec · RFX codec library
├── libxrdp ····· core RDP protocol implementation
├── m4 ·········· Autoconf macros
├── mc ·········· media center module
├── neutrinordp · RDP client module for proxying RDP connections using NeutrinoRDP
├── pkgconfig ··· pkg-config configuration
├── scripts ····· build scripts
├┬─ sesman ······ session manager for xrdp
|├── chansrv ···· channel server for xrdp
|├── libscp ····· authorization library
|└── tools ······ session management tools for sys admins
├── tests ······· tests for the code
├┬─ tools ······· tools
|└┬─ devel ······ development tools
| ├── gtcp_proxy  GTK app that forwards TCP connections to a remote host
| └── tcp_proxy · CLI app that forwards TCP connections to a remote host
├── vnc ········· VNC client module for xrdp
├── vrplayer ···· QT player redirecting video/audio to clients over xrdpvr channel
├── xrdp ········ main server code
├── xrdpapi ····· virtual channel API
├── xrdpvr ······ API for playing media over RDP
└── xup ········· X11rdp and xorgxrdp client module