Skip to main content

FreeRDP

Configuration

General Settings

Setting
Value
Description
Autostart

Yes

No

Specifies whether the application should start automatically when the thin client is launched.

Hide icon

Yes

Hide on desktop

Disable

Yes:

Hide the application icon

Hide on desktop:

Remove the icon from the desktop; it'll appear only in the menu and Run dialog.

Show the application icon.

Show the application icon

Custom icon File name

Here, assign a custom icon to the application.

Save the icon on the openthinclient server in the folder: <Manager-Home>/nfs/root/custom/icons

The file format must be .png or .ico . Use a size of 32 × 32 or 64 × 64.

After closing the application

Leave settings unchanged

Restart the application.

Log out

Restart the thin client

Shut down the thin client

Shut down ThinClient with a cancel dialog

Perform action after ending the RDP session.

Startup delay (in seconds) Seconds

Delays the start of the application

Application settings

Setting
Value
Explanation

Server address

Text

IP address of the terminal server or its network name

Environment variables are expanded in this field, e.g. $HOSTNAME or ${CUSTOM1}.

See also: Using variables in management

Alternative port (optional) Numeric

If a different port is set on the server side, enter it here.

Default value: 3389

Load balancing info (TSV URL) Text

Specify this setting when using a session broker.

This parameter tells the broker which collection to use.

Example: tsv://MS Terminal Services Plugin.1.collection.

Suppress error dialogs

No

Yes

For certain exit codes (see next line)

No:

If FreeRDP terminates with an error, display an error analysis dialog.

Yes:

If FreeRDP exits with an error, suppress the dialog.

For certain exit codes:

This option is useful, e.g., for session roaming.

When a session is taken over by another workstation, FreeRDP exits with exit code 5. Instead of displaying an error, display the login dialog for the next user directly in this case.

Suppress error dialogs for these exit codes

List

A comma-separated list of numbers

Example: 5, 131, 141, 134

Login
Setting
Value
Explanation
Authentication

Use the login credentials below

Show login dialog

Show dialog for password only

Show login dialog including server address

Enable single sign-on

Use the login credentials below:

The session starts with the pre-entered login credentials

Show login dialog:

The user is prompted for their login credentials.

If the domain's already specified in the management settings, omit it; otherwise, enter it alongside the username (user[at]domain or domain\user).

Show dialog for password only:

Enter only the password; pre-fill the remaining login credentials.

Show login dialog including server address:

In addition to login credentials, specify the IP address or hostname of the terminal server.

Enable single sign-on:

See User Login with Autologin or SSO

Domain Text

Enter the user's login credentials here if Show Login Dialog / Use the login credentials below is selected. These credentials are passed directly to the application when FreeRDP starts.

If login credentials aren't entered, the thin client displays a login dialog.

User
Password
Generated Password

Dynamically generated password. (Takes precedence over the password above.)

Environment variables are expanded in this field, e.g. $HOSTNAME or ${CUSTOM1}.

See also: Using variables in management

Custom title of the login window Text

Any text for the title of the login dialog.

Window
Setting
Value
Explanation
Multi-monitor (takes precedence, overrides everything)

Yes

Disable to show FreeRDP on a single monitor.

If enabled, FreeRDP displays in full screen across all connected monitors.

Window size

Full screen on primary display, keep taskbar

Full screen on primary display, hide taskbar

Full screen on secondary display

Specify size from the following fields

Let the system manage size

Full screen on primary display, keep taskbar:

Maximize FreeRDP on the primary display; leave the Linux taskbar visible.

Full-screen primary display, hide taskbar:

Maximize FreeRDP on the primary display and hide the Linux taskbar.

Full screen on secondary display:

Maximize FreeRDP on the secondary display.

The primary display continues to show the Linux desktop.

Size specifications from the following fields:

Specify window width and height in the next two fields.

Let the window manager handle placement.

Leave window placement to the window manager

Window width Numeric

Specify in px. This option is useful when the value "Size specified in the following fields" is selected in the Window Size field.

Window height Numeric
Color depth

Automatic

8-bit

15-bit

16-bit

32-bit

If this field is set to Automatic, the color depth of the Linux desktop is used. This setting suffices in most cases.

Scaling factor

100%

140%

180%

Scales the entire remote desktop display.
Floatable

Off

On

Auto-hide

Off:

Hide the FreeRDP Floatbar

On:

Enable the FreeRDP Floatbar

Auto-hide:

Enables the FreeRDP Floatbar. However, it only appears when the mouse is at the top of the screen.

Experience shows that displaying the Floatbar can cause FreeRDP to freeze.
If the issue occurs, disable automatic hiding. If the program still freezes, disable the Floatbar.

Window Title and Border

Show

Hide

Enable this setting when using FreeRDP in windowed mode.

Connection parameters
Setting
Value
Explanation

Additional parameters

Text

Enter additional manual parameters here that require manual entry.

For an overview of all possible parameters, open a terminal on a thin client and run this command: 

/opt/freerdp/bin/xfreerdp

Examples

Drive Redirection:

/drive:home,/home/tcos

Host names as users with static passwords:

/u:$HOSTNAME /p:p4ssw0rd

See also: Using variables in management

Network connection type

Automatic detection

LAN

LAN:

Limit the connection bandwidth to 10 Mbit/s

Automatic detection:

Let the server attempt to detect the connection type.

Ignore GFX/RFX settings. Enable RFX and AVC444.

Expert settings, e.g., background image and menu animations, are determined by the server.

Security protocol

Auto (negotiate security protocol)

TLS

RDP

