sesman.ini(5)

📦
version 0.10.6.1 · 12 versions
, in epel 9, fedora 43, fedora 44

🎀 sesman.ini(5) 🎀

okay bestie 💖 this is the config file for xrdp-sesman(8) — the sesman man page, part 1. Let's get into it. ✨

✨ NAME ✨

sesman.ini — Configuration file for xrdp-sesman(8) 🫶

🌸 DESCRIPTION 🌸

sesman.ini is giving "several sections" energy. Every section starts with the section name in square brackets, then a list of parameter=value lines. The sections we recognize are:

  • [Globals] — Global configuration 🌍
  • [Logging] — Logging subsystem 📝
  • [Sessions] — Session management 🖥️
  • [Security] — Access control 🔒
  • [Chansrv] — Settings for xrdp-chansrv(8) 🛠️
  • [ChansrvLogging] — Logging settings for xrdp-chansrv(8) 📋
  • [SessionVariables] — Environment variables for the session 🌱

Important vibe check: all parameters and values — except for file names and paths — are case insensitive, and they're described in detail below. If any parameter is specified more than once, the last entry will be used. Options specified outside their proper section will be ignored. periodt. 💅

👑 GLOBALS 👑

Following parameters can be used in the [Globals] section.

  • ListenPort=path-to-socket — UNIX domain socket for xrdp-sesman(8) to listen on. 🎧

The default value of this setting is 'sesman.socket'.

An absolute path can be specified by starting this parameter with a /. In this instance, the system administrator is responsible for ensuring the socket can only be created by a suitably privileged process.

If the parameter does not start with a /, a name within /run/xrdp is used.

  • EnableUserWindowManager=[true|false] — If set to 1, true or yes, this option enables user specific startup script. That is, xrdp-sesman will execute the script specified by UserWindowManager if it exists. 🪟
  • UserWindowManager=filename — Path of the startup script relative to the user's home directory. If present and enabled by EnableUserWindowManager, that script is executed instead of DefaultWindowManager. 🏠
  • DefaultWindowManager=filename — Full path or relative path of the default startup script used by xrdp-sesman to start a session. If the path is not a full path, it will be resolved as relative path to /etc/xrdp. If not specified, defaults to /etc/xrdp/startwm.sh. 🚀
  • ReconnectScript=filename — Full path or relative path if the script which executed when users reconnects to the existing session. If the path is not a full path, it will be resolved as relative path to /etc/xrdp. If not specified, defaults to /etc/xrdp/reconnectwm.sh. 🔄

🦋 LOGGING 🦋

Following parameters can be used in the [Logging] and [ChansrvLogging] sections.

  • LogFile=filename — Log file path. It can be either absolute or relative. If not specified, defaults to ./sesman.log. If set to <stdout>, log will go to stdout. Use for debugging only 📝

It is ignored in the [ChansrvLogging] section since the channel server creates one log file per display and instead uses the following log file naming convention xrdp-chansrv.${DISPLAY}.log. For details of the chansrv log file location, see LogFilePath.

  • LogFilePath=string — Directory for storing the chansrv log file. This setting only applies to chansrv. The sesman log file is always created in /var/log. 📂

Created if it doesn't exist. If first character is not a /, this is relative to $HOME, where chansrv is normally started.

The following substitutions are made in this string:

  • %U - Username
  • %u - Numeric UID
  • %% - Percent character

This is most useful if you are using NFS-mounted home directories, and wish to move the chansrv log file to the local disk.

If this parameter isn't specified, the log file is stored in one of the following locations:

  • $CHANSRV_LOG_PATH
  • $XDG_DATA_HOME/xrdp
  • $HOME/.local/share/xrdp
  • LogLevel=level — This option can have one of the following values:
    • CORE or 0 - Log only core messages. Those messages are logged regardless of the selected logging level. 🧊
    • ERROR or 1 - Log only error messages. ❌
    • WARNING, WARN or 2 - Logs warnings and error messages. ⚠️
    • INFO or 3 - Log errors, warnings and informational messages. ℹ️
    • DEBUG or 4 - Log everything. If xrdp-sesman is compiled in debug mode, this options will output many more low-level messages. 🐛
  • EnableSyslog=[true|false] — If set to 1, true or yes, this option enables logging to syslog. 📡
  • SyslogLevel=level — Logging level for syslog. It can have the same values as LogLevel. Defaults to DEBUG. 📊
  • EnableConsole=[true|false] — If set to 1, true or yes, this option enables logging to the console (ie. stdout). 🖥️
  • ConsoleLevel=level — Logging level for the console. It can have the same values as LogLevel. Defaults to DEBUG. 🎚️
  • EnableProcessId=[true|false] — If set to 1, true or yes, this option enables logging the process id in all log messages. Defaults to false. 🆔

