14.4.  Customizing the User's Session

In this section, we will describe how the session startup in ThinLinc can be customized.

14.4.1.  Session startup - the big picture

The session setup is constructed to be easy to use and configure yet still easy to customize for advanced use cases.

Figure 14.1.  Session Startup Procedure - on VSM Server.

Session Startup Procedure - on VSM Server.

In Figure 14.1, shows a (simplified) description of what happens on the VSM Server when a client connects to login:

  • The VSM Server checks if the user has an existing session.

  • If a session exists, VSM Server contacts the VSM Agent running on the host where the session is running, and asks it to verify that the session is still alive.

  • If the session was alive, VSM Server runs any scripts placed in /opt/thinlinc/etc/sessionreconnect.d. When all such scripts are completed, session information is returned to the client. The client proceeds by contacting the agent on which the session is running.

  • If the existing session was not alive, or if there were no existing session at all, VSM Server finds out which VSM Agent has the least load, and contacts this agent to request a new session.

  • When the agent responds that a new session has been created, VSM Server runs any scripts placed in /opt/thinlinc/etc/sessionstartup.d. When all such scripts are completed, session information is sent back to the client. The client proceeds by contacting the agent on which the session was started.

14.4.1.1.  Scripts run at session startup/reconnect

Scripts in /opt/thinlinc/etc/sessionstartup.d and /opt/thinlinc/etc/sessionreconnect.d are run by the root user, on the VSM Server. Session information will not be sent back to the client until these scripts have completed. This makes it possible to ensure that commands have been run before the client connects to the VSM Agent.

If background execution is desired, place the command to be run in the background and make sure all file descriptors are closed. Here's an example on how to execute a script in the background.

${TLPREFIX}/sbin/tl-limit-printers < /dev/null > /dev/null 2>&1 &

14.4.2.  Session startup on VSM Agent

Figure 14.2.  Session Startup Procedure - on VSM Agent

Session Startup Procedure - on VSM Agent

Figure 14.2 outlines what happens when an VSM Agent is contacted by VSM Server to request a new session. In detail, the following happens:

  1. The VSM agent on the machine where the session will reside executes the script /opt/thinlinc/etc/xsession.

  2. The file /opt/thinlinc/etc/xsession is a shell script that can be customized by advanced users. In its standard version, as delivered with ThinLinc, it will check if there is a file named ~/.thinlinc/xstartup in the user's home directory. If there is such a file, it will be executed. If no such file exists, the file /opt/thinlinc/etc/xstartup.default is executed instead. See Section 14.4.3, “ Profiles and the standard xstartup.default file. ” for a description of the standard behaviour of this file.

This system allows for experienced users to customize how their session startup should work by editing the file ~/.thinlinc/xstartup. On the other hand, at sites where users should not be able to customize their system startup, /opt/thinlinc/etc/xsession can be modified so that it doesn't try to execute user-specific xstartup-files. The standard setup should however suit the needs of the majority of installations.

14.4.3.  Profiles and the standard xstartup.default file.

ThinLinc allows for different "profiles" when starting up a user session. The users will be presented with a menu after logging in, where they can choose for example between a desktop suited for engineering users, a desktop suited for the marketing department or a Windows desktop. The example configuration files that are delivered with ThinLinc have several different alternatives, however only those sessions that are actually available on the system are displayed. This is just an example configuration, meant to be customized for each individual ThinLinc installation.

Figure 14.3.  The ThinLinc profiles and xstartup.default

The ThinLinc profiles and xstartup.default

