FreeRDP script template

A couple of months ago I ran into issues with the krdc app and got so frustrated I created a script template to handle my connections thus limiting my dependency to freerdp.

The template handles if session is wayland or x11

#!/usr/bin/env bash
#
# Script template to open FreeRDP connection
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
# root.nix.dk
# - 2022-11-23 : moved width and height to variables section
# - 2023-03-23 : fixed missing $ at variable in xfreerdp call
#              : added comments to customize section

#######################################################
### begin customize
# Documentation
# https://github.com/FreeRDP/FreeRDP/wiki/CommandLineInterface
#
# to list available keyboards run 'xfreerdp /kbd-list'
# examples
# french => 0x0000040C
# german => 0x00000407
# us     => 0x00000409
# uk     => 0x00000809
# danish => 0x00000406

# set keyboard 
KEYBOARD="0x00000406"

# set screen size
WIDTH=1920
HEIGHT=1080

# define host and credentials to be used
REMOTE=""             # hostname or ip-address
USERNAME=""           # login
PASSWORD=""           # passwd

# connnection type - you may need to adjust if you have a slow or poor connection
NETWORK="lan"         # connection type
PORT="3389"           # rdp default

# share - if you don't need then comment the line reading
#             /drive:${SHARENAME},${SHAREPATH} \
SHAREPATH="/home/$USER"      # shared folder
SHARENAME="media"            # share name on remote system

### end customize
#######################################################

if [[ ${XDG_SESSION_TYPE} = "wayland" ]]; then
        /usr/bin/wlfreerdp \
        /bpp:24 \
        /audio-mode:2 \
        /sound:sys:alsa \
        /rfx \
        /cert-ignore \
        +clipboard \
        -decorations \
        /parent-window:31 \ 
        /w:${WIDTH} \
        /h:${HEIGHT} \
        /kbd:${KEYBOARD} \
        /network:${NETWORK} \
        /u:${USERNAME} \
        /port:${PORT} \
        /v:${REMOTE} \
        /p:${PASSWORD} \
        /drive:${SHARENAME},${SHAREPATH} \
        &
else
        /usr/bin/xfreerdp \
        /bpp:24 \
        /audio-mode:2 \
        /sound:sys:alsa \
        /rfx \
        /cert-ignore \
        +clipboard \
        /w:${WIDTH} \
        /h:${HEIGHT} \
        /kbd:${KEYBOARD} \
        /network:${NETWORK} \
        /u:${USERNAME} /port:${PORT} \
        /v:${REMOTE} \
        /p:${PASSWORD} \
        /drive:${SHARENAME},${SHAREPATH} \
        &
fi

Usage

Ensure you have the folder ~/.local/bin

mkdir -p ~/.local/bin

Create a new file in the folder and paste the content from template into the new file.

Save the file using a meaningfull name e.g. the nickname for the device you are connecting to.

Then adjust the properties at the top of the script - just below the header - to match your connection and save the file.

Make the file executable

chmod +x ~/.local/bin/nickname

Then you can execute from commandline

nickname

If you want a shortcut - with an icon to click - create a desktop file ~/.local/share/applications/nickname.desktop with content

[Desktop Entry]
Name=nickname RDP
Icon=network-server
Comment=Connect to nickname RDP
Exec="~/.local/bin/nickname"
Version=1.0
Type=Application
Terminal=false
StartupNotify=true

Crosspost to