xrdp.ini

Section: (5)
Updated: 0.7.0
Index Return to Main Contents

NAME

xrdp.ini - Configuration file for xrdp(8)

DESCRIPTION

This is the man page for xrdp.ini, xrdp(8) configuration file. It is composed by a number of sections, each one composed by a section name, enclosed by square brackets, followed by a list of <parameter>=<value> lines.

xrdp.ini supports the following sections:

[Globals] - sets some global configuration settings for xrdp(8).
[Logging] - logging subsystem parameters
[Channels] - channel subsystem parameters
[Connection] - contain the info on which services xrdp(8) can connect to.

All options and values (except for file names and paths) are case insensitive, and are described in detail below.

GLOBALS

The options to be specified in the [Globals] section are the following:

address=ip address

Specifies xrdp listening address. Default is 0.0.0.0 (all interfaces)

autorun=session_name

Automatically run the connection specified by session_name, which must match a section as described below. By default a drop-down list with all available connections is shown. A connection can also be chosen by the connecting client by setting the LOGIN DOMAIN to a valid session name.

bitmap_cache=[0|1]

If set to 1, true or yes this option enables bitmap caching in xrdp(8).

bitmap_compression=[0|1]

If set to 1, true or yes this option enables bitmap compression in xrdp(8).

bulk_compression=[0|1]

If set to 1, true or yes this option enables compression of bulk data in xrdp(8).

channel_code=[0|1]

If set to 0, false or no this option disables all channels xrdp(8). See section CHANNELS below for more fine grained options.

crypt_level=low|medium|high|fips

RDP connection are controlled by two encryption settings: Encryption Level and Encryption Method. The only supported Encryption Method is 40BIT_ENCRYPTION, 128BIT_ENCRYPTION and 56BIT_ENCRYPTION are currently not supported. This option controls the Encryption Level:

low: All data sent from the client to the server is protected by encryption based on the maximum key strength supported by the client. This is the only level that the traffic sent by the server to client is not encrypted.
medium: All data sent between the client and the server is protected by encryption based on the maximum key strength supported by the client.
high: All data sent between the client and server is protected by encryption based on the server's maximum key strength.
fips: All data sent between the client and server is protected using Federal Information Processing Standard 140-1 validated encryption methods. This level is required for Windows clients (mstsc.exe) if the client's group policy enforces FIPS-compliance mode.

fork=[0|1]

If set to 1, true or yes for each incoming connection xrdp(8) forks a sub-process instead of using threads.

hidelogwindow=[0|1]

If set to 1, true or yes, xrdp will not show a window for log messages.

max_bpp=[8|15|16|24]

Limit the color depth by specifying the maximum number of bits per pixel.

port=port

Specify TCP port to listen on for incoming connections. The default for RDP is 3389.

tcp_keepalive=[yes|no]

Regulate if the listening socket uses socket option SO_KEEPALIVE. If set to 1, true or yes and the network connection disappears without closing messages, the connection will be closed.

tcp_nodelay=[yes|no]

Regulate if the listening socket uses socket option TCP_NODELAY. If set to 1, true or yes, no buffering will be performed in the TCP stack.

black=000000

grey=c0c0c0

dark_grey=808080

blue=0000ff

dark_blue=00007f

white=ffffff

red=ff0000

green=00ff00

background=000000

These options override the colors used internally by xrdp(8) to draw the login and log windows. Colors are defined using a hexadecimal (hex) notation for the combination of Red, Green, and Blue color values (RGB). The lowest value that can be given to one of the light sources is 0 (hex 00). The highest value is 255 (hex FF).

LOGGING

The following parameters can be used in the [logging] section:

LogFile=${SESMAN_LOG_DIR}/sesman.log

This options contains the path to logfile. It can be either absolute or relative, and the default is ${SESMAN_LOG_DIR}/sesman.log

LogLevel=level

This option can have one of the following values:

CORE or 0 - Log only core messages. these messages are _always_ logged, regardless the logging level selected.

ERROR or 1 - Log only error messages

WARNING, WARN or 2 - Logs warnings and error messages

INFO or 3 - Logs errors, warnings and informational messages

DEBUG or 4 - Log everything. If sesman is compiled in debug mode, this options will output many more low-level message, useful for developers

EnableSyslog=[0|1]

If set to 1, true or yes this option enables logging to syslog. Otherwise syslog is disabled.

SyslogLevel=level

This option sets the logging level for syslog. It can have the same values of LogLevel. If SyslogLevel is greater than LogLevel, its value is lowered to that of LogLevel.

CHANNELS

The Remote Desktop Protocol supports several channels, which are used to transfer additional data like sound, clipboard data and others. Channel names not listed here will be blocked by xrdp. Not all channels are supported in all cases, so setting a value to true is a pre-requisite, but does not force it's use.
Channels can also be enabled or disabled on a per connection basis by prefixing each setting with channel. in the channel section.

rdpdr=[0|1]: If set to 1, true or yes using the RDP channel for device re-direction is allowed.
rdpsnd=[0|1]: If set to 1, true or yes using the RDP channel for sound is allowed.
drdynvc=[0|1]: If set to 1, true or yes using the RDP channel to initiate additional dynamic virtual channels is allowed.
cliprdr=[0|1]: If set to 1, true or yes using the RDP channel for clipboard re-direction is allowed.
rail=[0|1]: If set to 1, true or yes using the RDP channel for remote applications integrated locally (RAIL) is allowed.
xrdpvr=[0|1]: If set to 1, true or yes using the RDP channel for XRDP Video streaming is allowed.

CONNECTIONS

A connection section is made of a section name, enclosed in square brackets, and the following entries:

name=<session name>: The name displayed in xrdp(8) login window's combo box.
lib=../vnc/libvnc.so: Sets the library to be used with this connection.
username=<username>|ask: Specifies the username used for authenticating in the connection. If set to ask, user name should be provided in the login window.
password=<password>|ask: Specifies the password used for authenticating in the connection. If set to ask, password should be provided in the login window.
ip=127.0.0.1: Specifies the ip address of the host to connect to.
port=<number>|-1: Specifies the port number to connect to. If set to -1, the default port for the specified library is used.

EXAMPLES

This is an example xrdp.ini:

[Globals]
bitmap_cache=yes
bitmap_compression=yes

[vnc1]
name=sesman
lib=../vnc/libvnc.so
username=ask
password=ask
ip=127.0.0.1
port=-1

FILES

${XRDP_CFG_DIR}/xrdp.ini

This document was created by