As described in Section 14.4.1, “ Session startup - the big picture ”, /opt/thinlinc/etc/xstartup.default is executed if there is no ~/.thinlinc/xstartup for the user. This file, in its unmodified version as delivered with ThinLinc, executes three steps, as outlined in Figure 14.3.

  1. The command tl-run-xstartup.d is executed, which causes all files in /opt/thinlinc/etc/xstartup.d/ to be executed. Files that have filenames ending with .sh will be sourced as shell scripts. Other files are executed normally. This way, environment variables that persist down to the session command can be set in *.sh files.

    If a specific execution order is needed for the scripts in the xstartup.d/ directory, let the names of the scripts begin with numbers, where a script with a lower number will be executed before one with a higher number. For example 10setuphomedir will be executed before 20copyfiles.

    By default, the script /opt/thinlinc/etc/xstartup.d/20-tl-select-profile.sh will invoke tl-select-profile, to let the user choose among the possible profiles. See Section 14.4.5, “ Configuring available profiles ” for documentation on how to setup profiles. If only one profile is available, tl-select-profile will select it without asking the user. The environment variable TLPROFILE is set to the name of the selected profile.

    Worth noting is that the environment variable TLPROFILE is available when running the scripts in xstartup.d, for decisions based on what profile will be run.

  2. The command tl-run-profile is run. This runs the commands associated with the selected profile, for example startkde to start a KDE session.

  3. When the commands run by tl-run-profile exits, xstartup.default runs the command tl-run-xlogout.d which runs scripts and commands located in the directory /opt/thinlinc/etc/xlogout.d. The same information that applies to files in xstartup.d (as documented in 1) applies to files in this directory.

Note

Scripts in /opt/thinlinc/etc/xstartup.d and /opt/thinlinc/etc/xlogout.d are run on the agent, with the same rights as the user owning the session.

14.4.4.  Session Startup with a Client Supplied Start Program

If the client has requested that the session should be started with a command supplied by the client, VSM agent will set the environment variable TLCOMMAND to this command. In this case, the profile selection dialog will be disabled and tl-run-profile will execute the command specified by the client, instead of a profile command. To disable client supplied start programs, create the file /opt/thinlinc/etc/xstartup.d/00-no-startprog.sh, containing:

unset TLCOMMAND

14.4.5.  Configuring available profiles

The profiles choosable via the tl-select-profile command are configured via Hiveconf, under the /profiles path. The default configuration includes a number of examples.

The default parameter must be present, and specifies the default profile. The profile chooser will have this entry selected when it starts, and it may also be used automatically for some error conditions.

The order parameter selects which profiles should be available for selection, and the order in which they are displayed. This is a space-separated list.

If the show_intro parameter is true, a configurable introduction text will be displayed and requires user input to proceed with the logon process. The introduction parameter is a text that will be displayed if introduction is shown, this text block does also supports Pango Markup format styling for a fancier text layout.

Each profile is defined under a section named /profiles/<profile key>. It has the following fields:

xdg_session

Connects this ThinLinc profile with a system desktop session configuration. The directories /etc/X11/sessions and /usr/share/xsessions will be searched for a file matching <xdg_session>.desktop. It is recommended that this field is used for all modern desktop environments as it sets up important environment variables.

The fields name, description, icon, cmdline and testcmd will all be implicitly filled in by the system configuration. You can override those values individually by specifying a different value in the ThinLinc configuration.

Multiple values can be specified in this field, separated by spaces. The first matching configuration will be used. If no matching configuration can be found then the profile will not be shown.

Note

If the configuration is listed in /etc/upstart-xsessions then the specified command is ignored and an Upstart user session will be started instead. A manually specified cmdline can still be used to override the command.

name

A short description of the profile, shown in the profile list.

description

A longer description, shown under the screen shot when the profile is selected.

icon

A 22x22 image shown next to the name in the profile list. Paths can be absolute or relative /opt/thinlinc/share/tl-select-profile.

screenshot

A 200x150 image shown when the profile is selected. Paths can be absolute or relative /opt/thinlinc/share/tl-select-profile.

cmdline

The command to execute if this profile has been chosen.

If xdg_session is set then the environment variable XDG_EXEC will be set to the original command line from the system desktop session configuration.

testcmd

A shell expression or command that is executed to determine if this profile should be visible or not. A non-zero return code causes the entry to be hidden. If this field is empty or missing then the entry will always be shown.