💜 SESSIONS 💜

Following parameters can be used in the [Sessions] section.

  • X11DisplayOffset=number — The first X display number available for xrdp-sesman. This prevents xrdp-sesman from interfering with real X11 servers. If not specified, defaults to 10. 🖼️
  • MaxSessions=number — Sets the maximum number of simultaneous sessions. If not set or set to 0, unlimited session are allowed. ♾️
  • MaxDisplayNumber=number — Sets the maximum number which can be assigned to an X11 $DISPLAY. The default is compatible with IANA TCP port allocations. If you are not allowing TCP connections to your X servers you may safely increase this number. 🔢
  • KillDisconnected=[true|false] — If set to 1, true or yes, every session will be killed within DisconnectedTimeLimit seconds after the user disconnects. This setting currently only works with xorgxrdp sessions. 🔪
  • DisconnectedTimeLimit=number — Sets the time limit for KillDisconnected to a value greater than 60. Values less than 60 are to be overridden with 60. This setting currently only works with xorgxrdp sessions. ⏳
  • IdleTimeLimit=number — Sets the time limit (in seconds) before an idle session is disconnected. Idle means no keyboard inputs and no mouse moves/clicks here. If set to 0, idle sessions will never be disconnected by timeout. This works only with xorgxrdp sessions. Moreover, xorgxrdp must be v0.2.9 or later. 😴
  • Policy=[Default|Separate|{UBDI}] — Session allocation policy. Used to decide when to allocate a new session. Set to one of the following values:
    • Default - Currently the same as "UB" for all session types
    • Separate - All sessions are separate. Sessions can never be rejoined, and will need to be cleaned up manually, or automatically by setting other sesman options.

Alternatively combine one-or-more of the following options

  • U - Sessions are separated per user
  • B - Sessions are separated by bits-per-pixel
  • D - Sessions are separated by initial display size
  • I - Sessions are separated by IP address

Note that the U and B criteria cannot be turned off. DisplaySize refers to the initial geometry of a connection, as actual display sizes can change dynamically. 📐

🔐 SECURITY 🔐

Bestie, this section is the bouncer at the club door. The [Security] section takes all these parameters:

  • AllowRootLogin=[true|false] — set it to 1, true or yes and root is allowed to log in on the terminal server. Yes, that root. 👑
  • MaxLoginRetry=number — how many login attempts are allowed on the terminal server. Set it to 0 and it's unlimited attempts (chaos, honestly). If you don't specify it at all, it defaults to 3.
  • TerminalServerUsers=group — only users in this group can log in on the terminal server. If it's unset, or set to a group that's invalid or doesn't even exist, then login is enabled for all users. So like… no group, no filter, everybody in. 💀
  • TerminalServerAdmins=group — heads up: this option is currently ignored! Only members of this group can have session management rights.
  • RestrictOutboundClipboard=[all|none|text|file|image] — set it to all and it restricts the clipboard outbound from the server, so data copied inside the xrdp session can't get pasted into the client. Default value is none. You can also control text/file/image transfer restrictions respectively, and it accepts a comma separated list like text,file,image. Here's the menu:
    • none — no restriction about copying inbound clipboard data.
    • all — restrict to copy inbound clipboard data.
    • text — restrict to copy only inbound text clipboard data.
    • file — restrict to copy only inbound file clipboard data.
    • image — restrict to copy only inbound image clipboard data.

To keep compatibility, these aliases are also available: true is an alias of all, false is an alias of none, and yes is an alias of all.

  • RestrictInboundClipboard=[none|all|text|file|image] — set it to all and it restricts the clipboard inbound from the client, so data copied inside the client can't get pasted into the xrdp session. Default value is none. Same deal as above, you can control text/file/image transfer restrictions respectively, and it accepts a comma separated list such as text,file,image:
    • none — no restriction about copying inbound clipboard data.
    • all — restrict to copy inbound clipboard data.
    • text — restrict to copy only inbound text clipboard data.
    • file — restrict to copy only inbound file clipboard data.
    • image — restrict to copy only inbound image clipboard data.

And for compatibility, the same aliases exist: true is an alias of all, false is an alias of none, yes is an alias of all.

  • AlwaysGroupCheck=[true|false] — set it to 1, true or yes and group membership is required even if the group specified in TerminalServerUsers doesn't exist. Strict mode activated. 🫡
  • AllowAlternateShell=[true|false] — set to 1, true or yes to let users specify alternate shells. Let them cook.
  • PassShellAsEnv=<name-of-environment-variable> — when this is set, alternate shells aren't actioned directly — instead they get passed in to the default window manager inside the specified environment variable. This lets the system manager have more control over exactly what alternate shells are permitted. ✨