TLS (use Windows login screen)

RDP (Use Windows login screen)

Auto (negotiate security protocol):

This setting negotiates the most secure protocol with the terminal server.

TLS:

Allow connections only via the TLS protocol.

If the server supports this, the connection succeeds.

RDP:

Allow connections only via the RDP protocol.

Ensure the server supports this protocol; otherwise, the connection fails.

TLS (use Windows login screen):

Allow connections only via the TLS protocol. Ensure the server supports this protocol to establish a connection.

It uses the Windows login screen to prompt for credentials. 

RDP (use Windows login screen):

Allow connections only via the RDP protocol.

Ensure the server supports this protocol to establish the connection.

Use the Windows login screen to prompt for credentials.

Check server certificates

No, required for DNS round robin

Yes

No:

The server certificate isn't verified.

Yes:

Verify that the server certificate was issued by an official CA.

GDI mode

Use FreeRDP default setting

Software

Hardware

Change this setting if a black block appears around the mouse cursor or if artifacts appear in spreadsheets.

Forward sound output

Yes

No

Play sound from the Windows session on the thin client.

Forward sound input

Lossless

Good quality

Phone quality

Not applicable

Pass audio from microphones to the Windows session (e.g., for digital dictation). Higher audio quality consumes more bandwidth.

Forward camera

Yes

Disable

Forward compressed video from a camera connected to the thin client to the Windows session.

Use Windows Server 2019 or later.

Enable Grundig plugin

Auto

Yes

No

Install drivers for dictation devices, foot switches, etc.

These forward the buttons and keys of the devices to the Windows session. For dictation devices, enable sound forwarding as well.

Automatic detection uses the devices’ USB IDs when they're connected at launch.

Enable Olympus Plugin

Auto

Yes

No

Enable Philips plugin

Auto

Yes

Confirm

Enable StepOver TCP Connection

Auto

Yes

No

Enables the client component for forwarding a StepOver pad connected to the ThinClient.

Set up the StepOver server component.

StepOver TCP Connection Port

Numeric

Port on the ThinClient through which the TCP connection is established.

Ensure it matches the config.ini on the server.

Transfer to clipboard

Yes

Disable to prevent sharing.

Share the clipboard between the Windows session and openthinclient OS.

Disk sharing

To

Off

Enable this switch to bring volumes into the Windows session (see Volume Forwarding).

Smart Card Forwarding

Auto

Yes

Disable


Enable WebAuthn

Yes

Select No.

Enable the WebAuthn channel for FIDO2 authentication in the Windows session.

Requires Windows Server 2022 or later

USB Device Forwarding — for specific devices only
List of USB IDs

Forward USB devices directly to the Windows session. Specify a comma-separated list of USB IDs. 

Example: 2133:0001

To read the USB IDs available on the thin client, use System Information (in the menu under System) or the command lsusb in a shell.

Forwarding a device via USB dedicates the connection to that device. For example, to forward a smart card reader, enable smart card forwarding and omit its USB ID from this field.

Enable Encryption

Enable compression

Enable this option to reduce network load. However, this'll increase CPU usage on the thin client.

Enable asynchronous image updates

Enable this option for WAN connections.

When enabled, the system registers mouse clicks before the image finishes loading.

Keyboard Layout

Select the required keyboard layout.

Forward multitouch input

Yes

No

Forwarding from multi-touch-enabled monitors.

Connection timeout in ms


Specify the time in ms after which the system considers a connection lost when communication's disrupted or delayed.

Automatic reconnection

Yes

Yes

Whether to attempt to re-establish the connection or terminate it when the connection is considered lost.

Kerberos support

Enabled

Disabled


COM Port Forwarding
Setting
Value
Explanation
COM1

Enable COM1 when required.

1st serial port, /dev/ttyS0

2nd serial port, /dev/ttyS1

3rd serial port, /dev/ttyS2

1st USB-to-serial adapter, /dev/ttyUSB0

2nd USB-to-serial adapter, /dev/ttyUSB1

3. USB-to-serial adapter, /dev/ttyUSB2

1. USB-to-serial ACM, /dev/ttyACM0

2. USB-to-serial ACM, /dev/ttyACM1

3. USB-to-serial ACM, /dev/ttyACM2


Enables the forwarding of up to three serial connections.

COM2
COM3
RFX/GFX Settings
Setting
Value
Explanation
Use RFX

Yes

No

Enables RemoteFX on Windows versions prior to Windows Server 2008 R2.

GFX Thinclient Mode

On

Off


GFX Settings

/gfx:AVC444

/gfx:AVC420

/gfx:RFX

/gfx

Off

The system honors this setting when Automatic Detection isn't selected as the network connection type (see Optimizing Performance).

RD Gateway
Setting
Value
Explanation
Connection via RD Gateway

Yes

No

Select the checkbox to connect via an RD Gateway.

Gateway address

Hostname or IP address of the gateway server
Authentication

Use Terminal Server credentials

Use the credentials from the next three fields

Request gateway credentials

Use Terminal Server credentials:

Use the same login credentials as for the Terminal Server.

Use the credentials from the next three fields

Request gateway credentials:

Manually enter the login credentials in the dialog box.

Domain
Text

Fill in these fields when the "Use login credentials from the next three fields" setting is selected above.

User
Password

Expert Settings

Desktop Settings
Setting
Value
Description
Show background image

Yes

No


Show desktop themes

Yes

Disable


Enable font smoothing

Yes

Disable


Enable desktop composition (Aero)

Yes

Disable


Show full window when dragging

Yes

Disable


Enable menu animations

Yes

Disable