If xdg_session is set then the environment variable XDG_TRY_EXEC will be set to the expected binary from the system desktop session configuration. Note that this value differs in behaviour from testcmd. XDG_TRY_EXEC should only name a executable binary in PATH , whilst testcmd will be executed and its return code inspected.

The name and description variables mentioned above also support Pango Markup format styling which provides a simple way to display formatted text (for example, bold or italicized words).

The following example changes the name to be displayed using a blue foreground color and a large font, and the description with a boldface tag to emphasise the machine's operating system type.

                /profiles/windows_desktop
                name=<span foreground="blue" size="x-large">Windows Desktop</span>
                description=This is a standard <b>Windows</b> desktop.
                cmdline=${TLPREFIX}/bin/tl-run-windesk -G windows_desktop
            

14.4.6.  Configuring different Linux Desktops based on the selected profile

Please read Chapter 18, Building Custom Linux Desktops with the ThinLinc Desktop Customizer for documentation on how to configure different desktops with for example different menu and desktop icons depending on what profile were selected.

14.4.7.  Speeding up Session Startup

If a user has a complicated session startup with many time-consuming operations, it can take quite a while before the user's desktop environment (for example KDE or Gnome) begins to start. Prime examples of when this happens is when mounting local drives, or when mounting some shared directories from a Netware server.

One way of speeding up this process is to execute some of the operations in the background. Most often, there is no need to mount the local drives before starting KDE, because it takes longer time to start KDE than it takes to mount the local drives. The two operations can easily run in parallel. The same goes for the example of mounting shared directories.

The easiest way to accomplish this is to add an & sign after commands run by scripts in /opt/thinlinc/etc/xstartup.d.

Make sure that commands that must be run before starting the window environment are run sequentially. For example, configuring desktops via TLDC must be done before starting KDE.

14.4.8.  Configuring the language environment on the server based on the client language

The ThinLinc client reports the language settings on the client side when requesting a session. This can be used to configure the language on the server side. The idea is that in an environment where several languages are in use, a user could automatically get their preferred language based on what their client computer is configured for.

To activate this, a symlink needs to be created:

# ln -s /opt/thinlinc/libexec/tl-set-clientlang.sh /opt/thinlinc/etc/xstartup.d/00-tl-set-clientlang.sh

Also, make sure no other parts of the startup environment are trying to set the LANG variable. For example, on Fedora, the files /etc/profile.d/lang.sh and /etc/profile/lang.csh will override the LANG variable set by tl-set-clientlang.sh.

14.4.9.  Forcing sessions for some users to certain agent hosts

In some situations, it is desirable to force sessions for certain users to be started on a specific agent host. Examples of when this is needed is when testing a new server platform, allowing a group of test users to run their sessions on the new platform, and when configuring desktops with the ThinLinc Desktop Customizer (as described in Chapter 18, Building Custom Linux Desktops with the ThinLinc Desktop Customizer ), where you want to end up on the same server every time to make it easier to copy the resulting files to all other hosts.

ThinLinc provides a mechanism for this. By creating a Linux group and associating it with a specific agent server, sessions for users that are members of the group will always be created on the agent host in question. Individual users may also be specified in this way.

The configuration parameter used for this is /vsmserver/explicit_agentselection. Add pairs of user/group and agent hostnames as a space-separated list to this parameter. The names of groups should be prepended by a + sign, to identify them as groups.

An example:

/vsmserver/explicit_agentselection = +group1:agent1 +group2:agent3 johndoe:agent1

Since only one server can be associated with each group, no load balancing is used. That means that if a user that is a member of group1 requests a session, and agent1 is down, no session will be created.

If a server associated with a group is also listed in /vsmserver/terminalservers, sessions will be created for all users, not only the ones that are members of the group associated with the server. If the server is not listed in /vsmserver/terminalservers, only users in the group associated with the server will have sessions on the server.