Heads up: this will override any setting of the same environment variable in the [SessionVariables] section.

  • XorgNoNewPrivileges=[true|false] — only applicable on Linux. If set to 0, false or no, don't use the kernel's no_new_privs restriction when invoking the Xorg X11 server. The whole point of no_new_privs is to prevent issues caused by a setuid Xorg executable. But if a kernel security module (like AppArmor) is used to confine xrdp, no_new_privs may interfere with transitions between confinement domains.
  • SessionSockdirGroup=group — sets the group owner of the directories holding session sockets. This MUST be the same as runtime_group in xrdp.ini, or xrdp will not be able to connect to any sessions. No cap, this one's important. ⚠️

🖥️ X11 SERVER 🖥️

These parameters can be used in the [Xvnc] and [Xorg] sections.

  • param=string — multiple param lines are supported. The first line specifies the path to the X11 server executable. The following lines specify command line arguments passed to the X11 server.

🌈 CHANSRV 🌈

These parameters can be used in the [Chansrv] section.

  • FuseMountName=string — the directory for drive redirection. It gets created if it doesn't exist. If not specified, it defaults to xrdp_client. If the first character isn't a /, then it's relative to $HOME.

These substitutions are made in this string:

  • %U — Username
  • %u — Numeric UID
  • %d — Numeric display number (ex 10)
  • %D — Display environment variable (ex :10.0)
  • %% — Percent character

A couple things, bestie:

  1. The directory path permissions MUST be configured correctly by the system administrator or the system itself — xrdp-chansrv will not do this for you (although it will create the final directories owned by the user).
  2. The desktop may not automatically display a link for the redirected drive. To fix that, go consult the docs for your chosen desktop.
  • FuseMountNameColonCharReplacement=string — the character to replace colon in redirected drive mount point names. If not specified, no colon will not be replaced. If empty, then colon will be replaced by null character. If it's longer than one character, only the first character is used. Only the last colon is replaced.
  • FuseDirectIO=[false|true] — defaults to false. Set it to true to disable page caching in FUSE when opening files on a redirected drive. Lowkey though, direct I/O can impact the performance of file operations.
  • FileUmask=mode — additional umask to apply to files in the FuseMountName directory. The default value of 077 prevents other users on the system from reading files on your redirected drives. That might not be appropriate for every environment, so you can change this value to let other users access your remote files if you need to.
  • EnableFuseMount=[true|false] — defaults to true. Set it to false to disable xrdp-chansrv's use of the FUSE system feature, even if it's been built with this feature enabled.

Setting this to false will disable these application features:

  • drive redirection
  • copying-and-pasting of files
  • UseNautilus3FlistFormat=[false|true] — defaults to false. Set it to true to make file copy-paste compatible with Nautilus from GNOME 3 versions later than 3.29.92. Do not use this for any other reason, okay? 👀

This setting will be removed in a later version of xrdp, when GNOME 3 is no longer supported.

  • FuseRootReportMaxFree=[false|true] — okay so the existing FUSE implementation reports free space on remote drives in a way that can confuse some file managers if they check for free space at the FUSE mountpoint before copying files. KDE Dolphin is affected by this, and will report 'no space available' when you try to copy to remote drives. 😭

Setting this option makes the FUSE filesystem report a very large amount of free space for the root of the FUSE mountpoint. That lets Dolphin copy files to remote drives — but it introduces a risk that the remote filesystem will run out of space during the copy. Pick your poison.

This setting will be removed in a later version of xrdp, when remote drives receive unique mountpoints.

  • SoundNumSilentFramesAAC=number — sets the number of silent frames sent to the client before the close message is sent, when AAC is selected. If set to 0, no silent frame is sent. If not specified, defaults to 4.
  • SoundNumSilentFramesMP3=number — sets the number of silent frames sent to the client before the close message is sent, when MP3 is selected. If set to 0, no silent frame is sent. If not specified, defaults to 2.
  • SoundMsecDoNotSend=number — sets the duration (msec). Sound data is not sent to the client during that number of millisecond(s) after the close message is sent, when AAC/MP3 is selected. If set to 0, all the data is sent. If not specified, defaults to 1000.

🌸 SESSIONS VARIABLES 🌸

Every single entry in the [SessionVariables] section gets set as environment variables in the user's session. That's the whole vibe. 💅

📁 FILES 📁

/etc/xrdp/sesman.ini

👀 SEE ALSO 👀

xrdp-sesman(8), xrdp-sesrun(8), xrdp(8), xrdp.ini(5)

For more info on xrdp see http://www.xrdp.org/

and that's the whole page, bestie!! 🎀✨ this lil masterpiece came from the xrdp team, version 0.10.6.1, and it's sesman.ini(5) — go forth and configure responsibly, mwah 💖🦋

📦 where this page comes from