Go to file
Koichiro Iwao d50c2fd4e4 tconfig: Makefile changes 2024-08-23 10:40:58 +09:00
.github Merge pull request #3058 from seflerZ/unicode_contr 2024-05-20 12:27:52 +01:00
common Allow keycode set to be specified for the X server 2024-08-05 10:58:09 +01:00
docs Allow keycode set to be specified for the X server 2024-08-05 10:58:09 +01:00
fontutils enabled and fixed `-Wmissing-prototypes` compiler warnings 2024-04-23 18:38:20 +02:00
genkeymap Move pause key processing from xorgxrdp 2024-08-05 10:44:10 +01:00
instfiles Regenerate keymaps 2024-08-05 10:44:10 +01:00
keygen Split g_file_open() into _ro() and _rw() variants 2023-05-15 17:38:31 -04:00
libipm Remove sesmanruntimedir 2023-10-23 18:14:46 +01:00
libpainter@379b8fbf40 Remove unnecessary autoconf AC_C_CONST macro 2024-08-15 11:48:23 +01:00
librfxcodec@26e40b29d0 Remove unnecessary autoconf AC_C_CONST macro 2024-08-15 11:48:23 +01:00
libxrdp Move and rename xrdp_load_keyboard_layout() 2024-08-05 10:44:10 +01:00
m4 Allow some utmpx fields to be optional 2024-02-21 09:24:48 +00:00
mc Move and rename xrdp_load_keyboard_layout() 2024-08-05 10:44:10 +01:00
neutrinordp Move and rename xrdp_load_keyboard_layout() 2024-08-05 10:44:10 +01:00
pkgconfig Fix include path in xrdp-uninstalled.pc.in 2016-11-18 23:42:26 +00:00
scripts Add additional dependency for configure for cppcheck CI 2024-08-15 11:48:23 +01:00
sesman clipboard: Allow a file read to return 0 for EOF 2024-08-02 12:41:20 +01:00
tests tconfig: Makefile changes 2024-08-23 10:40:58 +09:00
third_party third_party: Update README.md 2023-04-03 17:35:30 +09:00
tools link error dlclose, use DLOPEN_LIBS 2024-07-13 12:13:52 -07:00
ulalaca@f683d173a3 Update submodule, obrain cppcheck fixes 2022-05-20 16:09:51 +09:00
vnc Move and rename xrdp_load_keyboard_layout() 2024-08-05 10:44:10 +01:00
vrplayer Bump cppcheck to v2.11 2023-06-23 15:12:51 +01:00
waitforx waitforx: fix build 2023-09-04 17:33:27 +09:00
xrdp tconfig: Makefile changes 2024-08-23 10:40:58 +09:00
xrdpapi Parameterise the sockdir with the UID of the user 2023-10-23 18:14:46 +01:00
xrdpvr Fixing formatting with astyle 2021-05-08 16:58:11 +00:00
xup Allow keycode set to be specified for the X server 2024-08-05 10:58:09 +01:00
.cirrus.yml Bump FreeBSD CI version to 13.3 2024-06-01 10:20:03 +01:00
.gitignore chkpriv: respect $sysconfdir for config files directory 2024-07-12 11:11:06 +09:00
.gitmodules Enabling RFX_PRO key frame handling. 2024-01-31 19:08:29 -05: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 third_party: Update Makefile.am to fix `make distcheck` 2023-04-03 17:35:00 +09:00
NEWS.md Update NEWS for v0.9.19 2022-03-16 10:16:39 +09:00
README.md Update README.md 2024-05-01 09:26:58 +01:00
SECURITY.md Update SECURITY.md 2023-05-28 23:45:56 +09:00
astyle_config.as astyle: replace depreacted astyle options 2024-02-08 15:34:17 +09:00
bootstrap bootstrap: checkout ulalaca submodule if missing 2022-05-19 12:47:39 +09:00
coding_style.md Merge prog_std.txt into coding_style.md 2016-10-17 08:38:22 -07:00
configure.ac Remove unnecessary autoconf AC_C_CONST macro 2024-08-15 11:48:23 +01:00

README.md

Build Status Gitter Apache-License

Latest Version

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

Fedora, RHEL and derivatives

If you're not running Fedora, make sure to enable EPEL packages first.

dnf install epel-release

(All systems) Install xrdp with:-

dnf install xrdp

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 pkg-config.

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
├── fontutils ··· font handling utilities
├── 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
|├── libsesman ·· Code common to sesman and its related executables
|└── 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 ········· xorgxrdp client module