Newer
Older
The support of VNC remote graphical desktops on JURECA enables us to presents the JSC to the HPC-Users in a fresh and modern way. But a graphical desktop is of course not limited to eye-candy design alone.
A graphical desktop can increase productivity of each HPC-user as the workflows become more complex and change more often. It also helps new users to shorten the time to debug, run and post-process their codes (e.g. debugging, performance and visualization tools are more easy to start use). But different user groups and various research topics make sense for multiple desktop configurations.
The solution are XDG Desktop Profiles (https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
A XDG desktop profile is a set of desktop configurations, most notable:
- background image
- desktop icons
- applications menu ("Start Menu")
- desktop widgets (information embedded into the background image)
- autostart
- application configurations
#### ${XDG_CONFIG_*}
All of these settings are stored in files located in *${XDG_CONFIG_HOME}* for each user. Global settings are stored in *${XDG_CONFIG_DIRS}*. The default of *${XDG_CONFIG_HOME}* is *${HOME}/.config/* and the default of global settings is */etc/xdg/*.
New configurations and modifications are always stored in *${XDG_CONFIG_DIRS}*. These configurations overwrite all settings located in *${XDG_CONFIG_DIRS}*.
#### ${XDG_DATA_*}
All XDG data, which is independent of a certain configuration, is stored in *${XDG_DATA_HOME}* for each user or in *${XDG_DATA_DIRS}* system-wide. This can be background images .desktop-files for desktop icons, menus or autostart files. The default for *${XDG_DATA_DIRS} is */usr/local/share:/usr/share*.
Each XDG desktop profile is stored in its own XDG_CONFIG-directory (*/etc/xdg/xdg_profiles/\<profile\>/*). It can inherit configurations from other desktop profiles (like the default desktop profile). Hence, a new XDG desktop profile might consist only of some additional desktop icons or a different background image added on top of the default profile.
The XDG Desktop Profile is chosen with *${XDG_PROFILE}* just before the VNC server is started.
export XDG_PROFILE=vis
vncserver -fg -geometry 1920x1080
The VNC server calls *${HOME}/.vnc/xstartup* (use *dot.vnc/xstartup* from this repository),
which must call **xdg_profile.sh** currently located in *usr/local/bin/* of this repository.
Depending on *${XDG_PROFILE} the script xdg_profile.sh sets the *${XDG_CONFIG_\*}* and *${XDG_DATA_\*}* variables. .
Example: starting a VNC-server-job with an the visualization XDG desktop profile on a visualization the visualization partition of JURECA:
salloc -N 1 -p vis --gres=mem512,gpu:1 --start-xserver --time=1:00:00
srun -n 1 --cpu_bind=none --gres=gpu:1 bash -c 'export XDG_PROFILE=vis; vncserver -fg -geometry 1920x1080'
XDG Base Directory Specification are supported by most of the popular desktop systems found on Linux (GNOME, KDE, XFCE etc.). On JURECA we use XFCE4 as a light weighted desktop system.
XFCE4 specific configurations are stored in *${XDF_CONFIG_\*}/xfce4/* and
XFCE4 specific data is stored in *${XDF_DATA_\*}/xfce4/*. Examples are:
- desktop settings
- desktop settings file (including background image)
- ${XDF_CONFIG_\*}/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml
- desktop menu description file:
- ${XDG_CONFIG_*}/xfce4/desktop/menu.xml
- default location of all desktop backgrounds:
- ${XDG_CONFIG_\*}/xfce4/xfconf/xfce-perchannel-xml/xfce4-panel.xml
The background image is set in *${XDF_CONFIG_*}/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml*. The first XDF_CONFIG-directory, which includes this file sets the background image.
The path must be an absolute path. It is not processed by bash and must not include any system variables.
Background images of desktop profiles should be located in *${XDF_DATA_\*}/xfce4/backdrops/* to be found by XFCE4 on default.
XFCE4 can loop through background images. Therefore multiple images must be listed in */etc/xdg/xdg_profiles/\<profile\>/xfce4/desktop/backdrop.list*. backdrop-cycle-enable and backdrop-cycle-timer must be set in */etc/xdg/xdg_profiles/\<profile\>/xfce4/xfconf/xfce-perchannel.xml/xfce4-desktop.xml*.
in XFCE4 icons are positioned with row/column coordinates. The position is stored in *${XDF_CONFIG_\*}/xfce4/desktop/icons.screen?-<resolution-identifier>.rc*. If the size of each cell is changed, the coordinates remain the same but the grid gets enlarged.
XFCE4 will rearrange all icons on the desktop, if the screen resolution is smaller than the required resolution needed to fit the max. row or max. column. Hence, icons be placed in the top left area of the desktop and must fit on a min. resolution of 1024x768 in each desktop profile.
#### Application Menu
##### Customize Menu Structure
The applications menu is generated from the file *etc/xdg/xdg_profiles/default/menus/xfce-applications.menu*.
It merges additional menus from *${XDG_CONFIG_\*}/menus/application-merged/*.
To add a new sub-menu create a file like *etc/xdg/xdg_profiles/vis/menus/vis-application.menu* in ${XDG_CONFIG_HOME}/menus/.
Any .directory-files must be placed in the directory ${XDG_DATA_DIRS}/desktop-directories, which is *usr/local/share/* (and not in *${HOME}/.local/share*).
Additional information can be found here *https://wiki.xfce.org/howto/customize-menu*.
Sub-menus of default profiles (like 'Visualization', 'Performance Analysis', etc.) can be placed in the default profile to be visible in any profile.
##### Customize Menu Entries
Any menu entry belongs to a corresponding .desktop-file in *${XDG_DATA_DIRS}/applications*.
The category name (defined by xfce-applications.menu and its .directory-files) describes in which sub-menu it will be placed.
Example: vis.directory defines the category "Visualization". Adding "Category=Visualization" to a .desktop-file will place it in the sub-menu "Visualization".
##### Change Application Menu Icon
The application menu icon is set in *${XDF_CONFIG_\*}/xfce4/xfconf/xfce-perchannel-xml/xfce4-panel.xml*.
By default it is set in the default profile in *etc/xdg/xdg_profiles/default/xfce4/xfconf/xfce-perchannel-xml/xfce4-panel.xml* to the FZJ logo located in *usr/local/share/pixmaps/fzj-logo_64x64.png*.
An info terminal can be part of a profile to present text information to the user.
It is located in */etc/xdg/xdg_profiles/\<profile\>/infoterm-\<profile\>*.
It is started via the desktop-file */etc/xdg/xdg_profiles/\<profile\>/autostart/infoterm-\<profile\>.desktop* on every start of XFCE4 with the desktop profile \<profile\>.
In all directories of XDG_CONFIG_DIRS the script infoterm-\<profile\>.sh is searched and (if found) executed:
```shell
IFS=:
for p in ${XDG_CONFIG_DIRS}; do
if [ -e ${p}/infoterm-\<profile\>/infoterm-\<profile\>.sh ]; then
${p}/infoterm-\<profile\>/infoterm-\<profile\>.sh
infoterm-\<profile\>.sh must be unique and only part of a single desktop profiles - do not use the same name in multiple desktop profiles.
The configuration of the info terminal is done partly in *infoterm-\<profile\>.sh* and partly by setting the application specific XDG_CONFIG_HOME to */etc/xdg/xdg_profiles/\<profile\>/infoterm-\<profile\>*. This is for settings, which cannot be done via command line parameters like transparency and are only stored in configuration files.
## How to generate a new profile
#### Create the XDG desktop profile
1. Rename your ${HOME}/.config to start with no user-specific configurations.
2. Start VNC with the default profile:
```shell
export XDG_PROFILE=default
vncserver -fg -geometry 1920x1080
```
3. Make your changes (background, icons, menu entries)
4. logout
#### Store the XDG desktop profile
1. Copy *${HOME}/.config/xdg_profiles/default* to *etc/xdg/xdg_profiles/<new-profile-name/*
2. Replace absolute paths pointing to locations inside your ${HOME} (use setup.sh).
2. Add your profile to *usr/local/bin/xdg_profile.sh*
3. Copy .desktop-files generated in ${HOME}/Desktop to *usr/local/share/applications/*
1. Absolute paths are present in the configuration files of this repository. They have to be changed before use:
- **call ./setup.sh to change the paths**
2. copy or link dot.vnc/xstartup to your ~/.vnc directory